Optimization profiles

book/en/SUMMARY.md

@@ -40,8 +40,9 @@
 
  * [AddressBookV5](code/AddressBookV5.md)
  * [AutomaticTerritories](code/AutomaticTerritories.md)
- * [Schedules](code/Schedules.md)
+ * [OptimizationProfiles](code/OptimizationProfiles.md)
  * [PodWorkflow](code/PodWorkflow.md)
+ * [Schedules](code/Schedules.md)
  * [TeamManagement](code/TeamManagement.md)
  * [VehiclesV5](code/VehiclesV5.md)
 

book/en/code/OptimizationProfiles.md

@@ -0,0 +1,75 @@
+<a id="OptimizationProfiles" name="OptimizationProfiles"></a>
+
+## OptimizationProfiles ℗
+
+Optimization profiles
+
+**Category**: OptimizationProfiles 
+**Access**: private 
+**See**: [https://route4me.io/docs/#create-an-optimization](https://route4me.io/docs/#create-an-optimization) 
+**Since**: 1.2.0 
+
+* [OptimizationProfiles](#OptimizationProfiles) ℗
+ * [new OptimizationProfiles(requestManager)](#new_OptimizationProfiles_new)
+ * [.list([callback])](#OptimizationProfiles+list)
+ * [.save(data, [callback])](#OptimizationProfiles+save)
+ * [.remove(data, [callback])](#OptimizationProfiles+remove)
+
+<a id="new_OptimizationProfiles_new" name="new_OptimizationProfiles_new"></a>
+
+### new OptimizationProfiles(requestManager)
+
+Constructor
+
+**Returns**: [<code>OptimizationProfiles</code>](#OptimizationProfiles) - - OptimizationProfiles facility 
+
+| Param | Type | Description |
+| --- | --- | --- |
+| requestManager | <code>RequestManager</code> | Request Manager |
+
+<a id="OptimizationProfiles+list" name="OptimizationProfiles+list"></a>
+
+### optimizationProfiles.list([callback])
+
+Get list of optimization profiles belong to the Route4Me account
+
+**Since**: 1.2.0 
+
+| Param | Type |
+| --- | --- |
+| [callback] | <code>OptimizationProfiles.ResponseMany</code> | 
+
+<a id="OptimizationProfiles+save" name="OptimizationProfiles+save"></a>
+
+### optimizationProfiles.save(data, [callback])
+
+Save a OptimizationProfiles.
+
+**Since**: 1.2.0 
+
+| Param | Type | Description |
+| --- | --- | --- |
+| data | <code>object</code> | valid save data |
+| data.items | <code>Array.&lt;object&gt;</code> | array of objects to save |
+| data.items.guid | <code>string</code> | GUID |
+| data.items.id | <code>string</code> | ID |
+| data.items.parts | <code>Array.&lt;object&gt;</code> | aray of parts |
+| data.items.parts.guid | <code>string</code> | GUID |
+| data.items.parts.data | <code>object</code> | data |
+| [callback] | <code>OptimizationProfiles.ResponseSave</code> | |
+
+<a id="OptimizationProfiles+remove" name="OptimizationProfiles+remove"></a>
+
+### optimizationProfiles.remove(data, [callback])
+
+Remove a OptimizationProfiles.
+
+**Since**: 1.2.0 
+
+| Param | Type | Description |
+| --- | --- | --- |
+| data | <code>object</code> | valid remove data |
+| data.items | <code>Array.&lt;object&gt;</code> | array of objects to remove |
+| data.items.id | <code>string</code> | ID |
+| [callback] | <code>OptimizationProfiles.ResponseRemove</code> | |
+

book/en/code/Optimizations.md

@@ -98,6 +98,7 @@ Create a new optimization with Advanced constraints
 | [props.parameters.advanced_constraints.location_sequence_pattern.time] | <code>number</code> | | Location service time |
 | [props.parameters.advanced_constraints.group] | <code>string</code> | | Group name of the advanced constraints. |
 | [props.depots] | <code>Array.&lt;object&gt;</code> | | A valid array of Address objects of Depots. |
+| [props.optimization_profile_id] | <code>object</code> | | A valid ID of optimization profile. |
 | props.addresses | <code>Array.&lt;object&gt;</code> | | A valid array of Address objects. Here are some required and useful properties of the Address object, for full list of properties look at docs. |
 | props.addresses.lat | <code>number</code> | | Latitude. |
 | props.addresses.lng | <code>number</code> | | Longitude. |

book/en/code/Route4Me.md

@@ -95,6 +95,7 @@ Main members of the instanse of `Route4Me` class:
 * [Members ](Members)
 * [Notes ](Notes)
 * [Optimizations ](Optimizations)
+* [OptimizationProfiles](OptimizationProfiles)
 * [Orders ](Orders)
 * [OrderCustomFields ](OrderCustomFields)
 * [PodWorkflow ](PodWorkflow)
@@ -139,6 +140,7 @@ For most use cases it is necessary:
  * [.Geocoding](#Route4Me+Geocoding) : <code>Geocoding</code>
  * [.Notes](#Route4Me+Notes) : <code>Notes</code>
  * [.Optimizations](#Route4Me+Optimizations) : <code>Optimizations</code>
+ * [.OptimizationProfiles](#Route4Me+OptimizationProfiles) : <code>OptimizationProfiles</code>
  * [.Orders](#Route4Me+Orders) : <code>Orders</code>
  * [.PodWorkflow](#Route4Me+PodWorkflow) : <code>PodWorkflow</code>
  * [.Routes](#Route4Me+Routes) : <code>Routes</code>
@@ -241,6 +243,13 @@ Create new API client
 
 **Optimizations** related API calls
 
+<a id="Route4Me+OptimizationProfiles" name="Route4Me+OptimizationProfiles"></a>
+
+### route4Me.OptimizationProfiles : <code>OptimizationProfiles</code>
+
+**OptimizationProfiles** related API calls
+
+**Since**: 1.2.0 
 <a id="Route4Me+Orders" name="Route4Me+Orders"></a>
 
 ### route4Me.Orders : <code>Orders</code>

examples/OptimizationProfiles/save-data-promise.js

@@ -0,0 +1,57 @@
+"use strict"
+
+const path = require("path")
+const chai = require("chai")
+const debug = require("debug")("route4me-node:examples")
+require("../init-examples-suite")
+const helper = require("../../test/helper")
+
+helper.describeIntegration(helper.toSuiteName(__filename), function T() {
+ this.timeout(5000)
+ this.slow(3000)
+ it(path.basename(__filename), (done) => {
+ const expect = chai.expect
+ const apiKey = "11111111111111111111111111111111"
+
+ // To use the Promise style instead of the Callback style send promise=true as an option.
+ const route4me = new Route4Me(apiKey, { promise: true })
+
+ // get default optimization profile id
+ route4me.OptimizationProfiles.list()
+ .then(data => {
+ expect(data).exist
+
+ const default_profile = data.items.find((item) => item.is_default);
+ if(default_profile) {
+
+ // save data
+ const data = {
+ items: [{
+ guid: "eaa",
+ parts: [{
+ guid: "pav",
+ data: { "append_date_to_route_name": true }
+ }],
+ id: default_profile.optimization_profile_id
+ }]
+ };
+ route4me.OptimizationProfiles.save(data)
+ .then(data => {
+ expect(data).exist
+
+ console.log(`Data for optimization_profile_id: '${default_profile.optimization_profile_id}' was saved successful.`);
+ }).catch(err => {
+ console.log("Error: save, " + err);
+ });
+ } else {
+ console.log("Cannot find the default optimization profile id.");
+ }
+ }).catch(err => {
+ expect(err).exist
+ // console.log("Error: list, " + err);
+ });
+
+ // TODO: remove `done` call from examples
+ done()
+ })
+})

examples/OptimizationProfiles/save-data-sync.js

@@ -0,0 +1,56 @@
+"use strict"
+
+const path = require("path")
+const chai = require("chai")
+const debug = require("debug")("route4me-node:examples")
+require("../init-examples-suite")
+const helper = require("../../test/helper")
+
+helper.describeIntegration(helper.toSuiteName(__filename), function T() {
+ this.timeout(5000)
+ this.slow(3000)
+ it(path.basename(__filename), (done) => {
+ const expect = chai.expect
+ const apiKey = "11111111111111111111111111111111"
+
+ // To use the Promise style instead of the Callback style send promise=true as an option.
+ const route4me = new Route4Me(apiKey, { promise: true });
+
+ (async () => {
+ try {
+ // get default optimization profile id
+ const data = await route4me.OptimizationProfiles.list();
+ expect(data).exist
+
+ const default_profile = data.items.find((item) => item.is_default);
+ if(default_profile) {
+
+ // save data
+ const data = {
+ items: [{
+ guid: "eaa",
+ parts: [{
+ guid: "pav",
+ data: { "append_date_to_route_name": true }
+ }],
+ id: default_profile.optimization_profile_id
+ }]
+ };
+ const res = await route4me.OptimizationProfiles.save(data);
+ expect(res).exist
+
+ console.log(`Data for optimization_profile_id: '${default_profile.optimization_profile_id}' was saved successful.`);
+ } else {
+ console.log("Cannot find the default optimization profile id.");
+ }
+ }
+ catch(err) {
+ expect(err).exist
+ // console.log("Error ", err);
+ }
+ })();
+
+ // TODO: remove `done` call from examples
+ done()
+ })
+})

examples/OptimizationProfiles/save-data.js

@@ -0,0 +1,61 @@
+"use strict"
+
+const path = require("path")
+const chai = require("chai")
+const debug = require("debug")("route4me-node:examples")
+require("../init-examples-suite")
+const helper = require("../../test/helper")
+
+helper.describeIntegration(helper.toSuiteName(__filename), function T() {
+ this.timeout(5000)
+ this.slow(3000)
+ it(path.basename(__filename), (done) => {
+ const expect = chai.expect
+ const apiKey = "11111111111111111111111111111111"
+ const route4me = new Route4Me(apiKey)
+
+ // get default optimization profile id
+ route4me.OptimizationProfiles.list((err, data) => {
+ debug("error ", err)
+ expect(err).is.null
+ expect(data).exist
+
+ if(err) {
+ console.log("Error: list, " + err);
+ return;
+ }
+
+ const default_profile = data.items.find((item) => item.is_default);
+ if(default_profile) {
+
+ // save data
+ const data = {
+ items: [{
+ guid: "eaa",
+ parts: [{
+ guid: "pav",
+ data: { "append_date_to_route_name": true }
+ }],
+ id: default_profile.optimization_profile_id
+ }]
+ };
+ route4me.OptimizationProfiles.save(data, (err, data) => {
+ debug("error ", err)
+ expect(err).is.null
+ expect(data).exist
+
+ if(err) {
+ console.log("Error: save, " + err);
+ return;
+ }
+ console.log(`Data for optimization_profile_id: '${default_profile.optimization_profile_id}' was saved successful.`);
+ });
+ } else {
+ console.log("Cannot find the default optimization profile id.");
+ }
+ });
+
+ // TODO: remove `done` call from examples
+ done()
+ })
+})

package.json

@@ -1,6 +1,6 @@
 {
  "name": "route4me-nodejs-sdk",
- "version": "1.0.28",
+ "version": "1.2.0",
  "description": "Access Route4Me's logistics-as-a-service API using our Node.js SDK",
  "main": "src/index.js",
  "browser": "src/route4me.js",

src/request-manager.js

@@ -252,7 +252,7 @@ class RequestManager {
  if (form) {
  req.type("multipart/form-data")
  .field(form)
- } else {
+ } else if (body) {
  req.type("application/json")
  .send(body)
  }