Skip to content

Commit b23a544

Browse files
r4m-juanr4m-juan
authored
Merge pull request #76 from route4me/1.0.12
1.0.12
2 parents 9f8d1ab + d857a73 commit b23a544

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+5081
-304
lines changed

‎.eslintrc.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
exports = module.exports = {
22
"extends": [
3-
"airbnb"
3+
"airbnb-base"
44
],
55
"plugins": [
66
// TODO: this is LINT rules for DOC. `Use with npm install eslint-plugin-jsdoc`

‎book/en/SUMMARY.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313

1414
## Code
1515

16+
### V4
17+
1618
* [Route4Me](code/Route4Me.md#Route4Me)
1719
* [ActivityFeed](code/ActivityFeed.md)
1820
* [AddressBarcodes](code/AddressBarcodes.md)
@@ -34,6 +36,10 @@
3436
* [Route4MeValidationError](code/Errors.md#Route4MeValidationError)
3537
* [Other](code/Uncategorized.md)
3638

39+
### V5
40+
41+
* [AddressBookV5](code/AddressBookV5.md)
42+
3743
{% include "code/index.md" %}
3844

3945
## Examples

‎book/en/code/AddressBook.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ AddressBook facility
1313
* [new AddressBook(requestManager)](#new_AddressBook_new)
1414
* [.create(data, [callback])](#AddressBook+create)
1515
* [.getMany(ids, [callback])](#AddressBook+getMany)
16-
* [.list(options, [callback])](#AddressBook+list)
17-
* [.search(query, options, [callback])](#AddressBook+search)
16+
* [.list(ids, [options], [callback])](#AddressBook+list)
17+
* [.search(query, [options], [callback])](#AddressBook+search)
1818
* [.update(id, data, [callback])](#AddressBook+update)
1919
* [.remove(ids, [callback])](#AddressBook+remove)
2020

@@ -65,7 +65,7 @@ GET locations from an address book by a specified list of locations IDs.
6565

6666
<a id="AddressBook+list" name="AddressBook+list"></a>
6767

68-
### addressBook.list(options, [callback])
68+
### addressBook.list(ids, [options], [callback])
6969

7070
GET all locations from a user’s address book.
7171

@@ -74,18 +74,21 @@ GET all locations from a user’s address book.
7474
**Todo**
7575

7676
- [ ] TODO: Parse response
77-
- [ ] TODO: Describe ALL options (in one place, list+search)
78-
- [ ] TODO: convert options to optional
7977

8078

8179
| Param | Type | Description |
8280
| --- | --- | --- |
83-
| options | <code>Object</code> | List-parameters |
81+
| ids | <code>String</code> \| <code>Number</code> \| <code>Array.&lt;String&gt;</code> \| <code>Array.&lt;Number&gt;</code> | Order IDs |
82+
| [options] | <code>Object</code> | List-parameters |
83+
| [options.offset] | <code>Number</code> | List offset |
84+
| [options.limit] | <code>Number</code> | List limit |
85+
| [options.fields] | <code>String</code> | String of comma separated fields to return |
86+
| [options.routed] | <code>Boolean</code> | Return routed or unrouted records |
8487
| [callback] | <code>module:route4me-node~RequestCallback.&lt;jsonschema:AddressBook.AddressBookSearchResult&gt;</code> | |
8588

8689
<a id="AddressBook+search" name="AddressBook+search"></a>
8790

88-
### addressBook.search(query, options, [callback])
91+
### addressBook.search(query, [options], [callback])
8992

9093
Search an address book location by containing specified text in any
9194
field/defined fields.
@@ -98,19 +101,19 @@ field/defined fields.
98101
**Since**: 0.1.8
99102
**Todo**
100103

101-
- [ ] TODO: convert options to optional
102104
- [ ] TODO: Parse response
103-
- [ ] TODO: Describe ALL options (in one place, list+search)
104105
- [ ] TODO: Handle the diffrerent format of the output (when fields are set,
105106
see https://github.com/route4me/route4me-nodejs-sdk/issues/38)
106107

107108

108109
| Param | Type | Description |
109110
| --- | --- | --- |
110111
| query | <code>string</code> | Searched text |
111-
| options | <code>Object</code> | List-parameters |
112-
| [options.limit] | <code>number</code> | List limit |
113-
| [options.offset] | <code>number</code> | List offset |
112+
| [options] | <code>Object</code> | List-parameters |
113+
| [options.offset] | <code>Number</code> | List offset |
114+
| [options.limit] | <code>Number</code> | List limit |
115+
| [options.fields] | <code>String</code> | String of comma separated fields to return |
116+
| [options.routed] | <code>Boolean</code> | Return routed or unrouted records |
114117
| [callback] | <code>module:route4me-node~RequestCallback.&lt;jsonschema:AddressBook.AddressBookSearchResult&gt;</code> | |
115118

116119
<a id="AddressBook+update" name="AddressBook+update"></a>

‎book/en/code/AddressBookV5.md

Lines changed: 594 additions & 0 deletions
Large diffs are not rendered by default.

‎book/en/code/Route4Me.md

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ Main members of the instanse of `Route4Me` class:
8787
* [ActivityFeed ](ActivityFeed)
8888
* [Addresses ](Addresses)
8989
* [AddressBook ](AddressBook)
90+
* [AddressBookV5 ](AddressBookV5)
9091
* [AddressBarcodes ](AddressBarcodes)
9192
* [AvoidanceZones ](AvoidanceZones)
9293
* [Geocoding ](Geocoding)
@@ -125,6 +126,7 @@ For most use cases it is necessary:
125126
* _instance_
126127
* [.ActivityFeed](#Route4Me+ActivityFeed) : <code>ActivityFeed</code>
127128
* [.AddressBook](#Route4Me+AddressBook) : <code>AddressBook</code>
129+
* [.AddressBookV5](#Route4Me+AddressBookV5) : <code>AddressBookV5</code>
128130
* [.AddressBarcodes](#Route4Me+AddressBarcodes) : <code>AddressBarcodes</code>
129131
* [.Addresses](#Route4Me+Addresses) : <code>Addresses</code>
130132
* [.AvoidanceZones](#Route4Me+AvoidanceZones) : <code>AvoidanceZones</code>
@@ -137,6 +139,8 @@ For most use cases it is necessary:
137139
* [.Tracking](#Route4Me+Tracking) : <code>Tracking</code>
138140
* [.Vehicles](#Route4Me+Vehicles) : <code>Vehicles</code>
139141
* [.version](#Route4Me+version) ⇒ <code>string</code>
142+
* [.baseUrl()](#Route4Me+baseUrl) ⇒ <code>string</code>
143+
* [.baseUrl5()](#Route4Me+baseUrl5) ⇒ <code>string</code>
140144
* _static_
141145
* [.version](#Route4Me.version) ⇒ <code>string</code>
142146

@@ -152,7 +156,8 @@ Create new API client
152156
| --- | --- | --- | --- |
153157
| apiKey | <code>string</code> | | API KEY |
154158
| [options] | <code>object</code> | | Additional options for new instance |
155-
| [options.baseUrl] | <code>string</code> | <code>&quot;\&quot;https://api.route4me.com\&quot;&quot;</code> | Base URL for sending requests |
159+
| [options.baseUrl] | <code>string</code> | <code>&quot;https://api.route4me.com&quot;</code> | Base URL for sending requests |
160+
| [options.baseUrl5] | <code>string</code> | <code>&quot;https://wh.route4me.com/modules&quot;</code> | Base URL for sending requests to backend API v.5 |
156161
| [options.logger] | [<code>ILogger</code>](#ILogger) | <code></code> | Logger facility |
157162
| [options.promise] | <code>boolean</code> \| <code>function</code> | <code>false</code> | Use promises instead of callbacks. Usage: * `false` means _no promises, use callbacks_; * `true` means _use global `Promise`_ as promises' constructor; * `constructor (function)` forces to use explicit Promise library. See also Examples section of this documentation. |
158163
| [options.validate] | <code>module:route4me-node~ValidationCallback</code> | <code>false</code> | Validator for input and output parameters of the API methods. Set **falsey** value to skip autovalidation (in favor of manual check). |
@@ -170,6 +175,13 @@ Create new API client
170175

171176
**AddressBook** related API calls
172177

178+
**Since**: 0.1.8
179+
<a id="Route4Me+AddressBookV5" name="Route4Me+AddressBookV5"></a>
180+
181+
### route4Me.AddressBookV5 : <code>AddressBookV5</code>
182+
183+
**AddressBookV5** related API calls
184+
173185
**Since**: 0.1.8
174186
<a id="Route4Me+AddressBarcodes" name="Route4Me+AddressBarcodes"></a>
175187

@@ -252,6 +264,24 @@ Version of this API client
252264
**Returns**: <code>string</code> - Version
253265
**Read only**: true
254266
**Since**: 0.2.0
267+
<a id="Route4Me+baseUrl" name="Route4Me+baseUrl"></a>
268+
269+
### route4Me.baseUrl() ⇒ <code>string</code>
270+
271+
Base URL for sending requests
272+
273+
**Returns**: <code>string</code> - URL
274+
**Read only**: true
275+
**Since**: 1.0.9
276+
<a id="Route4Me+baseUrl5" name="Route4Me+baseUrl5"></a>
277+
278+
### route4Me.baseUrl5() ⇒ <code>string</code>
279+
280+
Base URL for sending requests to backend API v.5
281+
282+
**Returns**: <code>string</code> - URL
283+
**Read only**: true
284+
**Since**: 1.0.9
255285
<a id="Route4Me.version" name="Route4Me.version"></a>
256286

257287
### Route4Me.version ⇒ <code>string</code>
@@ -289,9 +319,15 @@ Enum for all known **activity type**.
289319
| MarkDestinationVisited | <code>string</code> | <code>&quot;mark-destination-visited&quot;</code> | |
290320
| MoveDestination | <code>string</code> | <code>&quot;move-destination&quot;</code> | |
291321
| UpdateDestinations | <code>string</code> | <code>&quot;update-destinations&quot;</code> | |
292-
| DriverArrivedEarly | <code>string</code> | <code>&quot;driver-arrived-early&quot;</code> | Get driver arrived early activities [https://route4me.io/docs/#driver-arrived-early](https://route4me.io/docs/#driver-arrived-early) |
322+
| AddressbookInsert | <code>string</code> | <code>&quot;addressbook-insert&quot;</code> | Get driver arrived early activities [https://route4me.io/docs/#driver-arrived-early](https://route4me.io/docs/#driver-arrived-early) |
323+
| AddressbookUpdate | <code>string</code> | <code>&quot;addressbook-update&quot;</code> | |
324+
| AddressbookDelete | <code>string</code> | <code>&quot;addressbook-delete&quot;</code> | |
325+
| DriverArrivedEarly | <code>string</code> | <code>&quot;driver-arrived-early&quot;</code> | |
293326
| DriverArrivedLate | <code>string</code> | <code>&quot;driver-arrived-late&quot;</code> | |
327+
| DriverArrivedInTime | <code>string</code> | <code>&quot;driver-arrived-in-time&quot;</code> | |
294328
| DriverArrivedOnTime | <code>string</code> | <code>&quot;driver-arrived-on-time&quot;</code> | |
329+
| LocalGeofenceEntered | <code>string</code> | <code>&quot;local_geofence_entered&quot;</code> | |
330+
| LocalGeofenceLeft | <code>string</code> | <code>&quot;local_geofence_left&quot;</code> | |
295331
| MemberCreated | <code>string</code> | <code>&quot;member-created&quot;</code> | |
296332
| MemberDeleted | <code>string</code> | <code>&quot;member-deleted&quot;</code> | |
297333
| MemberModified | <code>string</code> | <code>&quot;member-modified&quot;</code> | |
@@ -304,5 +340,10 @@ Enum for all known **activity type**.
304340
| OrderUpdated | <code>string</code> | <code>&quot;order-updated&quot;</code> | |
305341
| OrderDeleted | <code>string</code> | <code>&quot;order-deleted&quot;</code> | |
306342
| UnapprovedToExecute | <code>string</code> | <code>&quot;unapproved-to-execute&quot;</code> | |
343+
| PickupBarcodeScanning | <code>string</code> | <code>&quot;pickup_barcode_scanning&quot;</code> | |
344+
| RouteCompleted | <code>string</code> | <code>&quot;route-completed&quot;</code> | |
345+
| RouteDestinationStatus | <code>string</code> | <code>&quot;route-destination-status&quot;</code> | |
346+
| RoutePaused | <code>string</code> | <code>&quot;route-paused&quot;</code> | |
347+
| RouteStarted | <code>string</code> | <code>&quot;route-started&quot;</code> | |
307348
| RouteUpdate | <code>string</code> | <code>&quot;route-update&quot;</code> | |
308349

‎book/en/code/Routes.md

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,13 @@ Routes facility
2626
* [.optimize(id, criteria, [callback])](#Routes+optimize)
2727
* [.routeexamples_optiomization(param, [callback])](#Routes+routeexamples_optiomization)
2828
* [.get_schedule_calendar(param, [callback])](#Routes+get_schedule_calendar)
29+
* [.routeBreaks(options, [callback])](#Routes+routeBreaks)
30+
* [.getStatus(routeId, [callback])](#Routes+getStatus)
31+
* [.rollbackStatus(routeId, [callback])](#Routes+rollbackStatus)
32+
* [.getHistoryStatus(routeId, [options], [callback])](#Routes+getHistoryStatus)
33+
* [.updateStatus(routeId, params, [callback])](#Routes+updateStatus)
34+
* [.setPlannedStatus(routeIds, [callback])](#Routes+setPlannedStatus)
35+
* [.routeStopStatus(destinationIds, status, [callback])](#Routes+routeStopStatus)
2936

3037
<a id="new_Routes_new" name="new_Routes_new"></a>
3138

@@ -304,3 +311,120 @@ Get Schedule Calendar
304311
| param | <code>object</code> | Schedule params |
305312
| [callback] | <code>module:route4me-node~RequestCallback</code> | |
306313
314+
<a id="Routes+routeBreaks" name="Routes+routeBreaks"></a>
315+
316+
### routes.routeBreaks(options, [callback])
317+
318+
Store a new Driver Break in the database.
319+
320+
**See**: [https://virtserver.swaggerhub.com/Route4Me/route-breaks/5.0](https://virtserver.swaggerhub.com/Route4Me/route-breaks/5.0)
321+
**Since**: 1.0.12
322+
323+
| Param | Type | Description |
324+
| --- | --- | --- |
325+
| options | <code>object</code> | Routebreaks params |
326+
| options.route_id | <code>Array.&lt;string&gt;</code> | Route IDs to get result. |
327+
| options.breaks | <code>Array.&lt;object&gt;</code> | Break IDs. |
328+
| options.breaks.type | <code>string</code> | Type of break. Possible values: - approximate_time_of_day - certain_number_of_total_elapsed_time - certain_number_of_travel_time - certain_number_of_service_time - certain_number_of_locations |
329+
| options.breaks.duration | <code>number</code> | Duration of break. |
330+
| options.breaks.params | <code>Array.&lt;number&gt;</code> | Params break. |
331+
| options.replace_existing_breaks | <code>boolean</code> | Replace existing breaks. |
332+
| [callback] | <code>module:route4me-node~RequestCallback</code> | |
333+
334+
<a id="Routes+getStatus" name="Routes+getStatus"></a>
335+
336+
### routes.getStatus(routeId, [callback])
337+
338+
Get the status by specifying the path parameter ID.
339+
340+
**See**: [https://virtserver.swaggerhub.com/Route4Me/route-status/5.0](https://virtserver.swaggerhub.com/Route4Me/route-status/5.0)
341+
**Since**: 1.0.12
342+
343+
| Param | Type | Description |
344+
| --- | --- | --- |
345+
| routeId | <code>string</code> | Route ID to get status. |
346+
| [callback] | <code>module:route4me-node~RequestCallback</code> | |
347+
348+
<a id="Routes+rollbackStatus" name="Routes+rollbackStatus"></a>
349+
350+
### routes.rollbackStatus(routeId, [callback])
351+
352+
Roll back route status by specifying the path parameter ID.
353+
Sometimes a status rollback is possible.
354+
355+
**See**: [https://virtserver.swaggerhub.com/Route4Me/route-status/5.0](https://virtserver.swaggerhub.com/Route4Me/route-status/5.0)
356+
**Since**: 1.0.12
357+
358+
| Param | Type | Description |
359+
| --- | --- | --- |
360+
| routeId | <code>string</code> | Route ID to rollback status. |
361+
| [callback] | <code>module:route4me-node~RequestCallback</code> | |
362+
363+
<a id="Routes+getHistoryStatus" name="Routes+getHistoryStatus"></a>
364+
365+
### routes.getHistoryStatus(routeId, [options], [callback])
366+
367+
Get route status history by specifying the path parameter ID.
368+
369+
**See**: [https://virtserver.swaggerhub.com/Route4Me/route-status/5.0](https://virtserver.swaggerhub.com/Route4Me/route-status/5.0)
370+
**Since**: 1.0.12
371+
372+
| Param | Type | Description |
373+
| --- | --- | --- |
374+
| routeId | <code>string</code> | Route ID to get history status. |
375+
| [options] | <code>object</code> | |
376+
| [options.order_by] | <code>string</code> | Result order. Possible values: 'asc' and 'desc' |
377+
| [options.start] | <code>number</code> | Unix timestamp in seconds. |
378+
| [options.end] | <code>number</code> | Unix timestamp in seconds. |
379+
| [callback] | <code>module:route4me-node~RequestCallback</code> | |
380+
381+
<a id="Routes+updateStatus" name="Routes+updateStatus"></a>
382+
383+
### routes.updateStatus(routeId, params, [callback])
384+
385+
Store a new Status in the database or update the status by specifying
386+
the path parameter ID.
387+
Route statuses change only forward - planned > started/paused > completed.
388+
389+
**See**: [https://virtserver.swaggerhub.com/Route4Me/route-breaks/5.0](https://virtserver.swaggerhub.com/Route4Me/route-breaks/5.0)
390+
**Since**: 1.0.12
391+
392+
| Param | Type | Description |
393+
| --- | --- | --- |
394+
| routeId | <code>string</code> | Route ID to update status. |
395+
| params | <code>object</code> | |
396+
| params.status | <code>string</code> | Value of status. Possible values: 'planned', 'started', 'paused' and 'completed'. |
397+
| params.lat | <code>number</code> | Latitude. |
398+
| params.lng | <code>number</code> | Longitude. |
399+
| params.event_timestamp | <code>number</code> | Unix timestamp in seconds.. |
400+
| [callback] | <code>module:route4me-node~RequestCallback</code> | |
401+
402+
<a id="Routes+setPlannedStatus" name="Routes+setPlannedStatus"></a>
403+
404+
### routes.setPlannedStatus(routeIds, [callback])
405+
406+
Store a new Status in the database with 'planned' status.
407+
408+
**See**: [https://virtserver.swaggerhub.com/Route4Me/route-breaks/5.0](https://virtserver.swaggerhub.com/Route4Me/route-breaks/5.0)
409+
**Since**: 1.0.12
410+
411+
| Param | Type | Description |
412+
| --- | --- | --- |
413+
| routeIds | <code>Array.&lt;string&gt;</code> | Route IDs to set 'planned' status. |
414+
| [callback] | <code>module:route4me-node~RequestCallback</code> | |
415+
416+
<a id="Routes+routeStopStatus" name="Routes+routeStopStatus"></a>
417+
418+
### routes.routeStopStatus(destinationIds, status, [callback])
419+
420+
Insert or update route address status/statuses.
421+
422+
**See**: [https://virtserver.swaggerhub.com/Route4Me/route-breaks/5.0](https://virtserver.swaggerhub.com/Route4Me/route-breaks/5.0)
423+
**Since**: 1.0.12
424+
425+
| Param | Type | Description |
426+
| --- | --- | --- |
427+
| destinationIds | <code>Array.&lt;number&gt;</code> | Array of destination IDs to set status. |
428+
| status | <code>string</code> | Value od status to set. Possible values: 'Skipped', 'Completed', 'Failed' and 'Empty'. |
429+
| [callback] | <code>module:route4me-node~RequestCallback</code> | |
430+

‎book/en/code/Uncategorized.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,10 @@ Uses base url route4me API v4.0
110110
| [options.qs] | <code>object</code> | | Query string |
111111
| [options.body] | <code>object</code> | | Body |
112112
| [options.validationContext] | <code>null</code> \| <code>string</code> \| <code>function</code> | <code></code> | * `null` cause validation disabled (TODO: test this case) * `string` is threated as the name of JSON Schema * `function` will be used for validation. |
113+
| [options.returns] | <code>object</code> | | Return values if present the return will be object with next structure { status, // e.g. 200, 201, 202, etc ... // other fields, e.g. 'jobId' res // result of request } |
114+
| [options.returns.status] | <code>boolean</code> | | Return status |
115+
| [options.returns.jobId] | <code>boolean</code> | | Return headers.x-job-id |
116+
| [options.returns.location] | <code>boolean</code> | | Return headers.location |
113117
| [callback] | [<code>RequestCallback</code>](#module_route4me-node..RequestCallback) | | |
114118

115119
<a id="RequestManager+_makeRequest5" name="RequestManager+_makeRequest5"></a>
@@ -133,6 +137,10 @@ Uses base url route4me API v5.0
133137
| [options.qs] | <code>object</code> | | Query string |
134138
| [options.body] | <code>object</code> | | Body |
135139
| [options.validationContext] | <code>null</code> \| <code>string</code> \| <code>function</code> | <code></code> | * `null` cause validation disabled (TODO: test this case) * `string` is threated as the name of JSON Schema * `function` will be used for validation. |
140+
| [options.returns] | <code>object</code> | | Return values if present the return will be object with next structure { status, // e.g. 200, 201, 202, etc ... // other fields, e.g. 'jobId' res // result of request } |
141+
| [options.returns.status] | <code>boolean</code> | | Return status |
142+
| [options.returns.jobId] | <code>boolean</code> | | Return headers.x-job-id |
143+
| [options.returns.location] | <code>boolean</code> | | Return headers.location |
136144
| [callback] | [<code>RequestCallback</code>](#module_route4me-node..RequestCallback) | | |
137145

138146
<a id="RequestManager+_makeError" name="RequestManager+_makeError"></a>

0 commit comments

Comments
 (0)