const base = require("../base");
const ripe = base.ripe;
/**
* Gets the orders list, optionally filtered by a set of options.
*
* @param {Object} options An object of options to configure the query and
* its results, such as:
* - 'filters[]' - List of filters that the query will use to, operators such as
* ('in', 'not_in', 'like', 'likei', 'llike', 'llikei', 'rlike', 'rlikei', 'contains'),
* (eg: 'number:eq:42') would filter by the 'number' that equals to '42'.
* - 'sort' - List of arguments to sort the results by and which direction
* to sort them in (eg: 'id:ascending') would sort by the id attribute in ascending order,
* while (eg: 'id:descending')] would do it in descending order.
* - 'skip' - The number of the first record to retrieve from the results.
* - 'limit' - The number of results to retrieve.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.getOrders = function(options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders`;
options = Object.assign(options, {
url: url,
method: "GET",
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Gets the orders list, optionally filtered by a set of options.
*
* @param {Object} options An object of options to configure the request.
* its results, such as:
* - 'filters[]' - List of filters that the query will use to, operators such as
* ('in', 'not_in', 'like', 'contains'), for instance (eg: 'id:eq:42') would filter by the id that equals to 42.
* - 'sort' - List of arguments to sort the results by and which direction
* to sort them in (eg: 'id:ascending') would sort by the id attribute in ascending order,
* while (eg: 'id:descending')] would do it in descending order.
* - 'skip' - The number of the first record to retrieve from the results.
* - 'limit' - The number of results to retrieve.
* @returns {Promise} The orders result list.
*/
ripe.Ripe.prototype.getOrdersP = function(options) {
return new Promise((resolve, reject) => {
this.getOrders(options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Gets an order by number.
*
* @param {Number} number The number of the order to find by.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.getOrder = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}`;
options = Object.assign(options, {
url: url,
method: "GET",
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Gets an order by number.
*
* @param {Number} number The number of the order to find by.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The order requested by number.
*/
ripe.Ripe.prototype.getOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.getOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Gets an order transport info.
*
* @param {Number} number The number of the order to find by.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.getTransportOrder = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/transport`;
options = Object.assign(options, {
url: url,
method: "GET",
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Gets an order transport info.
*
* @param {Number} number The number of the order to find by.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The order transport info.
*/
ripe.Ripe.prototype.getTransportOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.getTransportOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Deletes an order by number.
*
* @param {Number} number The number of the order to delete.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.deleteOrder = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}`;
options = Object.assign(options, {
url: url,
method: "DELETE",
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Deletes an order by number.
*
* @param {Number} number The number of the order to delete.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The result of the order deletion.
*/
ripe.Ripe.prototype.deleteOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.deleteOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Returns all the attachments of an order.
*
* @param {Number} number The number of the order to find by.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.attachmentsOrder = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/attachments`;
options = Object.assign(options, {
url: url,
method: "GET",
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Returns all the attachments of an order.
*
* @param {Number} number The number of the order to find by.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} An object containing all the attachments of an order.
*/
ripe.Ripe.prototype.attachmentsOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.attachmentsOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Adds an attachment to an order.
*
* @param {Number} number The number of the order where the attachment will be added.
* @param {Object} file The attachment file to be added to the order.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.createAttachmentOrder = function(number, file, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/attachments`;
const dataM = { file: file };
if (options.name !== undefined) dataM.name = options.name;
if (options.meta !== undefined) dataM.meta = JSON.stringify(options.meta);
options = Object.assign(options, {
url: url,
method: "POST",
dataM: dataM,
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Adds an attachment to an order.
*
* @param {Number} number The number of the order where the attachment will be added.
* @param {Object} file The attachment file to be added to the order.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {Promise} The attachment added to the order.
*/
ripe.Ripe.prototype.createAttachmentOrderP = function(number, file, options) {
return new Promise((resolve, reject) => {
this.createAttachmentOrder(number, file, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Returns the attachment of an order requested by ID.
*
* @param {Number} number The number of the order to find by.
* @param {Number} attachmentId The ID of the attachment of the order to find by.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.attachmentOrder = function(number, attachmentId, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/attachments/${attachmentId}`;
options = Object.assign(options, {
url: url,
method: "GET",
auth: true,
cached: false
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Returns the attachment of an order requested by ID.
*
* @param {Number} number The number of the order to find by.
* @param {Number} attachmentId The ID of the attachment of the order to find by.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {Promise} The attachment file of an order requested by ID.
*/
ripe.Ripe.prototype.attachmentOrderP = function(number, attachmentId, options) {
return new Promise((resolve, reject) => {
this.attachmentOrder(number, attachmentId, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Creates a note with the provided text and associates it
* with the order with the provided number.
*
* @param {Number} number The number of the order to associate a note.
* @param {String} text The note text, containing the context of the note.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.createNoteOrder = function(number, text, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/notes`;
options = Object.assign(options, {
url: url,
method: "POST",
auth: true
});
options.params = options.params || {};
options.params.text = text;
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Creates a note with the provided text and associates it
* with the order with the provided number.
*
* @param {Number} number The number of the order to associate a note.
* @param {String} text The note text, containing the context of the note.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The contents of the note instance that was created.
*/
ripe.Ripe.prototype.createNoteOrderP = function(number, text, options) {
return new Promise((resolve, reject) => {
this.createNoteOrder(number, text, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Creates an order issue with the provided description, error log and severity
* and associates it with the order with the provided number.
*
* @param {Number} number The number of the order to associate an issue.
* @param {String} issue The issue name, containing the context of issue.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.createIssueOrder = function(number, issue, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/issues`;
options = Object.assign(options, {
url: url,
method: "POST",
auth: true
});
options.params = options.params || {};
options.params.issue = issue;
if (options.description !== undefined) options.params.description = options.description;
if (options.severity !== undefined) options.params.severity = options.severity;
if (options.log !== undefined) options.params.log = options.log;
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Creates an order issue with the provided description, error log and severity
* and associates it with the order with the provided number.
*
* @param {Number} number The number of the order to associate an issue.
* @param {String} issue The issue name, containing the context of issue.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The contents of the issue instance that was created.
*/
ripe.Ripe.prototype.createIssueOrderP = function(number, issue, options) {
return new Promise((resolve, reject) => {
this.createIssueOrder(number, issue, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Creates a shipping waybill for the order with the provided number.
*
* @param {Number} number The number of the order to create the waybill for.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.createWaybillOrder = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/waybill`;
options = Object.assign(options, {
url: url,
method: "POST",
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Creates a shipping waybill for the order with the provided number.
*
* @param {Number} number The number of the order to create the waybill for.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The contents of the note instance that was created.
*/
ripe.Ripe.prototype.createWaybillOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.createWaybillOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Creates a shipping return waybill for the order with the provided number.
*
* @param {Number} number The number of the order to create the return waybill for.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.createReturnWaybillOrder = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/return_waybill`;
options = Object.assign(options, {
url: url,
method: "POST",
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Creates a shipping return waybill for the order with the provided number.
*
* @param {Number} number The number of the order to create the return waybill for.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The contents of the note instance that was created.
*/
ripe.Ripe.prototype.createReturnWaybillOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.createReturnWaybillOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Voids the waybill for the order with the provided number.
*
* @param {Number} number The number of the order to void the waybill for.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.voidWaybillOrder = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/waybill`;
options = Object.assign(options, {
url: url,
method: "DELETE",
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Voids the waybill for the order with the provided number.
*
* @param {Number} number The number of the order to void the waybill for.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The result of the waybill deletion.
*/
ripe.Ripe.prototype.voidWaybillOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.voidWaybillOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Voids the return waybill for the order with the provided number.
*
* @param {Number} number The number of the order to void the return waybill for.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.voidReturnWaybillOrder = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/return_waybill`;
options = Object.assign(options, {
url: url,
method: "DELETE",
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Voids the return waybill for the order with the provided number.
*
* @param {Number} number The number of the order to void the return waybill for.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The result of the waybill deletion.
*/
ripe.Ripe.prototype.voidReturnWaybillOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.voidReturnWaybillOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Manually trigger an order shipping info refresh.
*
* @param {Number} number The number of the order to refresh the shipping info.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.refreshShippingOrder = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/refresh_shipping`;
options = Object.assign(options, {
url: url,
method: "POST",
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Manually trigger an order shipping info refresh.
*
* @param {Number} number The number of the order to refresh the shipping info.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The order requested by number.
*/
ripe.Ripe.prototype.refreshShippingOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.refreshShippingOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Returns all the states (logs) of an order.
*
* @param {Number} number The number of the order to find by.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.logOrder = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/log`;
options = Object.assign(options, {
url: url,
method: "GET",
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Returns all the states of an order.
*
* @param {Number} number The number of the order to find by.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The states of an order requested by number.
*/
ripe.Ripe.prototype.logOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.logOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Returns the general chat of an order, unrelated to any state.
*
* @param {Number} number The number of the order to get the chat from.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.chatOrder = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/chat`;
options = Object.assign(options, {
url: url,
method: "GET",
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Returns the general chat of an order, unrelated to any state.
*
* @param {Number} number The number of the order to get the chat from.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The order's chat.
*/
ripe.Ripe.prototype.chatOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.chatOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Returns the general chat lines of an order, unrelated to any state.
*
* If the option `states` is set to true, it returns the general chat
* lines merged with each state's information summarized (e.g. number of
* messages for that state and authors) taking into account the ordering
* of events, meaning state updates can appear between chat lines.
*
* @param {Number} number The number of the order to get the chat lines from.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.chatLinesOrder = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/chat/lines`;
options = Object.assign(options, {
url: url,
method: "GET",
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Returns the general chat lines of an order, unrelated to any state.
*
* If the option `states` is set to true, it returns the general chat
* lines merged with each state's information summarized (e.g. number of
* messages for that state and authors) taking into account the ordering
* of events, meaning state updates can appear between chat lines.
*
* @param {Number} number The number of the order to get the chat lines from.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The order chat's lines.
*/
ripe.Ripe.prototype.chatLinesOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.chatLinesOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Returns the number of general chat lines of an order, unrelated to any state.
*
* @param {Number} number The number of the order to get the number of chat lines from.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.chatLinesCountOrder = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/chat/lines/count`;
options = Object.assign(options, {
url: url,
method: "GET",
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Returns the number of general chat lines of an order, unrelated to any state.
*
* @param {Number} number The number of the order to get the number of chat lines from.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The number of order chat's lines.
*/
ripe.Ripe.prototype.chatLinesCountOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.chatLinesCountOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Adds a new general chat line message to a specific order.
*
* @param {Number} number The number of the order where the chat line message will be added.
* @param {Object} contents The contents of the chat message.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.chatCreateLineOrder = function(number, contents, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/chat/lines`;
options = Object.assign(options, {
url: url,
method: "POST",
params: {
contents: contents
},
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Adds a new general chat line message to a specific order.
*
* @param {Number} number The number of the order where the chat line message will be added.
* @param {Object} contents The contents of the chat message.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} An object containing the chat lines for the specific order.
*/
ripe.Ripe.prototype.chatCreateLineOrderP = function(number, contents, options) {
return new Promise((resolve, reject) => {
this.chatCreateLineOrder(number, contents, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Returns all the states of an order.
*
* @param {Number} number The number of the order to find by.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.statesOrder = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/states`;
options = Object.assign(options, {
url: url,
method: "GET",
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Returns all the states of an order.
*
* @param {Number} number The number of the order to find by.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The states of an order requested by number.
*/
ripe.Ripe.prototype.statesOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.statesOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Returns the state of an order.
*
* @param {Number} number The number of the order to find by.
* @param {Number} stateId The ID of the state of the order to find by.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.stateOrder = function(number, stateId, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/states/${stateId}`;
options = Object.assign(options, {
url: url,
method: "GET",
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Returns the state of an order.
*
* @param {Number} number The number of the order to find by.
* @param {Number} stateId The ID of the state of the order to find by.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {Promise} The state requested by ID.
*/
ripe.Ripe.prototype.stateOrderP = function(number, stateId, options) {
return new Promise((resolve, reject) => {
this.stateOrder(number, stateId, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Returns the chat name and lines of an order for a specific state.
*
* @param {Number} number The number of the order to find by.
* @param {Number} stateId The ID of the state of the order to find by.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.stateChatOrder = function(number, stateId, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/states/${stateId}/chat`;
options = Object.assign(options, {
url: url,
method: "GET",
auth: true,
cached: false
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Returns the chat name and lines of an order for a specific state.
*
* @param {Number} number The number of the order to find by.
* @param {Number} stateId The ID of the state of the order to find by.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {Promise} An object containing the chat name and lines for a specific state.
*/
ripe.Ripe.prototype.stateChatOrderP = function(number, stateId, options) {
return new Promise((resolve, reject) => {
this.stateChatOrder(number, stateId, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Returns all the chat lines of an order for a specific state.
*
* @param {Number} number The number of the order to find by.
* @param {Number} stateId The ID of the state of the order to find by.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.stateChatLinesOrder = function(number, stateId, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/states/${stateId}/chat/lines`;
options = Object.assign(options, {
url: url,
method: "GET",
auth: true,
cached: false
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Returns all the chat lines of an order for a specific state.
*
* @param {Number} number The number of the order to find by.
* @param {Number} stateId The ID of the state of the order to find by.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {Promise} An object containing the chat lines for a specific state.
*/
ripe.Ripe.prototype.stateChatLinesOrderP = function(number, stateId, options) {
return new Promise((resolve, reject) => {
this.stateChatLinesOrder(number, stateId, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Returns the number of chat lines of an order for a specific state.
*
* @param {Number} number The number of the order to find by.
* @param {Number} stateId The ID of the state of the order to find by.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.stateChatLinesCountOrder = function(number, stateId, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/states/${stateId}/chat/lines/count`;
options = Object.assign(options, {
url: url,
method: "GET",
auth: true,
cached: false
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Returns the number of chat lines of an order for a specific state.
*
* @param {Number} number The number of the order to find by.
* @param {Number} stateId The ID of the state of the order to find by.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {Promise} An object containing the number of chat lines for a specific state.
*/
ripe.Ripe.prototype.stateChatLinesCountOrderP = function(number, stateId, options) {
return new Promise((resolve, reject) => {
this.stateChatLinesCountOrder(number, stateId, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Adds a new chat line message to a specific order for a specific state.
*
* @param {Number} number The number of the order where the chat line message will be added.
* @param {Number} stateId The ID of the state of the order where the chat line message will be added.
* @param {Object} contents The contents of the chat message.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.stateChatCreateLineOrder = function(
number,
stateId,
contents,
options,
callback
) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/states/${stateId}/chat/lines`;
options = Object.assign(options, {
url: url,
method: "POST",
params: {
contents: contents
},
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Adds a new chat line message to a specific order for a specific state.
*
* @param {Number} number The number of the order where the chat line message will be added.
* @param {Number} stateId The ID of the state of the order where the chat line message will be added.
* @param {Object} contents The contents of the chat message.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {Promise} An object containing the chat lines for the specific state.
*/
ripe.Ripe.prototype.stateChatCreateLineOrderP = function(number, stateId, contents, options) {
return new Promise((resolve, reject) => {
this.stateChatCreateLineOrder(
number,
stateId,
contents,
options,
(result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
}
);
});
};
/**
* Returns all the attachments of an order for a specific state.
*
* @param {Number} number The number of the order to find by.
* @param {Number} stateId The ID of the state of the order to find by.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.stateAttachmentsOrder = function(number, stateId, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/states/${stateId}/attachments`;
options = Object.assign(options, {
url: url,
method: "GET",
auth: true,
cached: false
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Returns all the attachments of an order for a specific state.
*
* @param {Number} number The number of the order to find by.
* @param {Number} stateId The ID of the state of the order to find by.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {Promise} All the attachments of a specific order and state.
*/
ripe.Ripe.prototype.stateAttachmentsOrderP = function(number, stateId, options) {
return new Promise((resolve, reject) => {
this.stateAttachmentsOrder(number, stateId, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Returns the number of attachments of an order for a specific state.
*
* @param {Number} number The number of the order to find by.
* @param {Number} stateId The ID of the state of the order to find by.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.stateAttachmentsCountOrder = function(number, stateId, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/states/${stateId}/attachments/count`;
options = Object.assign(options, {
url: url,
method: "GET",
auth: true,
cached: false
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Returns the number of attachments of an order for a specific state.
*
* @param {Number} number The number of the order to find by.
* @param {Number} stateId The ID of the state of the order to find by.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {Promise} An object containing the number of attachments.
*/
ripe.Ripe.prototype.stateAttachmentsCountOrderP = function(number, stateId, options) {
return new Promise((resolve, reject) => {
this.stateAttachmentsCountOrder(number, stateId, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Adds an attachment to an order for a specific state.
*
* @param {Number} number The number of the order to add the attachment to.
* @param {Number} stateId The ID of the state of the order to add the attachment to.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.stateCreateAttachmentOrder = function(
number,
stateId,
file,
options,
callback
) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/states/${stateId}/attachments`;
const dataM = { file: file };
if (options.name !== undefined) dataM.name = options.name;
if (options.meta !== undefined) dataM.meta = JSON.stringify(options.meta);
options = Object.assign(options, {
url: url,
method: "POST",
dataM: dataM,
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Adds an attachment to an order for a specific state.
*
* @param {Number} number The number of the order to add the attachment to.
* @param {Number} stateId The ID of the state of the order to add the attachment to.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {Promise} The attachment added.
*/
ripe.Ripe.prototype.stateCreateAttachmentOrderP = function(number, stateId, file, options) {
return new Promise((resolve, reject) => {
this.stateCreateAttachmentOrder(
number,
stateId,
file,
options,
(result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
}
);
});
};
/**
* Gets the attachment with a specific ID of an order for a specific state.
*
* @param {Number} number The number of the order to find by.
* @param {Number} stateId The ID of the state of the order to find by.
* @param {Number} attachmentId The ID of the attachment to find.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.stateAttachmentOrder = function(
number,
stateId,
attachmentId,
options,
callback
) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/states/${stateId}/attachments/${attachmentId}`;
options = Object.assign(options, {
url: url,
method: "GET",
auth: true,
cached: false
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Gets the attachment with a specific ID of an order for a specific state.
*
* @param {Number} number The number of the order to find by.
* @param {Number} stateId The ID of the state of the order to find by.
* @param {Number} attachmentId The ID of the attachment to find.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {Promise} The attachment file requested by ID.
*/
ripe.Ripe.prototype.stateAttachmentOrderP = function(number, stateId, attachmentId, options) {
return new Promise((resolve, reject) => {
this.stateAttachmentOrder(
number,
stateId,
attachmentId,
options,
(result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
}
);
});
};
/**
* Searches for orders using the filter string and the options that
* are provided.
*
* @param {String} filterString An unstructured string to be used in the
* orders search operation.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.searchOrders = function(filterString, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/search`;
const params = {};
if (filterString !== undefined && filterString !== null) {
params.filter_string = filterString;
}
options = Object.assign(options, {
url: url,
method: "GET",
auth: true,
params: params
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Searches for orders using the filter string and the options that
* are provided.
*
* @param {String} filterString An unstructured string to be used in the
* orders search operation.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The result of the order deletion.
*/
ripe.Ripe.prototype.searchOrdersP = function(filterString, options) {
return new Promise((resolve, reject) => {
this.searchOrders(filterString, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Sets the order status to 'create'.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.createOrder = function(number, options, callback) {
return this.setOrderStatus(number, "create", options, callback);
};
/**
* Sets the order status to 'create'.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {Promise} The order with the updated status.
*/
ripe.Ripe.prototype.createOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.createOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Sets the order status to 'produce'.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.produceOrder = function(number, options, callback) {
return this.setOrderStatus(number, "produce", options, callback);
};
/**
* Sets the order status to 'produce'.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {Promise} The order with the updated status.
*/
ripe.Ripe.prototype.produceOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.produceOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Sets the order status to 'quality_assure'.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.qualityAssureOrder = function(number, options, callback) {
return this.setOrderStatus(number, "quality_assure", options, callback);
};
/**
* Sets the order status to 'quality_assure'.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {Promise} The order with the updated status.
*/
ripe.Ripe.prototype.qualityAssureOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.qualityAssureOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Sets the order status to 'reject'.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.rejectOrder = function(number, options, callback) {
return this.setOrderStatus(number, "reject", options, callback);
};
/**
* Sets the order status to 'reject'.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {Promise} The order with the updated status.
*/
ripe.Ripe.prototype.rejectOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.rejectOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Sets the order status to 'ready'.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.readyOrder = function(number, options, callback) {
return this.setOrderStatus(number, "ready", options, callback);
};
/**
* Sets the order status to 'ready'.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {Promise} The order with the updated status.
*/
ripe.Ripe.prototype.readyOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.readyOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Sets the order status to 'sent'.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.sendOrder = function(number, trackingNumber, trackingUrl, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
options = Object.assign(options, {
params: {
tracking_number: trackingNumber,
tracking_url: trackingUrl
}
});
return this.setOrderStatus(number, "send", options, callback);
};
/**
* Sets the order status to 'sent'.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {Promise} The order with the updated status.
*/
ripe.Ripe.prototype.sendOrderP = function(number, trackingNumber, trackingUrl, options) {
return new Promise((resolve, reject) => {
this.sendOrder(number, trackingNumber, trackingUrl, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Sets the order status to 'blocked'.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.blockOrder = function(number, options, callback) {
return this.setOrderStatus(number, "block", options, callback);
};
/**
* Sets the order status to 'blocked'.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {Promise} The order with the updated status.
*/
ripe.Ripe.prototype.blockOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.blockOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Sets the order status to 'receive'.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.receiveOrder = function(number, options, callback) {
return this.setOrderStatus(number, "receive", options, callback);
};
/**
* Sets the order status to 'receive'.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {Promise} The order with the updated status.
*/
ripe.Ripe.prototype.receiveOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.receiveOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Sets the order status to 'return'.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.returnOrder = function(number, options, callback) {
return this.setOrderStatus(number, "return", options, callback);
};
/**
* Sets the order status to 'return'.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {Promise} The order with the updated status.
*/
ripe.Ripe.prototype.returnOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.returnOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Sets the order status to 'cancel'.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.cancelOrder = function(number, options, callback) {
return this.setOrderStatus(number, "cancel", options, callback);
};
/**
* Sets the order status to 'cancel'.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {Promise} The order with the updated status.
*/
ripe.Ripe.prototype.cancelOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.cancelOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Changes an entry of an order's meta adding the new meta entry
* according to the provided value or changing an existing one.
*
* @param {Number} number The number of the order to change the meta.
* @param {String} key The key to set.
* @param {Object} value The value to set, which might be of any type
* (string, number, object or list), providing a `null` value deletes
* the key.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.setMeta = function(number, key, value, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/meta`;
options = Object.assign(options, {
url: url,
method: "PUT",
auth: true,
dataJ: {
key: key,
value: value
}
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Changes an entry of an order's meta adding the new meta entry
* according to the provided value or changing an existing one.
*
* @param {Number} number The number of the order to change the meta.
* @param {String} key The key to set.
* @param {Object} value The value to set, which might be of any type
* (string, number, object or list), providing a `null` value deletes
* the key.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The result of the order meta change.
*/
ripe.Ripe.prototype.setMetaP = function(number, key, value, options) {
return new Promise((resolve, reject) => {
this.setMeta(number, key, value, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Changes the priority of an order.
*
* @param {Number} number The number of the order to change the priority.
* @param {Number} priority The new priority.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.setPriority = function(number, priority, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/priority`;
options = Object.assign(options, {
url: url,
method: "PUT",
auth: true,
params: {
priority: priority
}
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Changes the priority of an order.
*
* @param {Number} number The number of the order to change the priority.
* @param {Number} priority The new priority.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The result of the order priority change.
*/
ripe.Ripe.prototype.setPriorityP = function(number, priority, options) {
return new Promise((resolve, reject) => {
this.setPriority(number, priority, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Changes the tracking info of an order.
*
* @param {Number} number The number of the order to change the tracking info.
* @param {String} trackingNumber The new tracking number.
* @param {String} trackingUrl The new tracking URL.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.setTracking = function(
number,
trackingNumber,
trackingUrl,
options,
callback
) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/tracking`;
options = Object.assign(options, {
url: url,
method: "PUT",
auth: true,
params: {
tracking_number: trackingNumber,
tracking_url: trackingUrl
}
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Changes the tracking info of an order.
*
* @param {Number} number The number of the order to change the tracking info.
* @param {String} trackingNumber The new tracking number.
* @param {String} trackingUrl The new tracking URL.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The result of the order tracking info change.
*/
ripe.Ripe.prototype.setTrackingP = function(number, trackingNumber, trackingUrl, options) {
return new Promise((resolve, reject) => {
this.setTracking(
number,
trackingNumber,
trackingUrl,
options,
(result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
}
);
});
};
/**
* Changes the return tracking info of an order.
*
* @param {Number} number The number of the order to change the return tracking info.
* @param {String} returnTrackingNumber The new return tracking number.
* @param {String} returnTrackingUrl The new return tracking URL.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.setReturnTracking = function(
number,
returnTrackingNumber,
returnTrackingUrl,
options,
callback
) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/return_tracking`;
options = Object.assign(options, {
url: url,
method: "PUT",
auth: true,
params: {
return_tracking_number: returnTrackingNumber,
return_tracking_url: returnTrackingUrl
}
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Changes the return tracking info of an order.
*
* @param {Number} number The number of the order to change the return tracking info.
* @param {String} returnTrackingNumber The new return tracking number.
* @param {String} returnTrackingUrl The new return tracking URL.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The result of the order tracking info change.
*/
ripe.Ripe.prototype.setReturnTrackingP = function(
number,
returnTrackingNumber,
returnTrackingUrl,
options
) {
return new Promise((resolve, reject) => {
this.setReturnTracking(
number,
returnTrackingNumber,
returnTrackingUrl,
options,
(result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
}
);
});
};
/**
* Unsets the tracking info of an order.
*
* @param {Number} number The number of the order to unset the tracking info.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.unsetTracking = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/tracking`;
options = Object.assign(options, {
url: url,
method: "DELETE",
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Unsets the tracking info of an order.
*
* @param {Number} number The number of the order to unset the tracking info.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The result of the order tracking info change.
*/
ripe.Ripe.prototype.unsetTrackingP = function(number, options) {
return new Promise((resolve, reject) => {
this.unsetTracking(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Unsets the return tracking info of an order.
*
* @param {Number} number The number of the order to unset the return tracking info.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.unsetReturnTracking = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/return_tracking`;
options = Object.assign(options, {
url: url,
method: "DELETE",
auth: true
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Unsets the return tracking info of an order.
*
* @param {Number} number The number of the order to unset the return tracking info.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The result of the order tracking info change.
*/
ripe.Ripe.prototype.unsetReturnTrackingP = function(number, options) {
return new Promise((resolve, reject) => {
this.unsetReturnTracking(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Changes the pickup reference number of an order.
*
* @param {Number} number The number of the order to change the pickup reference number.
* @param {String} pickupNumber The new pickup reference number.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.setPickup = function(number, pickupNumber, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/pickup_number`;
options = Object.assign(options, {
url: url,
method: "PUT",
auth: true,
params: {
pickup_number: pickupNumber
}
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Changes the pickup reference number of an order.
*
* @param {Number} number The number of the order to change the pickup reference number.
* @param {String} pickupNumber The new pickup reference number.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The result of the order tracking info change.
*/
ripe.Ripe.prototype.setPickupP = function(number, pickupNumber, options) {
return new Promise((resolve, reject) => {
this.setPickup(number, pickupNumber, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Changes the proof of delivery info of an order.
*
* @param {Number} number The number of the order to change the proof of delivery info.
* @param {String} proofOfDeliveryUrl The new proof of delivery URL.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.setProofOfDelivery = function(number, proofOfDeliveryUrl, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/proof_of_delivery`;
options = Object.assign(options, {
url: url,
method: "PUT",
auth: true,
params: {
proof_of_delivery_url: proofOfDeliveryUrl
}
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Changes the proof of delivery info of an order.
*
* @param {Number} number The number of the order to change the proof of delivery info.
* @param {String} proofOfDeliveryUrl The new proof of delivery URL.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The result of the order proof of delivery info change.
*/
ripe.Ripe.prototype.setProofOfDeliveryP = function(number, proofOfDeliveryUrl, options) {
return new Promise((resolve, reject) => {
this.setProofOfDelivery(number, proofOfDeliveryUrl, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Imports a production order to RIPE Core.
*
* @param {Number} ffOrderId The e-commerce order identifier.
* @param {Object} options An object with options, such as:
* - 'brand' - The brand of the model.
* - 'model' - The name of the model.
* - 'variant' - The variant of the model.
* - 'parts' - The parts of the customized model.
* - 'initials' - The value for the initials of the personalized model.
* - 'engraving' - The value for the engraving value of the personalized model.
* - 'initialsExtra' - The value for the initials extra of the personalized model.
* - 'gender' - The gender of the customized model.
* - 'size' - The native size of the customized model.
* - 'pending' - If the production order is to be imported at the pending, so it has to be confirmed.
* - 'notify' - Mark order to trigger notification after creation.
* - 'productId' - The product's unique identification.
* - 'currency' - The 'ISO 4217' currency code in which the order has been sold.
* - 'country' - The 'ISO 3166-2' country code where the order has been placed.
* - 'meta' - Complementary information to be added, as a key:value list (ie: '['key1:value1', 'key2:value2']).
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} Resulting information for the callback execution.
*/
ripe.Ripe.prototype.importOrder = function(ffOrderId, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
options = this._importOrder(ffOrderId, options);
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Imports a production order to RIPE Core.
*
* @param {Number} ffOrderId The e-commerce order identifier.
* @param {Object} options An object with options, such as:
* - 'brand' - The brand of the model.
* - 'model' - The name of the model.
* - 'variant' - The variant of the model.
* - 'parts' - The parts of the customized model.
* - 'initials' - The value for the initials of the personalized model.
* - 'engraving' - The value for the engraving value of the personalized model.
* - 'initialsExtra' - The value for the initials extra of the personalized model.
* - 'gender' - The gender of the customized model.
* - 'size' - The native size of the customized model.
* - 'pending' - If the production order is to be imported at the pending, so it has to be confirmed.
* - 'notify' - Mark order to trigger notification after creation.
* - 'productId' - The product's unique identification.
* - 'currency' - The 'ISO 4217' currency code in which the order has been sold.
* - 'country' - The 'ISO 3166-2' country code where the order has been placed.
* - 'meta' - Complementary information to be added, as a key:value list (ie: '['key1:value1', 'key2:value2']).
* @returns {Promise} The production order's data.
*/
ripe.Ripe.prototype.importOrderP = function(ffOrderId, options) {
return new Promise((resolve, reject) => {
this.importOrder(ffOrderId, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Imports a production order to RIPE Core.
* Simplified version accepting JSON payload and resolving defaults.
*
* @param {Object} order The order payload.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} The XMLHttpRequest instance of the API request.
*/
ripe.Ripe.prototype.importOrderSimple = function(order, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/import_simple`;
options = Object.assign(options, {
url: url,
method: "POST",
auth: true,
dataJ: order
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Imports a production order to RIPE Core.
* Simplified version accepting JSON payload and resolving defaults.
*
* @param {Object} order The order payload.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The imported order.
*/
ripe.Ripe.prototype.importOrderSimpleP = function(order, options) {
return new Promise((resolve, reject) => {
this.importOrderSimple(order, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Setups a pre-customization on RIPE Core.
*
* @param {Number} ffId The concrete identifier of the pre-customization,
* may represent just an entry point for a pre-customized product (used for mapping).
* @param {Object} options An object with options, such as:
* - 'brand' - the brand of the model.
* - 'model' - the name of the model.
* - 'variant' - the variant of the model.
* - 'parts' - The parts of the customized model.
* - 'initials' - The value for the initials of the personalized model.
* - 'engraving' - The value for the engraving value of the personalized model.
* - 'gender' - The gender of the customized model.
* - 'size' - The native size of the customized model.
* - 'product_id' - The product identifier of the base product that is used for pre-customization mapping.
* - 'notify' - Mark pre-customization to trigger notification after creation.
* - 'meta' - Complementary information to be added, as a key:value list (ie: '['key1:value1', 'key2:value2']).
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} Resulting information for the callback execution.
*/
ripe.Ripe.prototype.precustomizationOrder = function(ffId, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
options = this._precustomizationOrder(ffId, options);
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Setups a pre-customization on RIPE Core.
*
* @param {Number} ffId The concrete identifier of the pre-customization,
* may represent just an entry point for a pre-customized product (used for mapping).
* @param {Object} options An object with options, such as:
* - 'brand' - The brand of the model.
* - 'model' - The name of the model.
* - 'variant' - The variant of the model.
* - 'parts' - The parts of the customized model.
* - 'initials' - The value for the initials of the personalized model.
* - 'engraving' - The value for the engraving value of the personalized model.
* - 'gender' - The gender of the customized model.
* - 'size' - The native size of the customized model.
* - 'productId' - The product identifier of the base product that is used for pre-customization mapping.
* - 'notify' - Mark pre-customization to trigger notification after creation.
* - 'meta' - Complementary information to be added, as a key:value list (ie: '['key1:value1', 'key2:value2']).
* @returns {Promise} The production order's data.
*/
ripe.Ripe.prototype.precustomizationOrderP = function(ffId, options, callback) {
return new Promise((resolve, reject) => {
this.precustomizationOrder(ffId, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* @ignore
*/
ripe.Ripe.prototype.setOrderStatus = function(number, status, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/${status}`;
options = Object.assign(options, {
url: url,
auth: true,
method: "PUT"
});
options.params = options.params || {};
if (options.justification !== undefined) options.params.justification = options.justification;
if (options.strict !== undefined) options.params.strict = options.strict;
if (options.notify !== undefined) options.params.notify = options.notify ? "1" : "0";
if (options.transitions !== undefined) options.params.transitions = options.transitions;
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Gets the order subscription status for the session user.
*
* @param {Number} number The number of the order to get the subscription status.
* @returns {XMLHttpRequest} The order subscription status.
*/
ripe.Ripe.prototype.getOrderSubscription = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/subscription`;
options = Object.assign(options, {
url: url,
auth: true,
cached: false,
method: "GET"
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Gets the order subscription status for the session user.
*
* @param {Number} number The number of the order to get the subscription status.
* @returns {Promise} The order subscription status.
*/
ripe.Ripe.prototype.getOrderSubscriptionP = function(number, options) {
return new Promise((resolve, reject) => {
this.getOrderSubscription(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Adds the email of the user in session to subscriber list of an order.
*
* @param {Number} number The number of the order to subscribe.
* @returns {XMLHttpRequest} The order subscription status.
*/
ripe.Ripe.prototype.subscribeOrder = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/subscription`;
options = Object.assign(options, {
url: url,
auth: true,
method: "PUT"
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Adds the email of the user in session to subscriber list of an order.
*
* @param {Number} number The number of the order to subscribe.
* @returns {Promise} The order subscription status.
*/
ripe.Ripe.prototype.subscribeOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.subscribeOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Removes email of the user in session from the subscriber list of an order.
*
* @param {Number} number The number of the order to unsubscribe.
* @returns {XMLHttpRequest} The order subscription status.
*/
ripe.Ripe.prototype.unsubscribeOrder = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/subscription`;
options = Object.assign(options, {
url: url,
auth: true,
method: "DELETE"
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Removes email of the user in session from the subscriber list of an order.
*
* @param {Number} number The number of the order to unsubscribe.
* @returns {Promise} The order subscription status.
*/
ripe.Ripe.prototype.unsubscribeOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.unsubscribeOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Marks an order as having been touched by the user that
* is currently authenticated.
*
* @param {Number} number The number of the order to touch.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} Resulting information for the callback execution.
*/
ripe.Ripe.prototype.touchOrder = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/touch`;
options = Object.assign(options, {
url: url,
auth: true,
method: "PUT"
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Marks an order as having been touched by the user that
* is currently authenticated.
*
* @param {Number} number The number of the order to touch.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The order.
*/
ripe.Ripe.prototype.touchOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.touchOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Updates the tag for an order and, by default, activates it as well.
*
* @param {Number} number The number of the order to update.
* @param {String} identifier The unique identifier of the tag.
* @param {String} type The tag type.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} Resulting information for the callback execution.
*/
ripe.Ripe.prototype.updateTagOrder = function(number, identifier, type, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/tag`;
options = Object.assign(options, {
url: url,
auth: true,
method: "PUT"
});
options.params = options.params || {};
options.params.identifier = identifier;
options.params.type = type;
if (options.activate !== undefined) options.params.activate = options.activate;
if (options.tenantId !== undefined) options.params.tenant_id = options.tenantId;
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Updates the tag for an order and, by default, activates it as well.
*
* @param {Number} number The number of the order to update.
* @param {String} identifier The unique identifier of the tag.
* @param {String} type The tag type.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The order.
*/
ripe.Ripe.prototype.updateTagOrderP = function(number, identifier, type, options) {
return new Promise((resolve, reject) => {
this.updateTagOrder(number, identifier, type, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Deletes the tag for an order and, by default, deactivates it as well.
*
* @param {Number} number The number of the order with the tag to delete.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} Resulting information for the callback execution.
*/
ripe.Ripe.prototype.deleteTagOrder = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/tag`;
options = Object.assign(options, {
url: url,
auth: true,
method: "DELETE"
});
options.params = options.params || {};
if (options.deactivate !== undefined) options.params.deactivate = options.deactivate;
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Deletes the tag for an order and, by default, deactivates it as well.
*
* @param {Number} number The number of the order with the tag to delete.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The order.
*/
ripe.Ripe.prototype.deleteTagOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.deleteTagOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Activates the tag for an order, making the tag ready
* to be used by external environment.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} Resulting information for the callback execution.
*/
ripe.Ripe.prototype.activateTagOrder = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/tag/activate`;
options = Object.assign(options, {
url: url,
auth: true,
method: "PUT"
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Activates the tag for an order, making the tag ready
* to be used by external environment.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The order.
*/
ripe.Ripe.prototype.activateTagOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.activateTagOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* Deactivates the tag for an order.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @param {Function} callback Function with the result of the request.
* @returns {XMLHttpRequest} Resulting information for the callback execution.
*/
ripe.Ripe.prototype.deactivateTagOrder = function(number, options, callback) {
callback = typeof options === "function" ? options : callback;
options = typeof options === "function" || options === undefined ? {} : options;
const url = `${this.url}orders/${number}/tag/deactivate`;
options = Object.assign(options, {
url: url,
auth: true,
method: "PUT"
});
options = this._build(options);
return this._cacheURL(options.url, options, callback);
};
/**
* Deactivates the tag for an order.
*
* @param {Number} number The number of the order to update.
* @param {Object} options An object of options to configure the request.
* @returns {Promise} The order.
*/
ripe.Ripe.prototype.deactivateTagOrderP = function(number, options) {
return new Promise((resolve, reject) => {
this.deactivateTagOrder(number, options, (result, isValid, request) => {
isValid ? resolve(result) : reject(new ripe.RemoteError(request, null, result));
});
});
};
/**
* @ignore
*/
ripe.Ripe.prototype._getOrderReportURL = function(number, key, options) {
options = options === undefined ? {} : options;
const url = `${this.url}orders/${number}/report`;
const params = options.params || {};
params.key = key;
options = Object.assign(options, {
url: url,
params: params
});
return options.url + "?" + this._buildQuery(options.params);
};
/**
* @ignore
*/
ripe.Ripe.prototype._getOrderReportPDFURL = function(number, key, options) {
options = options === undefined ? {} : options;
const url = `${this.url}orders/${number}/report.pdf`;
const params = options.params || {};
params.key = key;
options = Object.assign(options, {
url: url,
params: params
});
return options.url + "?" + this._buildQuery(options.params);
};
/**
* @ignore
*/
ripe.Ripe.prototype._getOrderReportPNGURL = function(number, key, options) {
options = options === undefined ? {} : options;
const url = `${this.url}orders/${number}/report.png`;
const params = options.params || {};
params.key = key;
options = Object.assign(options, {
url: url,
params: params
});
return options.url + "?" + this._buildQuery(options.params);
};
/**
* @ignore
*/
ripe.Ripe.prototype._getOrderImageURL = function(number, key, options) {
options = options === undefined ? {} : options;
const url = `${this.url}orders/${number}/image`;
const params = options.params || {};
params.key = key;
options = Object.assign(options, {
url: url,
params: params
});
return options.url + "?" + this._buildQuery(options.params);
};
/**
* @ignore
* @see {link https://docs.platforme.com/#order-endpoints-import}
*/
ripe.Ripe.prototype._importOrder = function(ffOrderId, options = {}) {
const dku = options.dku === undefined ? null : options.dku;
const type = options.type === undefined ? null : options.type;
const quantity = options.quantity === undefined ? null : options.quantity;
const brand = options.brand === undefined ? this.brand : options.brand;
const factory = options.factory === undefined ? null : options.factory;
const domain = options.domain === undefined ? null : options.domain;
const sku = options.sku === undefined ? null : options.sku;
const model = options.model === undefined ? this.model : options.model;
const variant = options.variant === undefined ? this.variant : options.variant;
const parts = options.parts === undefined ? this.parts : options.parts;
const initials = options.initials === undefined ? this.initials : options.initials;
const engraving = options.engraving === undefined ? this.engraving : options.engraving;
const initialsExtra =
options.initials_extra === undefined && options.initialsExtra === undefined
? this.initialsExtra
: options.initialsExtra || options.initials_extra;
const gender = options.gender === undefined ? null : options.gender;
const scale = options.scale === undefined ? null : options.scale;
const size = options.size === undefined ? null : options.size;
const pending = options.pending === undefined ? null : options.pending;
const notify = options.notify === undefined ? null : options.notify;
const productId =
options.product_id === undefined && options.productId === undefined
? null
: options.product_id || options.productId;
const country = options.country === undefined ? null : options.country;
const price = options.price === undefined ? null : options.price;
const currency = options.currency === undefined ? null : options.currency;
const deliveryTime = options.deliveryTime === undefined ? null : options.deliveryTime;
const meta = options.meta === undefined ? null : options.meta;
const description = options.description === undefined ? null : options.description;
const shippingInfo = options.shippingInfo === undefined ? null : options.shippingInfo;
const invoicingInfo = options.invoicingInfo === undefined ? null : options.invoicingInfo;
const notes = options.notes === undefined ? null : options.notes;
const images = options.images === undefined ? null : options.images;
const safe = options.safe === undefined ? null : options.safe ? "1" : "0";
const imagesDefault =
options.imagesDefault === undefined ? null : options.imagesDefault ? 1 : 0;
const url = `${this.url}orders/import`;
const contents = {};
if (brand) contents.brand = brand;
if (model) contents.model = model;
if (Object.keys(parts).length > 0) contents.parts = parts;
if (size) contents.size = size;
if (factory) contents.factory = factory;
if (domain) contents.domain = domain;
if (sku) contents.sku = sku;
if (variant) contents.variant = variant;
if (productId) contents.product_id = productId;
if (gender) contents.gender = gender;
if (scale) contents.scale = scale;
if (price) contents.price = price;
if (Object.keys(initialsExtra).length > 0) {
contents.initials_extra = initialsExtra;
} else if (initials && engraving) {
contents.initials = initials;
contents.engraving = engraving;
}
if (deliveryTime) contents.delivery_time = deliveryTime;
if (images) contents.images = images;
if (description) contents.description = description;
if (shippingInfo) contents.shipping_info = shippingInfo;
if (invoicingInfo) contents.invoicing_info = invoicingInfo;
if (imagesDefault !== null) contents.images_default = imagesDefault;
const params = { ff_order_id: ffOrderId };
if (Object.keys(contents).length > 0) params.contents = JSON.stringify(contents);
if (dku) params.dku = dku;
if (type) params.type = type;
if (quantity) params.quantity = quantity;
if (country) params.country = country;
if (currency) params.currency = currency;
if (meta) params.meta = meta;
if (notes) params.notes = notes;
if (notify) params.notify = notify;
if (pending) params.pending = pending;
if (safe) params.safe = safe;
return Object.assign(options, {
url: url,
method: "POST",
params: params,
auth: true
});
};
/**
* @ignore
*/
ripe.Ripe.prototype._precustomizationOrder = function(ffId, options = {}) {
const brand = options.brand === undefined ? this.brand : options.brand;
const model = options.model === undefined ? this.model : options.model;
const variant = options.variant === undefined ? this.variant : options.variant;
const parts = options.parts === undefined ? this.parts : options.parts;
const initials = options.initials === undefined ? this.initials : options.initials;
const engraving = options.engraving === undefined ? this.engraving : options.engraving;
const initialsExtra =
options.initials_extra === undefined && options.initialsExtra === undefined
? this.initialsExtra
: options.initialsExtra || options.initials_extra;
const gender = options.gender === undefined ? null : options.gender;
const size = options.size === undefined ? null : options.size;
const productId =
options.product_id === undefined && options.productId === undefined
? null
: options.product_id || options.productId;
const meta = options.meta === undefined ? null : options.meta;
const url = `${this.url}orders/pre_customization`;
const contents = {
brand: brand,
model: model,
parts: parts,
size: size,
product_id: productId
};
if (variant) contents.variant = variant;
if (gender) contents.gender = gender;
if (Object.keys(initialsExtra).length > 0) {
contents.initials_extra = initialsExtra;
} else if (initials && engraving) {
contents.initials = initials;
contents.engraving = engraving;
}
const params = {
ff_id: ffId,
contents: JSON.stringify(contents)
};
if (meta) params.meta = meta;
return Object.assign(options, {
url: url,
method: "POST",
params: params,
auth: true
});
};