route4me-node
Version:
Access Route4Me's logistics-as-a-service API using our Node.js SDK
348 lines (298 loc) • 8.86 kB
JavaScript
;
var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
var debug = require("debug")("route4me");
var utils = require("./../utils");
var errors = require("./../errors");
var CustomInternalPostProcessing = function () {
function CustomInternalPostProcessing() {
_classCallCheck(this, CustomInternalPostProcessing);
}
_createClass(CustomInternalPostProcessing, null, [{
key: "list",
value: function list(data, ctx, res) {
if (!data || !utils.isObject(data)) {
return new errors.Route4MeValidationError("Invalid response", data);
}
if (Array.isArray(data["results"]) && undefined !== data["total"]) {
debug("Orders:list:pp received a response with an array");
// the response is an array of Orders
return data["results"];
}
if ("number" === typeof data["order_id"]) {
debug("Orders:list:pp received a response with one item (it will be wrapped)");
// the response contains only one item, we should wrap it to array
return [data];
}
// TODO: parse real error
return new errors.Route4MeApiError("Failed", res);
}
}]);
return CustomInternalPostProcessing;
}();
// ===================================
/**
* Orders facility
*
* @category Orders
*/
var Orders = function () {
/**
* Constructor
*
* @see {@link https://route4me.io/docs/#orders}
* @since 0.1.11
* @private
*
* @param {RequestManager} requestManager - Request Manager
* @return {Orders} - Orders facility
*/
function Orders(requestManager) {
_classCallCheck(this, Orders);
this.r = requestManager;
}
/**
* Create an Order
*
* @example <caption>Sample input</caption>
*
* {
* "address_1": "1358 E Luzerne St, Philadelphia, PA 19124, US",
* "cached_lat" : 48.335991,
* "cached_lng" : 31.18287,
* "address_alias" : "Auto test address",
* "address_city" : "Philadelphia",
* "EXT_FIELD_first_name" : "Igor",
* "EXT_FIELD_last_name" : "Progman",
* "EXT_FIELD_email" : "progman@gmail.com",
* "EXT_FIELD_phone" : "380380380380",
* "EXT_FIELD_custom_data" : [
* {
* "order_id" : "10",
* "name" : "Bill Soul"
* }
* ]
* }
*
* @see {@link https://route4me.io/docs/#create-an-order}
* @since 0.1.11
*
* @todo TODO: use custom input format (well formatted)
*
* @param {jsonschema:Orders.OrderInput} data - New order
* @param {module:route4me-node~RequestCallback<jsonschema:Orders.Order>} [callback]
*/
_createClass(Orders, [{
key: "create",
value: function create(data, callback) {
var body = data; // convert data
return this.r._makeRequest({
method: "POST",
path: "/api.v4/order.php",
body,
validationContext: "Orders.Order"
}, callback);
}
/**
* Get an Order Details
*
* @see {@link https://route4me.io/docs/#get-an-order-details}
* @since 0.1.11
*
* @param {number} id - Order ID
* @param {module:route4me-node~RequestCallback<jsonschema:Orders.Order>} [callback]
*/
}, {
key: "get",
value: function get(id, callback) {
var pureId = Number(id);
return this.r._makeRequest({
method: "GET",
path: "/api.v4/order.php",
qs: {
"order_id": pureId
},
validationContext: "Orders.Order"
}, callback);
}
/**
* Get all the orders created under the specific Route4Me account
*
* @see {@link https://route4me.io/docs/#get-orders-with-details}
* @since 0.1.11
*
* @param {number|string|Array<number>|Array<string>} [ids] - Order IDs in one
* of the following form:
* * CSV-string
* * one ID as string
* * one ID as number
* * array of strings
* * array of numbers
*
* If you want to load all Orders:
* * **Don't pass** this parameter
* * **OR** pass `ids=undefined`
* * **OR** pass `ids=false`
*
* @param {module:route4me-node~RequestCallback<jsonschema:Orders.Orders>} [callback]
* [callback]
*/
}, {
key: "list",
value: function list(ids, callback) {
var pureIds = ids;
var cb = callback;
if (undefined === cb && "function" === typeof pureIds) {
cb = pureIds;
pureIds = undefined;
}
var qs = {};
if (pureIds || 0 === pureIds) {
pureIds = utils.toIntArray(pureIds);
qs["order_id"] = pureIds;
}
return this.r._makeRequest({
method: "GET",
path: "/api.v4/order.php",
qs,
validationContext: CustomInternalPostProcessing.list
}, callback);
}
/**
* Remove an Order
*
* @see {@link https://route4me.io/docs/#remove-an-order}
* @since 0.1.11
*
* @param {number|string|Array<number>|Array<string>} ids - Order ID/IDs to remove in one
* of the following form:
* * CSV-string
* * one ID as string
* * one ID as number
* * array of strings
* * array of numbers
*
* @param {module:route4me-node~RequestCallback} [callback]
*/
}, {
key: "remove",
value: function remove(ids, callback) {
var pureIds = utils.toIntArray(ids);
var qs = {
"redirect": 0
};
var body = {
"order_ids": pureIds
};
return this.r._makeRequest({
method: "DELETE",
path: "/api.v4/order.php",
qs,
body,
validationContext: utils.CustomInternalPostProcessing.fromJsonWithStatus
}, callback);
}
/**
* Update an Order
*
* @see {@link https://route4me.io/docs/#update-an-order}
* @since 0.1.11
*
* @param {number} id - Order ID
* @param {jsonschema:Orders.Order} data - Order data
* @param {module:route4me-node~RequestCallback<jsonschema:Orders.Order>} [callback]
*/
}, {
key: "update",
value: function update(id, data, callback) {
var qs = {
"redirect": 0
};
var body = utils.clone(data);
body["order_id"] = Number(id);
return this.r._makeRequest({
method: "PUT",
path: "/api.v4/order.php",
qs,
body,
validationContext: "Orders.Order"
}, callback);
}
/**
* Search Orders
*
* @see {@link https://route4me.io/docs/#search-orders}
* @since 0.1.11
*
* @todo TODO: Parse response
* @todo TODO: Test timezone for this method {@link https://github.com/route4me/route4me-nodejs-sdk/issues/42}
* @todo TODO: Handle the diffrerent format of the output (when fields are set,
* see https://github.com/route4me/route4me-nodejs-sdk/issues/38)
*
* @param {string|Object} criteria - Searched text or searching criteria
* @param {Date} [criteria.byAddDate] - Date order was inserted
* @param {Date} [criteria.byScheduledDate] - Date order was scheduled for
* @param {string} [criteria.query] - The text searched for
*
* @param {Object} [options] - List-parameters
* @param {number} [options.limit] - List limit
* @param {number} [options.offset] - List offset
* @param {module:route4me-node~RequestCallback<jsonschema:Orders.Orders>} [callback]
*/
}, {
key: "search",
value: function search(criteria, options, callback) {
var qs = {
"redirect": 0
};
var cri = criteria;
var opt = options;
var cb = callback;
if ("string" === typeof cri) {
cri = {
"query": cri
};
}
if (!utils.isObject(cri)) {
cri = {};
}
if (undefined === cb && "function" === typeof opt) {
cb = opt;
opt = {};
}
if (!utils.isObject(opt)) {
opt = {};
}
// OPTIONS
if ("offset" in opt) {
qs["offset"] = opt.offset;
}
if ("limit" in opt) {
qs["limit"] = opt.limit;
}
if ("fields" in opt) {
qs["fields"] = opt.fields;
}
// CRITERIA
if ("query" in cri) {
qs["query"] = cri["query"];
}
if ("byAddDate" in cri) {
var d = cri["byAddDate"];
qs["day_added_YYMMDD"] = utils.toIsoDateString(d);
}
if ("byScheduledDate" in cri) {
var _d = cri["byScheduledDate"];
qs["scheduled_for_YYMMDD"] = utils.toIsoDateString(_d);
}
return this.r._makeRequest({
method: "GET",
path: "/api.v4/order.php",
qs,
validationContext: CustomInternalPostProcessing.list
}, callback);
}
}]);
return Orders;
}();
module.exports = Orders;