diff --git a/book/en/code/AddressBook.md b/book/en/code/AddressBook.md index bcab9ee..fcef18e 100644 --- a/book/en/code/AddressBook.md +++ b/book/en/code/AddressBook.md @@ -1,29 +1,29 @@ -## AddressBook ℗ +## ~~AddressBook ℗~~ -AddressBook facility +***Deprecated*** **Category**: AddressBook **Access**: private -**See**: [https://route4me.io/docs/#address-book](https://route4me.io/docs/#address-book) +**See**: [AddressBookV5](AddressBookV5.html) + +AddressBook facility **Since**: 0.1.8 -* [AddressBook](#AddressBook) ℗ +* ~~[AddressBook](#AddressBook) ℗~~ * [new AddressBook(requestManager)](#new_AddressBook_new) - * [.create(data, [callback])](#AddressBook+create) - * [.getMany(ids, [callback])](#AddressBook+getMany) - * [.list(ids, [options], [callback])](#AddressBook+list) - * [.search(query, [options], [callback])](#AddressBook+search) - * [.update(id, data, [callback])](#AddressBook+update) - * [.remove(ids, [callback])](#AddressBook+remove) + * ~~[.create(data, [callback])](#AddressBook+create)~~ + * ~~[.getMany(ids, [callback])](#AddressBook+getMany)~~ + * ~~[.list(ids, [options], [callback])](#AddressBook+list)~~ + * ~~[.search(query, [options], [callback])](#AddressBook+search)~~ + * ~~[.update(id, data, [callback])](#AddressBook+update)~~ + * ~~[.remove(ids, [callback])](#AddressBook+remove)~~ ### new AddressBook(requestManager) -Constructor - **Returns**: [AddressBook](#AddressBook) - - AddressBook facility | Param | Type | Description | @@ -32,11 +32,17 @@ Constructor -### addressBook.create(data, [callback]) +### ~~addressBook.create(data, [callback])~~ + +***Deprecated*** + +**See** + +- [AddressBookV5.addAddress](AddressBookV5.html#AddressBookV5+addAddress) Create a new AddressBook. +- [https://route4me.io/docs/#create-a-location](https://route4me.io/docs/#create-a-location) -**See**: [https://route4me.io/docs/#create-a-location](https://route4me.io/docs/#create-a-location) **Since**: 0.1.8 | Param | Type | Description | @@ -46,11 +52,17 @@ Create a new AddressBook. -### addressBook.getMany(ids, [callback]) +### ~~addressBook.getMany(ids, [callback])~~ + +***Deprecated*** + +**See** + +- [AddressBookV5.getAddresses](AddressBookV5.html#AddressBookV5+getAddresses) GET locations from an address book by a specified list of locations IDs. +- [https://route4me.io/docs/#get-locations-by-ids](https://route4me.io/docs/#get-locations-by-ids) -**See**: [https://route4me.io/docs/#get-locations-by-ids](https://route4me.io/docs/#get-locations-by-ids) **Since**: 0.1.8 **Todo** @@ -65,11 +77,17 @@ GET locations from an address book by a specified list of locations IDs. -### addressBook.list(ids, [options], [callback]) +### ~~addressBook.list(ids, [options], [callback])~~ + +***Deprecated*** + +**See** + +- [AddressBookV5.getAddressesPaginated](AddressBookV5.html#AddressBookV5+getAddressesPaginated) GET all locations from a user’s address book. +- [https://route4me.io/docs/#get-locations](https://route4me.io/docs/#get-locations) -**See**: [https://route4me.io/docs/#get-locations](https://route4me.io/docs/#get-locations) **Since**: 0.1.8 **Todo** @@ -88,13 +106,16 @@ GET all locations from a user’s address book. -### addressBook.search(query, [options], [callback]) +### ~~addressBook.search(query, [options], [callback])~~ -Search an address book location by containing specified text in any -field/defined fields. +***Deprecated*** **See** +- [AddressBookV5.getAddresses](AddressBookV5.html#AddressBookV5+getAddresses) + +Search an address book location by containing specified text in any +field/defined fields. - [https://route4me.io/docs/#get-a-location](https://route4me.io/docs/#get-a-location) - [https://route4me.io/docs/#location-search](https://route4me.io/docs/#location-search) @@ -118,11 +139,17 @@ see https://github.com/route4me/route4me-nodejs-sdk/issues/38) -### addressBook.update(id, data, [callback]) +### ~~addressBook.update(id, data, [callback])~~ + +***Deprecated*** + +**See** + +- [AddressBookV5.updateAddressesByIds](AddressBookV5.html#AddressBookV5+updateAddressesByIds) UPDATE existing address book location parameters. +- [https://route4me.io/docs/#update-a-location](https://route4me.io/docs/#update-a-location) -**See**: [https://route4me.io/docs/#update-a-location](https://route4me.io/docs/#update-a-location) **Since**: 0.1.8 | Param | Type | Description | @@ -133,11 +160,17 @@ UPDATE existing address book location parameters. -### addressBook.remove(ids, [callback]) +### ~~addressBook.remove(ids, [callback])~~ + +***Deprecated*** + +**See** + +- [AddressBookV5.deleteAddressesByIds](AddressBookV5.html#AddressBookV5+deleteAddressesByIds) REMOVE locations from an address book. +- [https://route4me.io/docs/#remove-locations](https://route4me.io/docs/#remove-locations) -**See**: [https://route4me.io/docs/#remove-locations](https://route4me.io/docs/#remove-locations) **Since**: 0.1.8 **Todo** diff --git a/package.json b/package.json index d50ed0a..f1ce1b7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "route4me-nodejs-sdk", - "version": "1.0.24", + "version": "1.0.25", "description": "Access Route4Me's logistics-as-a-service API using our Node.js SDK", "main": "src/index.js", "browser": "src/route4me.js", diff --git a/src/resources/address-book.js b/src/resources/address-book.js index c00990e..b5cce17 100644 --- a/src/resources/address-book.js +++ b/src/resources/address-book.js @@ -3,12 +3,18 @@ const utils = require("./../utils") /** + * @deprecated since version 1.0.25 + * @see {@link AddressBookV5.html AddressBookV5} + * * AddressBook facility * * @category AddressBook */ class AddressBook { /** + * @deprecated since version 1.0.25 + * @see {@link AddressBookV5.html#new_AddressBookV5_new AddressBookV5} + * * Constructor * * @see {@link https://route4me.io/docs/#address-book} @@ -23,6 +29,9 @@ class AddressBook { } /** + * @deprecated since version 1.0.25 + * @see {@link AddressBookV5.html#AddressBookV5+addAddress AddressBookV5.addAddress} + * * Create a new AddressBook. * * @see {@link https://route4me.io/docs/#create-a-location} @@ -42,6 +51,9 @@ class AddressBook { } /** + * @deprecated since version 1.0.25 + * @see {@link AddressBookV5.html#AddressBookV5+getAddresses AddressBookV5.getAddresses} + * * GET locations from an address book by a specified list of locations IDs. * * @see {@link https://route4me.io/docs/#get-locations-by-ids} @@ -69,6 +81,10 @@ class AddressBook { } /** + * @deprecated since version 1.0.25 + * @see {@link AddressBookV5.html#AddressBookV5+getAddressesPaginated + * AddressBookV5.getAddressesPaginated} + * * GET all locations from a user’s address book. * * @see {@link https://route4me.io/docs/#get-locations} @@ -104,6 +120,9 @@ class AddressBook { } /** + * @deprecated since version 1.0.25 + * @see {@link AddressBookV5.html#AddressBookV5+getAddresses AddressBookV5.getAddresses} + * * Search an address book location by containing specified text in any * field/defined fields. * @@ -167,6 +186,9 @@ class AddressBook { } /** + * @deprecated since version 1.0.25 + * @see {@link AddressBookV5.html#AddressBookV5+updateAddressById AddressBookV5.updateAddressById} + * * UPDATE existing address book location parameters. * * @see {@link https://route4me.io/docs/#update-a-location} @@ -190,6 +212,10 @@ class AddressBook { } /** + * @deprecated since version 1.0.25 + * @see {@link AddressBookV5.html#AddressBookV5+deleteAddressesByIds + * AddressBookV5.deleteAddressesByIds} + * * REMOVE locations from an address book. * * @see {@link https://route4me.io/docs/#remove-locations} diff --git a/src/resources/routes.js b/src/resources/routes.js index 97a1f7c..b40affd 100644 --- a/src/resources/routes.js +++ b/src/resources/routes.js @@ -775,7 +775,7 @@ class Routes { * @param {string} id - Route ID * @param {module:route4me-node~RequestCallback} [callback] */ - reoptimization(id, callback) { + reoptimization(id, callback) { const qs = { "route_id": id, "reoptimize": true @@ -798,7 +798,7 @@ class Routes { * @param {string} id - Route ID * @param {module:route4me-node~RequestCallback} [callback] */ - reoptimizationRemainigStop(id, callback) { + reoptimizationRemainigStop(id, callback) { const qs = { "route_id": id, "reoptimize": true,