Ripe

(static) fromStructure(structure, safe, options)

Builds a new Ripe instance using the provided normalized configuration structure as the basis for its configuration.

Source:

base/ripe.js, line 53

Parameters:

Name	Type	Description
`structure`	`Object`	The normalized configuration structure that is going to be used in the initialization of the new Ripe instance.
`safe`	`Boolean`	If the safe object mode creation should be used.
`options`	`Object`	The extra options to be used in the initialization process of the Ripe instance.

_buildProfiles(engraving, profiles, context, sep) → {Array}

Builds the complete set of profiles to be used in the initials composition for the provided normalized engraving string and taking into account the provided context.

Source:

base/ripe.js, line 2091

Parameters:

Name	Type	Description
`engraving`	`String`	The normalized engraving string that is going to be used in the profile generation (should comply with the naming standard).
`profiles`	`Array`	The extra sequence containing multiple values to be added to the parsed engraving ones and be used in the initials generation of the combination for the profiles generation.
`context`	`Array`	The context list that be added to the profile complete name on the profile generation and, in the last stage of the generation, to the beginning of the final profiles list.
`sep`	`String`	String that is going to be used as the separator between the base profile string and the context.

Returns:

Type:: Array

The sequence of generated profiles properly ordered from the most concrete (more specific) to the least concrete (more general).

_errorHandler(error)

The default fallback error handler to be used for every single detached async context.

Source:

base/ripe.js, line 1894

Parameters:

Name	Type	Description
`error`	`Error`	The error that is going to be handled.

_generateProfiles(group, viewport) → {Array}

Generates a set of extra profiles according to the provided group and viewport.

Source:

base/ripe.js, line 2050

Parameters:

Name	Type	Description
`group`	`String`	The name of the "initials" group, to which the profiles are going to be generated.
`viewport`	`String`	The name of the viewport, to which the profiles are going to be generated.

Returns:

Type:: Array

The profiles definition list that was generated from the provided group and viewport "input".

_getVideoOptions(options) → {Object}

Returns the required options for requesting a video of a model's customization.

Source:

base/api.js, line 866

Parameters:

Name	Type	Description
`options`	`Object`	An object containing the information required to get a video for a model, more specifically `brand`, `model`, `name` of the video and `p` containing the model's customization.

Returns:

Type:: Object

The options for requesting a video.

_getVideoThumbnailOptions(options) → {Object}

Returns the required options for requesting a thumbnail image of a model's customization.

Source:

base/api.js, line 895

Parameters:

Name	Type	Description
`options`	`Object`	An object containing the information required to get the thumbnail of a video for a model, more specifically `brand`, `model`, `name` of the video and `p` containing the model's customization.

Returns:

Type:: Object

The options for requesting a thumbnail image of a video.

_getVideoThumbnailURL(options) → {String}

Returns the URL for the thumbnail image of a video based on the given name and the provided customization.

Source:

base/api.js, line 1292

Parameters:

Name	Type	Description
`options`	`Object`	An object containing the information required to get a video for a model, more specifically `brand`, `model`, `name` of the video and `p` containing the model's customization.

Returns:

Type:: String

The URL to the video thumbnail image.

_getVideoURL(options) → {String}

Returns the URL for a video based on the given name and the provided customization.

Source:

base/api.js, line 1278

Parameters:

Name	Type	Description
`options`	`Object`	An object containing the information required to get a video for a model, more specifically `brand`, `model`, `name` of the video and `p` containing the model's customization.

Returns:

Type:: String

The URL to the video.

_handleCtx(result)

Handles the changes in the provided resulting context (ctx) changing the internal state and triggering relevant events.

Source:

base/ripe.js, line 1910

Parameters:

Name	Type	Description
`result`	`Object`	The resulting ctx object that is going to be used in the changing of the internal state.

_initialsBuilder(initials, engraving, group, viewport, context) → {Object}

Generates all profiles based on the provided engraving string and the contexts provided. This is a base implementation which should be overridden if any specific behaviour is meant to be provided for a specific context (model).

Source:

base/ripe.js, line 2023

Parameters:

Name	Type	Description
`initials`	`String`	The initials string of the personalization.
`engraving`	`String`	The normalized engraving string that is going to be used in the profile generation (should comply with the naming standard).
`group`	`String`	The initials group that is going to be used to build the profiles.
`viewport`	`String`	The viewport that is going to be used to build the profiles.
`context`	`Array`	The context list that is used to permutate all the profiles to apply specific views to the initials image.

Returns:

Type:: Object

An object containing the initials of the personalization and the sequence of generated profiles properly ordered from the most concrete (more specific) to the least concrete (more general).

_loadInitialsBuilder()

Loads the initials builder logic from the remote data source. This is done by loading a remote Javascript file that should contain the `initialsBuilder` method should be present in the base object of such Javascript file.

Source:

base/ripe.js, line 1987

_toChoices(loadedConfig) → {Object}

Builds the choices structure that is going to control the state for parts materials and colors under the current customization session.

Source:

base/ripe.js, line 1949

Parameters:

Name	Type	Description
`loadedConfig`	`Object`	The configuration structure that has just been loaded.

Returns:

Type:: Object

The state object that can be used to control the state of parts, materials and colors.

accessPointShipment(number, options, callback) → {XMLHttpRequest}

Sets the shipment status to 'access_point'.

Source:

api/shipment.js, line 431

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

accessPointShipmentP(number, options, callback) → {Promise}

Sets the shipment status to 'access_point'.

Source:

api/shipment.js, line 443

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The shipment with the updated status.

accountMe(options, callback) → {XMLHttpRequest}

Retrieves the complete set of account data to the current session.

Source:

api/account.js, line 11

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

accountMeP(options, callback) → {Promise}

Retrieves the complete set of account data to the current session.

Source:

api/account.js, line 31

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

Resulting information for the callback execution.

activateTagOrder(number, options, callback) → {XMLHttpRequest}

Activates the tag for an order, making the tag ready to be used by external environment.

Source:

api/order.js, line 2285

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

activateTagOrderP(number, options) → {Promise}

Activates the tag for an order, making the tag ready to be used by external environment.

Source:

api/order.js, line 2306

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The order.

addBundle(bundle, locale)

Adds a new bundle object to the currently set of registered bundles for the the given locale. This registration operation is global and will affect any user of the RIPE SDK package on the current VM.

Source:

base/logic.js, line 19

Parameters:

Name	Type	Description
`bundle`	`Object`	The locale strings bundle that is going to be globally registered.
`locale`	`String`	The ISO 639-1 based locale identifier in the underscore based form to be used in registration.

addPlugin(plugin)

Registers a plugin to this Ripe instance.

Source:

base/ripe.js, line 1582

Parameters:

Name	Type	Description
`plugin`	`Plugin`	The plugin to be registered.

attachmentOrder(number, attachmentId, options, callback) → {XMLHttpRequest}

Returns the attachment of an order requested by ID.

Source:

api/order.js, line 251

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`attachmentId`	`Number`	The ID of the attachment of the order to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

attachmentOrderP(number, attachmentId, options, callback) → {Promise}

Returns the attachment of an order requested by ID.

Source:

api/order.js, line 274

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`attachmentId`	`Number`	The ID of the attachment of the order to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The attachment file of an order requested by ID.

attachmentsBulkOrder(number, options, callback) → {XMLHttpRequest}

Returns all the attachments of a bulk order.

Source:

api/bulk-order.js, line 450

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

attachmentsBulkOrderP(number, options, callback) → {Promise}

Returns all the attachments of a bulk order.

Source:

api/bulk-order.js, line 471

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The attachments of the bulk order.

attachmentShipment(number, attachmentId, options, callback) → {XMLHttpRequest}

Returns the attachment of a shipment requested by ID.

Source:

api/shipment.js, line 623

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to find by.
`attachmentId`	`Number`	The ID of the attachment of the shipment to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

attachmentShipmentP(number, attachmentId, options, callback) → {Promise}

Returns the attachment of a shipment requested by ID.

Source:

api/shipment.js, line 646

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to find by.
`attachmentId`	`Number`	The ID of the attachment of the shipment to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The attachment file of an shipment requested by ID.

attachmentsOrder(number, options, callback) → {XMLHttpRequest}

Returns all the attachments of an order.

Source:

api/order.js, line 171

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

attachmentsOrderP(number, options) → {Promise}

Returns all the attachments of an order.

Source:

api/order.js, line 191

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

An object containing all the attachments of an order.

attachmentsShipment(number, options, callback) → {XMLHttpRequest}

Returns all the attachments of a shipment.

Source:

api/shipment.js, line 543

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

attachmentsShipmentP(number, options) → {Promise}

Returns all the attachments of a shipment.

Source:

api/shipment.js, line 563

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to find by.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

An object containing all the attachments of a shipment.

auth(username, password, options, callback) → {XMLHttpRequest}

Responsible for the beginning of the (username, password) based authentication process.

Source:

base/auth.js, line 70

Parameters:

Name	Type	Description
`username`	`String`	The username to be authenticated.
`password`	`String`	The username's password.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

authAdmin(username, password, options, callback) → {XMLHttpRequest}

Responsible for the beginning of the (username, password) based authentication process. This method uses the admin back-end instead of the RIPE Core simple authentication system.

Source:

base/auth.js, line 113

Parameters:

Name	Type	Description
`username`	`String`	The username to be authenticated.
`password`	`String`	The username's password.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

authAdminP(username, password, options) → {Promise}

Responsible for the beginning of the (username, password) based authentication process. This method uses the admin back-end instead of the RIPE Core simple authentication system.

Source:

base/auth.js, line 140

Parameters:

Name	Type	Description
`username`	`String`	The username to be authenticated.
`password`	`String`	The username's password.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The authentication data.

authKey(key, options, callback) → {XMLHttpRequest}

Responsible for the beginning of the key based authentication process. This method uses the admin back-end instead of the RIPE Core simple authentication system.

Source:

base/auth.js, line 197

Parameters:

Name	Type	Description
`key`	`String`	The key to authenticate with.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

authKeyP(key, options, callback) → {Promise}

Responsible for the beginning of the key based authentication process. This method uses the admin back-end instead of the RIPE Core simple authentication system.

Source:

base/auth.js, line 219

Parameters:

Name	Type	Description
`key`	`String`	The key to authenticate with.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The authenticated account data.

authP(username, password, options) → {Promise}

Responsible for the beginning of the (username, password) based authentication process.

Source:

base/auth.js, line 92

Parameters:

Name	Type	Description
`username`	`String`	The username to be authenticated.
`password`	`String`	The username's password.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The authentication data.

authPid(token, options, callback) → {XMLHttpRequest}

Responsible for the beginning of the token based authentication process.

Source:

base/auth.js, line 156

Parameters:

Name	Type	Description
`token`	`String`	The authentication token.
`options`	`Object`	An object of options to configure the authentication.
`callback`	`function`	Function with the result of the authentication.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

authPidP(token, options) → {Promise}

Responsible for the beginning of the token based authentication process.

Source:

base/auth.js, line 178

Parameters:

Name	Type	Description
`token`	`String`	The authentication token.
`options`	`Object`	An object of options to configure the authentication.

Returns:

Type:: Promise

The authentication data.

bindConfigurator(element, options) → {Configurator}

Binds an Configurator to this Ripe instance.

Source:

base/ripe.js, line 1212

Parameters:

Name	Type	Description
`element`	`Configurator`	The Configurator to be used by the Ripe instance.
`options`	`Object`	An Object with options to configure the Configurator instance.

Returns:

Type:: Configurator

The Configurator instance created.

bindConfiguratorCsr(element, options) → {Configurator}

Binds an PRC Configurator to this Ripe instance.

Source:

visual/configurator-csr.js, line 14

Parameters:

Name	Type	Description
`element`	`Configurator`	The PRC Configurator to be used by the Ripe instance.
`options`	`Object`	An Object with options to configure the Configurator instance.

Returns:

Type:: Configurator

The Configurator instance created.

bindConfiguratorPrc(element, options) → {Configurator}

Binds an PRC Configurator to this Ripe instance.

Source:

visual/configurator-prc.js, line 12

Parameters:

Name	Type	Description
`element`	`Configurator`	The PRC Configurator to be used by the Ripe instance.
`options`	`Object`	An Object with options to configure the Configurator instance.

Returns:

Type:: Configurator

The Configurator instance created.

bindImage(element, options) → {Image}

Binds an Image to this Ripe instance.

Source:

base/ripe.js, line 1178

Parameters:

Name	Type	Description
`element`	`Image`	The Image to be used by the Ripe instance.
`options`	`Object`	An Object with options to configure the Image instance.

Returns:

Type:: Image

The Image instance created.

bindInteractable(element, options) → {Interactable}

Binds an Interactable to this Ripe instance.

Source:

base/ripe.js, line 1230

Parameters:

Name	Type	Description
`element`	`Interactable`	The Interactable to be used by the Ripe instance.
`options`	`Object`	An Object with options to configure the Interactable instance.

Returns:

Type:: Interactable

The Interactable instance created.

bindVideoThumbnail(element, options) → {Image}

Binds a video thumbnail Image to this Ripe instance.

Source:

base/ripe.js, line 1191

Parameters:

Name	Type	Description
`element`	`Image`	The Image to be used by the Ripe instance.
`options`	`Object`	An Object with options to configure the Image instance.

Returns:

Type:: Image

The Image instance created.

blockBulkOrder(number, options, callback) → {XMLHttpRequest}

Sets the bulk order status to 'blocked'.

Source:

api/bulk-order.js, line 305

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

blockBulkOrderP(number, options, callback) → {Promise}

Sets the bulk order status to 'blocked'.

Source:

api/bulk-order.js, line 317

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The update bulk order.

blockOrder(number, options, callback) → {XMLHttpRequest}

Sets the order status to 'blocked'.

Source:

api/order.js, line 1413

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

blockOrderP(number, options, callback) → {Promise}

Sets the order status to 'blocked'.

Source:

api/order.js, line 1425

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The order with the updated status.

blockShipment(number, options, callback) → {XMLHttpRequest}

Sets the shipment status to 'blocked'.

Source:

api/shipment.js, line 403

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

blockShipmentP(number, options, callback) → {Promise}

Sets the shipment status to 'blocked'.

Source:

api/shipment.js, line 415

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The shipment with the updated status.

cancelBulkOrder(number, options, callback) → {XMLHttpRequest}

Sets the bulk order status to 'cancel'.

Source:

api/bulk-order.js, line 389

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

cancelBulkOrderP(number, options, callback) → {Promise}

Sets the bulk order status to 'cancel'.

Source:

api/bulk-order.js, line 401

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The update bulk order.

cancelOrder(number, options, callback) → {XMLHttpRequest}

Sets the order status to 'cancel'.

Source:

api/order.js, line 1497

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

cancelOrderP(number, options, callback) → {Promise}

Sets the order status to 'cancel'.

Source:

api/order.js, line 1509

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The order with the updated status.

cancelShipment(number, options, callback) → {XMLHttpRequest}

Sets the shipment status to 'canceled'.

Source:

api/shipment.js, line 515

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

cancelShipmentP(number, options, callback) → {Promise}

Sets the shipment status to 'canceled'.

Source:

api/shipment.js, line 527

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The shipment with the updated status.

canRedo() → {Boolean}

Indicates if there are part changes to redo.

Source:

base/ripe.js, line 1533

Returns:

Type:: Boolean

If there are changes to reapply pending in the history stack.

canUndo() → {Boolean}

Indicates if there are part changes to undo.

Source:

base/ripe.js, line 1523

Returns:

Type:: Boolean

If there are changes to reverse in the current parts history stack.

chatCreateLineOrder(number, contents, options, callback) → {XMLHttpRequest}

Adds a new general chat line message to a specific order.

Source:

api/order.js, line 712

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order where the chat line message will be added.
`contents`	`Object`	The contents of the chat message.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

chatCreateLineOrderP(number, contents, options) → {Promise}

Adds a new general chat line message to a specific order.

Source:

api/order.js, line 736

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order where the chat line message will be added.
`contents`	`Object`	The contents of the chat message.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

An object containing the chat lines for the specific order.

chatLinesCountOrder(number, options, callback) → {XMLHttpRequest}

Returns the number of general chat lines of an order, unrelated to any state.

Source:

api/order.js, line 675

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to get the number of chat lines from.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

chatLinesCountOrderP(number, options) → {Promise}

Returns the number of general chat lines of an order, unrelated to any state.

Source:

api/order.js, line 695

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to get the number of chat lines from.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The number of order chat's lines.

chatLinesOrder(number, options, callback) → {XMLHttpRequest}

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.

Source:

api/order.js, line 634

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to get the chat lines from.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

chatLinesOrderP(number, options) → {Promise}

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.

Source:

api/order.js, line 659

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to get the chat lines from.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The order chat's lines.

chatOrder(number, options, callback) → {XMLHttpRequest}

Returns the general chat of an order, unrelated to any state.

Source:

api/order.js, line 593

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to get the chat from.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

chatOrderP(number, options) → {Promise}

Returns the general chat of an order, unrelated to any state.

Source:

api/order.js, line 613

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to get the chat from.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The order's chat.

config(brand, model, options)

Sets the model to be customised by providing both the brand and the model for the update.

Source:

base/ripe.js, line 357

Parameters:

Name	Type	Description
`brand`	`String`	The brand of the model.
`model`	`String`	The name of the model.
`options`	`Object`	An object with the options to configure the Ripe instance, such as: - 'parts' - The initial parts of the model. - 'initials' - The initial value for the initials of the model. - 'engraving' - The initial engraving value of the model. - 'initialsExtra' - The initial value for the initials extra. - 'country' - The country where the model will be sold. - 'currency' - The currency that should be used to calculate the price. - 'locale' - The locale to be used by default when localizing values. - 'flag' - A specific attribute of the model. - 'remoteCalls' - If the remote calls (eg: 'on_config') should be called in the middle of configuration. - 'useBundles' - If the bundles should be loaded during initial loading. - 'useDefaults' - If the default parts of the model should be used when no initials parts are set. - 'useCombinations' - If the combinations should be loaded as part of the initial RIPE loading. - 'usePrice' - If the price should be automatically retrieved whenever there is a customization change. - 'useDiag' - If the diagnostics module should be used. - 'safe' - If the call should 'await' for all the composing operations before returning or if instead should allow operations to be performed in a parallel and detached manner.

configDku(dku, options, callback) → {XMLHttpRequest}

Resolves the provided DKU value into a more structured set of model, brand, parts, etc. so that it can be used under RIPE.

Source:

api/config.js, line 80

Parameters:

Name	Type	Description
`dku`	`String`	The DKU identifier to be used in the resolution.
`options`	`Object`	An object of options to configure the request, such as: - 'url' - The base URL.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

configDkuP(dku, options, callback)

Resolves the provided DKU value into a more structured set of mode, brand, parts, etc. so that it can be used under RIPE.

Source:

api/config.js, line 99

Parameters:

Name	Type	Description
`dku`	`String`	The DKU identifier to be used in the resolution.
`options`	`Object`	An object of options to configure the request, such as: - 'url' - The base URL.
`callback`	`function`	Function with the result of the request. s {Promise} The model's configuration data.

configGlobal(options) → {XMLHttpRequest}

Gets the global configuration object from the RIPE server (admin endpoint).

Source:

api/config.js, line 10

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

configGlobalP(options)

Gets the global configuration object from the RIPE server (admin endpoint).

Source:

api/config.js, line 28

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

configInfo(options, callback) → {XMLHttpRequest}

Resolves the RIPE configuration options (includes DKU) from the provided set of options or in alternative the current Ripe Instance state.

Source:

api/config.js, line 45

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request, such as: - 'url' - The base URL.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

configInfoP(options, callback)

Resolves the RIPE configuration options (includes DKU) from the provided set of options or in alternative the current Ripe Instance state.

Source:

api/config.js, line 62

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request, such as: - 'url' - The base URL.
`callback`	`function`	Function with the result of the request. s {Promise} The model's configuration data.

configResolve(productId, options, callback) → {XMLHttpRequest}

Gets the configuration of a product identified by its unique product ID.

Source:

api/config.js, line 211

Parameters:

Name	Type	Description
`productId`	`String`	The identifier of the product to be resolved.
`options`	`Object`	An object of options to configure the request, such as: - 'url' - The base URL.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

configResolveP(productId, options) → {Promise}

Gets the configuration of a product identified by its unique product ID.

Source:

api/config.js, line 228

Parameters:

Name	Type	Description
`productId`	`String`	The identifier of the product to be resolved.
`options`	`Object`	An object of options to configure the request, such as: - 'url' - The base URL.

Returns:

Type:: Promise

The model's configuration data.

configResolveSku(domain, options, callback) → {XMLHttpRequest}

Resolves a customization to a mapped SKU.

Source:

api/config.js, line 170

Parameters:

Name	Type	Description
`domain`	`String`	The SKU domain (falls back to brand value).
`options`	`Object`	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. - 'productId' - The product's unique identification.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

configResolveSkuP(domain, options, callback) → {Promise}

Resolves a customization to a mapped SKU.

Source:

api/config.js, line 194

Parameters:

Name	Type	Description
`domain`	`String`	The SKU domain (falls back to brand value).
`options`	`Object`	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. - 'productId' - The product's unique identification.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The model's configuration data.

configSku(sku, domain, options, callback) → {XMLHttpRequest}

Resolves the provided SKU value into a more structured set of model, brand, parts, etc. so that it can be used under RIPE.

Source:

api/config.js, line 118

Parameters:

Name	Type	Description
`sku`	`String`	The SKU identifier to be used in the resolution.
`domain`	`String`	The domain to be used in the resolution.
`options`	`Object`	An object of options to configure the request, such as: - 'url' - The base URL.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

configSkuP(sku, domain, options, callback)

Resolves the provided SKU value into a more structured set of mode, brand, parts, etc. so that it can be used under RIPE.

Source:

api/config.js, line 146

Parameters:

Name	Type	Description
`sku`	`String`	The SKU identifier to be used in the resolution.
`domain`	`String`	The domain to be used in the resolution.
`options`	`Object`	An object of options to configure the request, such as: - 'url' - The base URL.
`callback`	`function`	Function with the result of the request. s {Promise} The model's configuration data.

countSkus(options, callback) → {XMLHttpRequest}

Counts the existing SKUs, according to the provided filtering strategy as normalized values.

Source:

api/sku.js, line 330

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request, such as: - 'filters[]' - List of filters that the query will use. - '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.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

countSkusP(options) → {Promise}

Counts the existing SKUs, according to the provided filtering strategy as normalized values.

Source:

api/sku.js, line 350

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The SKUs result count.

createAttachmentBulkOrder(number, options, callback) → {XMLHttpRequest}

Adds attachment files to a bulk order.

Source:

api/bulk-order.js, line 487

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

createAttachmentBulkOrderP(number, options, callback) → {Promise}

Adds attachment files to a bulk order.

Source:

api/bulk-order.js, line 510

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The bulk order with the added attachments.

createAttachmentOrder(number, file, options, callback) → {XMLHttpRequest}

Adds an attachment to an order.

Source:

api/order.js, line 208

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order where the attachment will be added.
`file`	`Object`	The attachment file to be added to the order.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

createAttachmentOrderP(number, file, options, callback) → {Promise}

Adds an attachment to an order.

Source:

api/order.js, line 234

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order where the attachment will be added.
`file`	`Object`	The attachment file to be added to the order.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The attachment added to the order.

createAttachmentShipment(number, file, options, callback) → {XMLHttpRequest}

Adds an attachment to a shipment.

Source:

api/shipment.js, line 580

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment where the attachment will be added.
`file`	`Object`	The attachment file to be added to the shipment.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

createAttachmentShipmentP(number, file, options, callback) → {Promise}

Adds an attachment to a shipment.

Source:

api/shipment.js, line 606

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment where the attachment will be added.
`file`	`Object`	The attachment file to be added to the shipment.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The attachment added to the shipment.

createAvailabilityRule(availabilityRule, options, callback) → {XMLHttpRequest}

Creates an availability rule on RIPE Core.

Source:

api/availability-rule.js, line 48

Parameters:

Name	Type	Description
`availabilityRule`	`Object`	The availability rule data.
`options`	`Object`	An object with options.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

createAvailabilityRuleP(availabilityRule, options) → {Promise}

Creates an availability rule on RIPE Core.

Source:

api/availability-rule.js, line 69

Parameters:

Name	Type	Description
`availabilityRule`	`Object`	The availability rule's data.
`options`	`Object`	An object with options.

Returns:

Type:: Promise

The availability rule's data.

createBulkOrder(number, options, callback) → {XMLHttpRequest}

Sets the bulk order status to 'create'.

Source:

api/bulk-order.js, line 117

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

createBulkOrderP(number, options, callback) → {Promise}

Sets the bulk order status to 'create'.

Source:

api/bulk-order.js, line 129

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The update bulk order.

createCountryGroup(countryGroup, options, callback) → {XMLHttpRequest}

Creates a new country group.

Source:

api/country-group.js, line 56

Parameters:

Name	Type	Description
`countryGroup`	`Object`	An object with information needed to create a country group ex:{name: "Europe 1", currency: "EUR", countries: ["Portugal, Spain, France"]}.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

createCountryGroupP(countryGroup, options) → {Promise}

Creates a new country group.

Source:

api/country-group.js, line 78

Parameters:

Name	Type	Description
`countryGroup`	`Object`	An object with information needed to create a country group ex: {name: "Europe 1", currency: "EUR", countries: ["Portugal, Spain, France"]}.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The country group's data.

createDeviceId(deviceId) → {XMLHttpRequest}

Creates a notify info (if required) for the current user, and adds the provided device ID to the list of device ids in the notify info.

Source:

api/notify-info.js, line 12

Parameters:

Name	Type	Description
`deviceId`	`String`	The device identifier as a plain string to be used in registration.

Returns:

Type:: XMLHttpRequest

The current user's notify info instance.

createDeviceIdP(deviceId) → {Promise}

Creates a notify info (if required) for the current user, and adds the provided device ID to the list of device ids in the notify info.

Source:

api/notify-info.js, line 34

Parameters:

Name	Type	Description
`deviceId`	`String`	The device identifier as a plain string to be used in registration.

Returns:

Type:: Promise

The current user's notify info instance.

createDocumentsShipment(number, options, callback) → {XMLHttpRequest}

Creates mandatory shipping documents for the shipment with the provided number.

Source:

api/shipment.js, line 749

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to create the documents for.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

createDocumentsShipmentP(number, options) → {Promise}

Creates mandatory shipping documents for the shipment with the provided number.

Source:

api/shipment.js, line 769

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to create the documents for.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The contents of the note instance that was created.

createdShipment(number, options, callback) → {XMLHttpRequest}

Sets the shipment status to 'created'.

Source:

api/shipment.js, line 319

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

createdShipmentP(number, options, callback) → {Promise}

Sets the shipment status to 'created'.

Source:

api/shipment.js, line 331

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The shipment with the updated status.

createEvent(event, options, callback) → {XMLHttpRequest}

Creates an event on RIPE Core.

Source:

api/admin/event.js, line 48

Parameters:

Name	Type	Description
`event`	`Object`	The event data.
`options`	`Object`	An object with options.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

createEventP(event, options) → {Promise}

Creates an event on RIPE Core.

Source:

api/admin/event.js, line 69

Parameters:

Name	Type	Description
`event`	`Object`	The event data.
`options`	`Object`	An object with options.

Returns:

Type:: Promise

The event.

createFactoryRule(factoryRule, options, callback) → {XMLHttpRequest}

Creates a factory rule on RIPE Core.

Source:

api/factory-rule.js, line 48

Parameters:

Name	Type	Description
`factoryRule`	`Object`	An object with information needed to create a factory rule.
`options`	`Object`	An object with options.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

createFactoryRuleP(factoryRule, options) → {Promise}

Creates a factory rule on RIPE Core.

Source:

api/factory-rule.js, line 69

Parameters:

Name	Type	Description
`factoryRule`	`Object`	An object with information needed to create a factory rule.
`options`	`Object`	An object with options.

Returns:

Type:: Promise

The factory rule's data.

createInvoiceRule(invoiceRule, options, callback) → {XMLHttpRequest}

Creates a invoice rule on RIPE Core.

Source:

api/invoice-rule.js, line 48

Parameters:

Name	Type	Description
`invoiceRule`	`Object`	An object with information needed to create a invoice rule.
`options`	`Object`	An object with options.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

createInvoiceRuleP(invoiceRule, options) → {Promise}

Creates a invoice rule on RIPE Core.

Source:

api/invoice-rule.js, line 69

Parameters:

Name	Type	Description
`invoiceRule`	`Object`	An object with information needed to create a invoice rule.
`options`	`Object`	An object with options.

Returns:

Type:: Promise

The invoice rule's data.

createInvoiceShipment(number, options, callback) → {XMLHttpRequest}

Creates an invoice for the shipment with the provided number.

Source:

api/shipment.js, line 857

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to create the invoice for.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

createInvoiceShipmentP(number, options) → {Promise}

Creates an invoice for the shipment with the provided number.

Source:

api/shipment.js, line 877

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to create the invoice for.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The contents of the invoice instance that was created.

createIssueOrder(number, issue, options, callback) → {XMLHttpRequest}

Creates an order issue with the provided description, error log and severity and associates it with the order with the provided number.

Source:

api/order.js, line 334

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to associate an issue.
`issue`	`String`	The issue name, containing the context of issue.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

createIssueOrderP(number, issue, options) → {Promise}

Creates an order issue with the provided description, error log and severity and associates it with the order with the provided number.

Source:

api/order.js, line 361

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to associate an issue.
`issue`	`String`	The issue name, containing the context of issue.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The contents of the issue instance that was created.

createIssueShipment(number, issue, options, callback) → {XMLHttpRequest}

Creates a shipment issue with the provided description, error log and severity and associates it with the shipment with the provided number.

Source:

api/shipment.js, line 706

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to associate an issue.
`issue`	`String`	The issue name, containing the context of issue.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

createIssueShipmentP(number, issue, options) → {Promise}

Creates a shipment issue with the provided description, error log and severity and associates it with the shipment with the provided number.

Source:

api/shipment.js, line 733

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to associate an issue.
`issue`	`String`	The issue name, containing the context of issue.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The contents of the issue instance that was created.

createLetterRule(letterRule, options, callback) → {XMLHttpRequest}

Creates a letter rule on RIPE Core.

Source:

api/letter-rule.js, line 48

Parameters:

Name	Type	Description
`letterRule`	`Object`	An object with information needed to create a letter rule.
`options`	`Object`	An object with options.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

createLetterRuleP(letterRule, options) → {Promise}

Creates a letter rule on RIPE Core.

Source:

api/letter-rule.js, line 69

Parameters:

Name	Type	Description
`letterRule`	`Object`	An object with information needed to create a letter rule.
`options`	`Object`	An object with options.

Returns:

Type:: Promise

The letter rule's data.

createNoteOrder(number, text, options, callback) → {XMLHttpRequest}

Creates a note with the provided text and associates it with the order with the provided number.

Source:

api/order.js, line 292

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to associate a note.
`text`	`String`	The note text, containing the context of the note.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

createNoteOrderP(number, text, options) → {Promise}

Creates a note with the provided text and associates it with the order with the provided number.

Source:

api/order.js, line 316

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to associate a note.
`text`	`String`	The note text, containing the context of the note.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The contents of the note instance that was created.

createNoteShipment(number, text, options, callback) → {XMLHttpRequest}

Creates a note with the provided text and associates it with the shipment with the provided number.

Source:

api/shipment.js, line 664

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to associate a note.
`text`	`String`	The note text, containing the context of the note.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

createNoteShipmentP(number, text, options) → {Promise}

Creates a note with the provided text and associates it with the shipment with the provided number.

Source:

api/shipment.js, line 688

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to associate a note.
`text`	`String`	The note text, containing the context of the note.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The contents of the note instance that was created.

createOrder(number, options, callback) → {XMLHttpRequest}

Sets the order status to 'create'.

Source:

api/order.js, line 1237

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

createOrderP(number, options, callback) → {Promise}

Sets the order status to 'create'.

Source:

api/order.js, line 1249

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The order with the updated status.

createPriceRule(priceRule, options, callback) → {XMLHttpRequest}

Creates a price rule on RIPE Core.

Source:

api/price-rule.js, line 48

Parameters:

Name	Type	Description
`priceRule`	`Object`	An object with information needed to create a price rule.
`options`	`Object`	An object with options.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

createPriceRuleP(priceRule, options) → {Promise}

Creates a price rule on RIPE Core.

Source:

api/price-rule.js, line 69

Parameters:

Name	Type	Description
`priceRule`	`Object`	An object with information needed to create a price rule.
`options`	`Object`	An object with options.

Returns:

Type:: Promise

The price rule's data.

createReturnWaybillOrder(number, options, callback) → {XMLHttpRequest}

Creates a shipping return waybill for the order with the provided number.

Source:

api/order.js, line 413

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to create the return waybill for.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

createReturnWaybillOrderP(number, options) → {Promise}

Creates a shipping return waybill for the order with the provided number.

Source:

api/order.js, line 433

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to create the return waybill for.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The contents of the note instance that was created.

createReturnWaybillShipment(number, options, callback) → {XMLHttpRequest}

Creates a return shipping waybill for the shipment with the provided number.

Source:

api/shipment.js, line 821

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to create the return waybill for.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

createReturnWaybillShipmentP(number, options) → {Promise}

Creates a return shipping waybill for the shipment with the provided number.

Source:

api/shipment.js, line 841

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to create the return waybill for.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The contents of the waybill instance that was created.

createShipment(shipment, options, callback) → {XMLHttpRequest}

Creates a shipment on RIPE Core.

Source:

api/shipment.js, line 126

Parameters:

Name	Type	Description
`shipment`	`Object`	The shipment object, with options such as: - 'status' - The shipment status. - 'description' - A brief description of this shipment. - 'weight' - Weight of the package being shipped. - 'weight_units' - Weight units (e.g. "kilograms" or "pounds"). - 'courier' - The courier for this shipment. - 'service' - The transportation service used. - 'package' - The package used. - 'tracking_number' - The tracking number associated with this shipment. - 'tracking_url' - The tracking URL associated with this shipment. - 'carbon_neutral' - If this shipment should be carbon neutral. - 'access_point_delivery' - If this shipment should be sent to an access point (e.g. "no", "optional" or "mandatory"). - 'pickup' - Pickup information. - 'offset' - Time offset for pickup scheduling relative to shipment creation (milliseconds). - 'ready_time' - Opening hours for shipper facility (milliseconds). - 'close_time' - Closing hours for shipper facility (milliseconds). - 'shipping_date' - The date the shipment ended. - 'delivery_date' - The date the shipment began. - 'shipper' - Shipper's information. - 'name' - Shipper's contact name. - 'phone' - Shipper's contact phone. - 'address' - Shipper's address. - 'customer' - Customer's information. - 'name' - Customer's contact name. - 'phone' - Customer's contact phone. - 'address' - Customer's address. - 'orders' - A list of RIPE Core order numbers. - 'attachments' - A list of RIPE Core attachment IDs.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

createShipmentP(shipment, options) → {Promise}

Creates a shipment on RIPE Core.

Source:

api/shipment.js, line 174

Parameters:

Name	Type	Description
`shipment`	`Object`	The shipment object, with options such as: - 'status' - The shipment status. - 'description' - A brief description of this shipment. - 'weight' - Weight of the package being shipped. - 'weight_units' - Weight units (e.g. "kilograms" or "pounds"). - 'courier' - The courier for this shipment. - 'service' - The transportation service used. - 'package' - The package used. - 'tracking_number' - The tracking number associated with this shipment. - 'tracking_url' - The tracking URL associated with this shipment. - 'carbon_neutral' - If this shipment should be carbon neutral. - 'access_point_delivery' - If this shipment should be sent to an access point (e.g. "no", "optional" or "mandatory"). - 'pickup' - Pickup information. - 'offset' - Time offset for pickup scheduling relative to shipment creation (milliseconds). - 'ready_time' - Opening hours for shipper facility (milliseconds). - 'close_time' - Closing hours for shipper facility (milliseconds). - 'shipping_date' - The date the shipment ended. - 'delivery_date' - The date the shipment began. - 'shipper' - Shipper's information. - 'name' - Shipper's contact name. - 'phone' - Shipper's contact phone. - 'address' - Shipper's address. - 'customer' - Customer's information. - 'name' - Customer's contact name. - 'phone' - Customer's contact phone. - 'address' - Customer's address. - 'orders' - A list of RIPE Core order numbers. - 'attachments' - A list of RIPE Core attachment IDs.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The shipment's data.

createSku(identifier, domain, options, callback) → {XMLHttpRequest}

Creates a SKU on RIPE Core under the defined domain.

Source:

api/sku.js, line 106

Parameters:

Name	Type	Description
`identifier`	`String`	The SKU identifier as a plain string.
`domain`	`Object`	The SKU's domain, within the SKU is going to be defined.
`options`	`Object`	An object with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'variant' - The variant of the model. - 'version' - The version of the build. - '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.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

createSkuP(identifier, domain, options) → {Promise}

Creates a SKU on RIPE Core under the defined domain.

Source:

api/sku.js, line 140

Parameters:

Name	Type	Description
`identifier`	`String`	The SKU identifier as a plain string.
`domain`	`Object`	The SKU's domain, within the SKU is going to be defined.
`options`	`Object`	An object with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'variant' - The variant of the model. - 'version' - The version of the build. - '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.

Returns:

Type:: Promise

The SKU's data.

createTransportRule(transportRule, options, callback) → {XMLHttpRequest}

Creates a transport rule on RIPE Core.

Source:

api/transport-rule.js, line 48

Parameters:

Name	Type	Description
`transportRule`	`Object`	An object with information needed to create a transport rule.
`options`	`Object`	An object with options.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

createTransportRuleP(transportRule, options) → {Promise}

Creates a transport rule on RIPE Core.

Source:

api/transport-rule.js, line 69

Parameters:

Name	Type	Description
`transportRule`	`Object`	An object with information needed to create a transport rule.
`options`	`Object`	An object with options.

Returns:

Type:: Promise

The transport rule's data.

createWaybillOrder(number, options, callback) → {XMLHttpRequest}

Creates a shipping waybill for the order with the provided number.

Source:

api/order.js, line 377

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to create the waybill for.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

createWaybillOrderP(number, options) → {Promise}

Creates a shipping waybill for the order with the provided number.

Source:

api/order.js, line 397

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to create the waybill for.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The contents of the note instance that was created.

createWaybillShipment(number, options, callback) → {XMLHttpRequest}

Creates a shipping waybill for the shipment with the provided number.

Source:

api/shipment.js, line 785

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to create the waybill for.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

createWaybillShipmentP(number, options) → {Promise}

Creates a shipping waybill for the shipment with the provided number.

Source:

api/shipment.js, line 805

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to create the waybill for.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The contents of the waybill instance that was created.

deactivateTagOrder(number, options, callback) → {XMLHttpRequest}

Deactivates the tag for an order.

Source:

api/order.js, line 2322

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

deactivateTagOrderP(number, options) → {Promise}

Deactivates the tag for an order.

Source:

api/order.js, line 2342

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The order.

deinit()

The deinitializer to be called when it should stop responding to updates so that any necessary cleanup operations can be executed.

Source:

base/ripe.js, line 272

deleteAvailabilityRule(id, options, callback) → {XMLHttpRequest}

Deletes an existing availability rule.

Source:

api/availability-rule.js, line 160

Parameters:

Name	Type	Description
`id`	`Number`	The availability rule's ID.
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

deleteAvailabilityRuleP(id, options) → {Promise}

Deletes an existing availability rule.

Source:

api/availability-rule.js, line 180

Parameters:

Name	Type	Description
`id`	`Number`	The availability rule's ID.
`options`	`Object`	An object of options to configure the request

Returns:

Type:: Promise

The result of the availability rule's deletion.

deleteCountryGroup(id, options, callback) → {XMLHttpRequest}

Deletes an existing country group.

Source:

api/country-group.js, line 169

Parameters:

Name	Type	Description
`id`	`Object`	ID of the country group to be deleted.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

deleteCountryGroupP(id, options) → {Promise}

Deletes an existing country group.

Source:

api/country-group.js, line 189

Parameters:

Name	Type	Description
`id`	`Object`	ID of the country group to be deleted.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The result of the country group's deletion.

deleteEvent(id, options, callback) → {XMLHttpRequest}

Deletes an existing event.

Source:

api/admin/event.js, line 160

Parameters:

Name	Type	Description
`id`	`Number`	The event's ID.
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

deleteEventP(id, options) → {Promise}

Deletes an existing event.

Source:

api/admin/event.js, line 180

Parameters:

Name	Type	Description
`id`	`Number`	The event's ID.
`options`	`Object`	An object of options to configure the request

Returns:

Type:: Promise

The result of the event's deletion.

deleteFactoryRule(id, options, callback) → {XMLHttpRequest}

Deletes an existing factory rule.

Source:

api/factory-rule.js, line 160

Parameters:

Name	Type	Description
`id`	`Number`	The factory rule's ID.
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

deleteFactoryRuleP(id, options) → {Promise}

Deletes an existing factory rule.

Source:

api/factory-rule.js, line 180

Parameters:

Name	Type	Description
`id`	`Number`	The factory rule's ID.
`options`	`Object`	An object of options to configure the request

Returns:

Type:: Promise

The result of the factory rule's deletion.

deleteInvoiceRule(id, options, callback) → {XMLHttpRequest}

Deletes an existing invoice rule.

Source:

api/invoice-rule.js, line 160

Parameters:

Name	Type	Description
`id`	`Number`	The invoice rule's ID.
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

deleteInvoiceRuleP(id, options) → {Promise}

Deletes an existing invoice rule.

Source:

api/invoice-rule.js, line 180

Parameters:

Name	Type	Description
`id`	`Number`	The invoice rule's ID.
`options`	`Object`	An object of options to configure the request

Returns:

Type:: Promise

The result of the invoice rule's deletion.

deleteLetterRule(id, options, callback) → {XMLHttpRequest}

Deletes an existing letter rule.

Source:

api/letter-rule.js, line 160

Parameters:

Name	Type	Description
`id`	`Number`	The letter rule's ID.
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

deleteLetterRuleP(id, options) → {Promise}

Deletes an existing letter rule.

Source:

api/letter-rule.js, line 180

Parameters:

Name	Type	Description
`id`	`Number`	The letter rule's ID.
`options`	`Object`	An object of options to configure the request

Returns:

Type:: Promise

The result of the letter rule's deletion.

deleteOrder(number, options, callback) → {XMLHttpRequest}

Deletes an order by number.

Source:

api/order.js, line 135

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to delete.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

deleteOrderP(number, options) → {Promise}

Deletes an order by number.

Source:

api/order.js, line 155

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to delete.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The result of the order deletion.

deletePriceRule(id, options, callback) → {XMLHttpRequest}

Deletes an existing price rule.

Source:

api/price-rule.js, line 160

Parameters:

Name	Type	Description
`id`	`Number`	The price rule's ID.
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

deletePriceRuleP(id, options) → {Promise}

Deletes an existing price rule.

Source:

api/price-rule.js, line 180

Parameters:

Name	Type	Description
`id`	`Number`	The price rule's ID.
`options`	`Object`	An object of options to configure the request

Returns:

Type:: Promise

The result of the price rule's deletion.

deleteShipment(number, options, callback) → {XMLHttpRequest}

Deletes a shipment by number.

Source:

api/shipment.js, line 283

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to delete.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

deleteShipmentP(number, options) → {Promise}

Deletes a shipment by number.

Source:

api/shipment.js, line 303

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to delete.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The result of the shipment deletion.

deleteSku(id, options, callback) → {XMLHttpRequest}

Deletes an existing SKU entity.

Source:

api/sku.js, line 253

Parameters:

Name	Type	Description
`id`	`Object`	ID of the SKU to be deleted.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

deleteSkuP(id, options) → {Promise}

Deletes an existing SKU entity.

Source:

api/sku.js, line 273

Parameters:

Name	Type	Description
`id`	`Object`	ID of the SKU to be deleted.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The result of the SKU's deletion.

deleteTagOrder(number, options, callback) → {XMLHttpRequest}

Deletes the tag for an order and, by default, deactivates it as well.

Source:

api/order.js, line 2246

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order with the tag to delete.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

deleteTagOrderP(number, options) → {Promise}

Deletes the tag for an order and, by default, deactivates it as well.

Source:

api/order.js, line 2268

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order with the tag to delete.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The order.

deleteTransportRule(id, options, callback) → {XMLHttpRequest}

Deletes an existing transport rule.

Source:

api/transport-rule.js, line 160

Parameters:

Name	Type	Description
`id`	`Number`	The transport rule's ID.
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

deleteTransportRuleP(id, options) → {Promise}

Deletes an existing transport rule.

Source:

api/transport-rule.js, line 180

Parameters:

Name	Type	Description
`id`	`Number`	The transport rule's ID.
`options`	`Object`	An object of options to configure the request

Returns:

Type:: Promise

The result of the transport rule's deletion.

deliverShipment(number, options, callback) → {XMLHttpRequest}

Sets the shipment status to 'delivered'.

Source:

api/shipment.js, line 459

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

deliverShipmentP(number, options, callback) → {Promise}

Sets the shipment status to 'delivered'.

Source:

api/shipment.js, line 471

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The shipment with the updated status.

deselectPart(part, options)

Deselects a part of the model. Triggers a 'deselected_part' event with the part.

Source:

base/ripe.js, line 1282

Parameters:

Name	Type	Description
`part`	`String`	The name of the part to be deselected.
`options`	`Object`	An Object with options to configure the operation.

geoResolve(address, options, callback) → {XMLHttpRequest}

Runs the GeoIP resolution process so that it's possible to uncover more geographical information about the current user.

Source:

base/api.js, line 93

Parameters:

Name	Type	Description
`address`	`String`	The optional address to be used in case the address of the IP request is not desired.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getAttachmentOrderUrl(key, options) → {String}

Returns the URL that redirects to where an attachment is hosted, using the provided secret key as reference.

Source:

api/attachment.js, line 12

Parameters:

Name	Type	Description
`key`	`String`	The secret key to be used in attachment retrieval.
`options`	`Object`	A map with options for the URL building.

Returns:

Type:: String

The URL that can be used to view an attachment.

getAvailabilityRule(id, options, callback) → {XMLHttpRequest}

Gets an existing availability rule filtered by ID and according to the provided filtering strategy as normalized values.

Source:

api/availability-rule.js, line 86

Parameters:

Name	Type	Description
`id`	`Number`	The availability rule's ID.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getAvailabilityRuleP(id, options) → {Promise}

Gets an existing availability rule filtered by ID and according to the provided filtering strategy as normalized values.

Source:

api/availability-rule.js, line 107

Parameters:

Name	Type	Description
`id`	`Number`	The availability rule's ID.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The availability rule requested by ID.

getAvailabilityRules(options, callback) → {XMLHttpRequest}

Gets the existing availability rules, according to the provided filtering strategy as normalized values.

Source:

api/availability-rule.js, line 12

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getAvailabilityRulesP(options) → {Promise}

Gets the existing availability rules, according to the provided filtering strategy as normalized values.

Source:

api/availability-rule.js, line 32

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The availability rules list.

getBuild(name, options) → {XMLHttpRequest}

Retrieves a build's information from the server side by name.

Source:

api/build.js, line 77

Parameters:

Name	Type	Description
`name`	`String`	The name of the of the build.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getBuildArtifact(name, version, options) → {XMLHttpRequest}

Retrieves the build artifact information by brand name and version.

Source:

api/build.js, line 328

Parameters:

Name	Type	Description
`name`	`String`	The name of the brand of the build artifact.
`version`	`String`	The version of the build artifact.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getBuildArtifactP(name, version, options) → {Promise}

Retrieves the build artifact information by name and version.

Source:

api/build.js, line 349

Parameters:

Name	Type	Description
`name`	`String`	The name of the build artifact.
`version`	`String`	The version of the build artifact.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The build artifact (as a promise).

getBuildArtifacts(name, options) → {XMLHttpRequest}

Retrieves the build artifacts by name and version and for the requested branch.

Source:

api/build.js, line 285

Parameters:

Name	Type	Description
`name`	`String`	The name of the build artifacts.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getBuildArtifactsP(name, options) → {Promise}

Retrieves the build artifacts by brand name and version and for the requested branch.

Source:

api/build.js, line 312

Parameters:

Name	Type	Description
`name`	`String`	The name of the brand of the build artifacts.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The build artifacts (as a promise).

getBuildP(name, options) → {Promise}

Retrieves a build's information from the server side by name.

Source:

api/build.js, line 97

Parameters:

Name	Type	Description
`name`	`String`	The name of the build.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The build's information (as a promise).

getBuilds(options) → {XMLHttpRequest}

Retrieves the complete list of builds available from the server.

Source:

api/build.js, line 10

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getBuildsP(options) → {Promise}

Retrieves the complete list of builds available from the server.

Source:

api/build.js, line 29

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The builds list (as a promise).

getBulkOrder(number, options, callback) → {XMLHttpRequest}

Gets a bulk order by number.

Source:

api/bulk-order.js, line 56

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getBulkOrderP(number, options) → {Promise}

Gets a bulk order by number.

Source:

api/bulk-order.js, line 76

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to find by.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The bulk order requested by number.

getBulkOrders(options, callback, callback) → {XMLHttpRequest}

Gets the existing bulk orders, according to the provided filtering strategy as normalized values.

Source:

api/bulk-order.js, line 20

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request, 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.
`callback`	`function`	Function with the result of the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getBulkOrdersP(options) → {Promise}

Gets the existing bulk orders, according to the provided filtering strategy as normalized values.

Source:

api/bulk-order.js, line 40

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The bulk orders result list.

getBundle(locale) → {Object}

Retrieves the locale bundle according to the provided locale.

Source:

base/logic.js, line 65

Parameters:

Name	Type	Description
`locale`	`String`	The ISO 639-1 compliant string value that describes the locale to obtain the global bundle.

Returns:

Type:: Object

An object that for the provided locale maps a certain locale string to the translation.

getBundles() → {Object}

Retrieves the complete set of locale bundles currently registered in the global Ripe instance.

Source:

base/logic.js, line 53

Returns:

Type:: Object

An object that maps a certain locale string to an object mapping locale keys to translations.

getChildren(type) → {Array}

Retrieves the complete set of child elements of this Ripe instance that fulfill the provided type criteria.

Source:

base/ripe.js, line 1166

Parameters:

Name	Type	Description
`type`	`String`	The type of child as a string to filter children.

Returns:

Type:: Array

The child elements that fill the provided type.

getChoices() → {Object}

Returns the current state (eg: availability) for the parts materials and colors associated with the current customization session.

Source:

base/ripe.js, line 1008

Returns:

Type:: Object

The object that contains the state for every single part, material, and color.

getCombinations(options, callback) → {XMLHttpRequest}

Returns the possible customization combinations of a specific brand or model. If no model is provided then returns the defaults of the owner's current model.

Source:

api/brand.js, line 317

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'version' - The version of the build, defaults to latest.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The model's total set of combinations.

getCombinationsP(options) → {Promise}

Returns the possible customization combinations of a specific brand or model. If no model is provided then returns the defaults of the owner's current model.

Source:

api/brand.js, line 337

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'version' - The version of the build, defaults to latest.

Returns:

Type:: Promise

The model's total set of combinations.

getConfig(options, callback) → {XMLHttpRequest}

Returns the configuration information of a specific brand and model. If no model is provided then returns the information of the owner's current model.

Source:

api/brand.js, line 177

Parameters:

Name	Type	Description
`options`	`Object`	A map with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'version' - The version of the build, defaults to latest. - 'country' - The country where the model will be provided, some materials/colors might not be available. - 'flag' - A specific flag that may change the provided materials/colors available. - 'filter' - If the configuration should be filtered by the country and/or flag (defaults to 'true').
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The model's configuration data.

getConfigP(options) → {Promise}

Returns the configuration information of a specific brand and model. If no model is provided then returns the information of the owner's current model.

Source:

api/brand.js, line 198

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'version' - The version of the build, defaults to latest. - 'country' - The country where the model will be provided, some materials/colors might not be available. - 'flag' - A specific flag that may change the provided materials/colors available. - 'filter' - If the configuration should be filtered by the country and/or flag (defaults to 'true').

Returns:

Type:: Promise

The model's configuration data.

getCountryGroup(id, options, callback) → {XMLHttpRequest}

Gets a country group by its ID.

Source:

api/country-group.js, line 94

Parameters:

Name	Type	Description
`id`	`Object`	ID of the intended country group.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getCountryGroupP(id, options) → {Promise}

Gets a country group by its ID.

Source:

api/country-group.js, line 114

Parameters:

Name	Type	Description
`id`	`Object`	ID of the intended country group.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The country group requested by ID.

getCountryGroups(options, callback) → {XMLHttpRequest}

Gets the existing country groups, according to the provided filtering strategy as normalized values.

Source:

api/country-group.js, line 19

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request, 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.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getCountryGroupsP(options) → {Promise}

Gets the existing country groups, according to the provided filtering strategy as normalized values.

Source:

api/country-group.js, line 39

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The country group result list.

getCtx() → {Object}

Retrieves the value of the current base context defined in the instance.

Source:

base/ripe.js, line 975

Returns:

Type:: Object

The base context currently set.

getDefaults(options, callback) → {XMLHttpRequest}

Returns the default customization of a specific brand or model. If no model is provided then returns the defaults of the owner's current model.

Source:

api/brand.js, line 256

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'version' - The version of the build, defaults to latest.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The model's default options.

getDefaultsP(options) → {Promise}

Returns the default customization of a specific brand or model. If no model is provided then returns the defaults of the owner's current model.

Source:

api/brand.js, line 276

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'version' - The version of the build, defaults to latest.

Returns:

Type:: Promise

The model's default options.

getDimension(name, face) → {Object}

Retrieves the dimension of the image associated with the provided name and for the requested face. The returned dimension structure should contain information about: size, format and other meta-information.

Source:

base/ripe.js, line 1635

Parameters:

Name	Type	Description
`name`	`String`	The name of the dimension we want to get information about.
`face`	`String`	The face we want to get the dimension of.

Returns:

Type:: Object

An object containing the dimension information for the requested name and face.

getEvent(id, options, callback) → {XMLHttpRequest}

Gets an existing event filtered by ID and according to the provided filtering strategy as normalized values.

Source:

api/admin/event.js, line 86

Parameters:

Name	Type	Description
`id`	`Number`	The event's ID.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getEventP(id, options) → {Promise}

Gets an existing event filtered by ID and according to the provided filtering strategy as normalized values.

Source:

api/admin/event.js, line 107

Parameters:

Name	Type	Description
`id`	`Number`	The event's ID.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The event requested by ID.

getEvents(options, callback) → {XMLHttpRequest}

Gets the existing events, according to the provided filtering strategy as normalized values.

Source:

api/admin/event.js, line 12

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getEventsP(options) → {Promise}

Gets the existing events, according to the provided filtering strategy as normalized values.

Source:

api/admin/event.js, line 32

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The events list.

getFactory(options, callback) → {XMLHttpRequest}

Returns the factory information where a model is made, specifically its name and the estimated production time in days. If no model is provided then returns the defaults of the owner's current model.

Source:

api/brand.js, line 356

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The factory information for the provided model.

getFactoryP(options, callback) → {Promise}

Returns the factory information where a model is made, specifically its name and the estimated production time in days. If no model is provided then returns the defaults of the owner's current model.

Source:

api/brand.js, line 375

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The factory information for the provided model.

getFactoryRule(id, options, callback) → {XMLHttpRequest}

Gets an existing factory rule filtered by ID and according to the provided filtering strategy as normalized values.

Source:

api/factory-rule.js, line 86

Parameters:

Name	Type	Description
`id`	`Number`	The factory rule's ID.
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getFactoryRuleP(id, options) → {Promise}

Gets an existing factory rule filtered by ID and according to the provided filtering strategy as normalized values.

Source:

api/factory-rule.js, line 107

Parameters:

Name	Type	Description
`id`	`Number`	The factory rule's ID.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The factory rule requested by ID.

getFactoryRules(options, callback) → {XMLHttpRequest}

Gets the existing factory rules, according to the provided filtering strategy as normalized values.

Source:

api/factory-rule.js, line 12

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getFactoryRulesP(options) → {Promise}

Gets the existing factory rules, according to the provided filtering strategy as normalized values.

Source:

api/factory-rule.js, line 32

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The factory rules result list.

getFontUrl(options) → {String}

Returns the URL where the font can be retrieved.

Source:

api/brand.js, line 125

Parameters:

Name	Type	Description
`options`	`Object`	A map with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'version' - The version of the build, defaults to latest.

Returns:

Type:: String

The URL of the specified initials texture.

getFrames() → {Object}

Returns the model's available frames, in an object structure that maps a certain face with the number of available frames for such face. This function makes use of the loaded config in case there's one, otherwise triggers the loading of the config.

Source:

base/ripe.js, line 1045

Returns:

Type:: Object

The model's available frames.

getInitialsConfig(options, callback) → {XMLHttpRequest}

Returns the initials configuration information of a specific brand and model. If no model is provided then returns the information of the owner's current model.

Source:

api/brand.js, line 218

Parameters:

Name	Type	Description
`options`	`Object`	A map with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'version' - The version of the build, defaults to latest. - 'profiles' - The list of initials profiles.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The model's initials configuration data.

getInitialsConfigP(options) → {Promise}

Returns the initials configuration information of a specific brand and model. If no model is provided then returns the information of the owner's current model.

Source:

api/brand.js, line 237

Parameters:

Name	Type	Description
`options`	`Object`	A map with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'version' - The version of the build, defaults to latest. - 'profiles' - The list of initials profiles.

Returns:

Type:: Promise

The model's configuration data.

getInvoiceRule(id, options, callback) → {XMLHttpRequest}

Gets an existing invoice rule filtered by ID and according to the provided filtering strategy as normalized values.

Source:

api/invoice-rule.js, line 86

Parameters:

Name	Type	Description
`id`	`Number`	The invoice rule's ID.
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getInvoiceRuleP(id, options) → {Promise}

Gets an existing invoice rule filtered by ID and according to the provided filtering strategy as normalized values.

Source:

api/invoice-rule.js, line 107

Parameters:

Name	Type	Description
`id`	`Number`	The invoice rule's ID.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The invoice rule requested by ID.

getInvoiceRules(options, callback) → {XMLHttpRequest}

Gets the existing invoice rules, according to the provided filtering strategy as normalized values.

Source:

api/invoice-rule.js, line 12

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getInvoiceRulesP(options) → {Promise}

Gets the existing invoice rules, according to the provided filtering strategy as normalized values.

Source:

api/invoice-rule.js, line 32

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The invoice rules list.

getJustifications(options, callback) → {XMLHttpRequest}

Gets the existing justifications, according to the provided filtering strategy as normalized values.

Source:

api/justification.js, line 19

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request, 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.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getJustificationsByContext(context, options, callback) → {XMLHttpRequest}

Gets the existing justifications filtered by context, according to the provided filtering strategy as normalized values.

Source:

api/justification.js, line 99

Parameters:

Name	Type	Description
`context`	`String`	The justification context to filter for.
`options`	`Object`	An object of options to configure the request, 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.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getJustificationsByContextP(context, options) → {Promise}

Gets the existing justifications filtered by context, according to the provided filtering strategy as normalized values.

Source:

api/justification.js, line 127

Parameters:

Name	Type	Description
`context`	`String`	The justification context to filter for.
`options`	`Object`	An object of options to configure the request, 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:

Type:: Promise

The justifications result list.

getJustificationsP(options) → {Promise}

Gets the existing justifications, according to the provided filtering strategy as normalized values.

Source:

api/justification.js, line 39

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The justifications result list.

getLetterRule(id, options, callback) → {XMLHttpRequest}

Gets an existing letter rule filtered by ID and according to the provided filtering strategy as normalized values.

Source:

api/letter-rule.js, line 86

Parameters:

Name	Type	Description
`id`	`Number`	The letter rule's ID.
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getLetterRuleP(id, options) → {Promise}

Gets an existing letter rule filtered by ID and according to the provided filtering strategy as normalized values.

Source:

api/letter-rule.js, line 107

Parameters:

Name	Type	Description
`id`	`Number`	The letter rule's ID.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The letter rule requested by ID.

getLetterRules(options, callback) → {XMLHttpRequest}

Gets the existing letter rules, according to the provided filtering strategy as normalized values.

Source:

api/letter-rule.js, line 12

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getLetterRulesP(options) → {Promise}

Gets the existing letter rules, according to the provided filtering strategy as normalized values.

Source:

api/letter-rule.js, line 32

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The letter rules result list.

getLoadedConfig() → {Object}

Returns the model's configuration loaded from the Platforme's system. The config version loaded by this method is the one "cached" in the instance, if there's any.

Source:

base/ripe.js, line 997

Returns:

Type:: Object

The model's configuration.

getLocalBuilds(options) → {XMLHttpRequest}

Retrieves the complete list of builds installed and available.

Source:

api/build.js, line 43

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getLocalBuildsP(options) → {Promise}

Retrieves the complete list of builds installed and available.

Source:

api/build.js, line 62

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The builds list (as a promise).

getLocaleModel(options, callback) → {XMLHttpRequest}

Retrieves the bundle of part, materials and colors translations of a specific brand and model If no model is defined the retrieves the bundle of the owner's current model.

Source:

api/build.js, line 483

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'locale' - The locale of the translations. - 'compatibility' - If compatibility mode should be enabled. - 'prefix' - A prefix to prepend to the locale keys (defaults to 'builds').
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getLocaleModelKeys(options, callback) → {XMLHttpRequest}

Retrieves the default locale keys of a specific brand and model.

Source:

api/build.js, line 521

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request, such as: - 'brand' - The brand of the model. If no brand is defined it retrieves the keys of the owner's current brand. - 'model' - The name of the model. If no model is defined it retrieves the keys of the owner's current model. - 'version' - The version of the build. If no version is defined it retrieves the keys of the owner's current version.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getLocaleModelKeysP(options) → {Promise}

Retrieves the default locale keys of a specific brand and model.

Source:

api/build.js, line 538

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request, such as: - 'brand' - The brand of the model. If no brand is defined it retrieves the keys of the owner's current brand. - 'model' - The name of the model. If no model is defined it retrieves the keys of the owner's current model. - 'version' - The version of the build. If no version is defined it retrieves the keys of the owner's current version.

Returns:

Type:: Promise

The resolved locale data (as a promise).

getLocaleModelP(options) → {Promise}

Retrieves the bundle of part, materials and colors translations of a specific brand and model If no model is defined the retrieves the bundle of the owner's current model.

Source:

api/build.js, line 503

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'locale' - The locale of the translations. - 'compatibility' - If compatibility mode should be enabled. - 'prefix' - A prefix to prepend to the locale keys (defaults to 'builds').

Returns:

Type:: Promise

The resolved locale data (as a promise).

getLogic(options, callback) → {XMLHttpRequest}

Returns the logic script of a model in the requested format (javascript or python).

Source:

api/brand.js, line 522

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'version' - The version of the build, defaults to latest. - 'format' - The format of the logic script ("js" or "py"). - 'method' - The method of the logic module of the model. - 'args' - The arguments to pass to the method, as an object.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The logic script of the provided model.

getLogicP(options) → {Promise}

Returns the logic script of a model in the requested format (javascript or python).

Source:

api/brand.js, line 542

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'version' - The version of the build, defaults to latest. - 'format' - The format of the logic script ("js" or "py"). - 'method' - The method of the logic module of the model. - 'args' - The arguments to pass to the method, as an object.

Returns:

Type:: Promise

The logic script of the provided model.

getLogo(options, callback) → {XMLHttpRequest}

Returns the logo of a brand.

Source:

api/brand.js, line 16

Parameters:

Name	Type	Description
`options`	`Object`	A map with options, such as: - 'brand' - The brand of the model. - 'version' - The version of the build, defaults to latest. - 'variant' - The variant of the logo, that controls semantics of the logo. - 'format' - The format of the logo image to be retrieved (defaults to 'png'). - 'size' - The size of the logo image.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The brand's logo.

getLogoP(options) → {Promise}

Returns the logo of a brand.

Source:

api/brand.js, line 35

Parameters:

Name	Type	Description
`options`	`Object`	A map with options, such as: - 'brand' - The brand of the model. - 'version' - The version of the build, defaults to latest. - 'variant' - The variant of the logo, that controls semantics of the logo. - 'format' - The format of the logo image to be retrieved (defaults to 'png'). - 'size' - The size of the logo image.

Returns:

Type:: Promise

The brand's logo.

getLogoUrl(options) → {String}

Returns the URL where the logo of a brand can be retrieved. Can be used to allow interactive user agents (browser) to load the image user their own loading infrastructure.

Source:

api/brand.js, line 56

Parameters:

Name	Type	Description
`options`	`Object`	A map with options, such as: - 'brand' - The brand of the model. - 'version' - The version of the build, defaults to latest. - 'variant' - The variant of the logo, that controls semantics of the logo. - 'format' - The format of the logo image to be retrieved (defaults to 'png').

Returns:

Type:: String

The URL that can be used to retrieve a brand logo.

getMesh(options, callback) → {XMLHttpRequest}

Returns the mesh contents for a model.

Source:

api/brand.js, line 72

Parameters:

Name	Type	Description
`options`	`Object`	A map with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'version' - The version of the build, defaults to latest. - 'variant' - The variant of the mesh, as defined in the model spec.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The model's mesh.

getMeshP(options) → {XMLHttpRequest}

Returns the mesh contents for a model.

Source:

api/brand.js, line 90

Parameters:

Name	Type	Description
`options`	`Object`	A map with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'version' - The version of the build, defaults to latest. - 'variant' - The variant of the mesh, as defined in the model spec.

Returns:

Type:: XMLHttpRequest

The model's mesh.

getMeshUrl(options) → {String}

Returns the URL where the mesh can be retrieved. This method is useful to allow external mesh loaders to take control of the URL based mesh loading process.

Source:

api/brand.js, line 111

Parameters:

Name	Type	Description
`options`	`Object`	A map with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'version' - The version of the build, defaults to latest. - 'variant' - The variant of the mesh, as defined in the model spec.

Returns:

Type:: String

The URL that can be used to retrieve the mesh.

getOptionals(options, callback) → {Object}

Returns the default customization of a specific brand or model. If no model is provided then returns the defaults of the owner's current model.

Source:

api/brand.js, line 295

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'version' - The version of the build, defaults to latest.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Object

The model's optional parts.

getOrder(number, options, callback) → {XMLHttpRequest}

Gets an order by number.

Source:

api/order.js, line 63

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getOrderP(number, options) → {Promise}

Gets an order by number.

Source:

api/order.js, line 83

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The order requested by number.

getOrders(options, callback) → {XMLHttpRequest}

Gets the orders list, optionally filtered by a set of options.

Source:

api/order.js, line 20

Parameters:

Name	Type	Description
`options`	`Object`	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.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getOrdersP(options) → {Promise}

Gets the orders list, optionally filtered by a set of options.

Source:

api/order.js, line 47

Parameters:

Name	Type	Description
`options`	`Object`	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:

Type:: Promise

The orders result list.

getOrderSubscription(number) → {XMLHttpRequest}

Gets the order subscription status for the session user.

Source:

api/order.js, line 2061

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to get the subscription status.

Returns:

Type:: XMLHttpRequest

The order subscription status.

getOrderSubscriptionP(number) → {Promise}

Gets the order subscription status for the session user.

Source:

api/order.js, line 2081

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to get the subscription status.

Returns:

Type:: Promise

The order subscription status.

getPrice(options, callback) → {XMLHttpRequest}

Retrieves the price for current customization.

Source:

base/api.js, line 230

Parameters:

Name	Type	Description
`options`	`Object`	An Object containing customization information that can be used to override the current customization, allowing to set the 'brand', 'model' and 'parts'.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getPriceRule(id, options, callback) → {XMLHttpRequest}

Gets an existing price rule filtered by ID and according to the provided filtering strategy as normalized values.

Source:

api/price-rule.js, line 86

Parameters:

Name	Type	Description
`id`	`Number`	The price rule's ID.
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getPriceRuleP(id, options) → {Promise}

Gets an existing price rule filtered by ID and according to the provided filtering strategy as normalized values.

Source:

api/price-rule.js, line 107

Parameters:

Name	Type	Description
`id`	`Number`	The price rule's ID.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The price rule requested by ID.

getPriceRules(options, callback) → {XMLHttpRequest}

Gets the existing price rules, according to the provided filtering strategy as normalized values.

Source:

api/price-rule.js, line 12

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getPriceRulesP(options) → {Promise}

Gets the existing price rules, according to the provided filtering strategy as normalized values.

Source:

api/price-rule.js, line 32

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The price rules list.

getPrices(options, callback) → {XMLHttpRequest}

Retrieves the price for a set of customizations.

Source:

base/api.js, line 256

Parameters:

Name	Type	Description
`options`	`Object`	An Object containing customization information that can be used not only to override the current customization, allowing to set the brand', 'model', but also to provide the config list to fetch the price for.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getProfile(name, options, callback) → {XMLHttpRequest}

Retrieves a profile using the name of it as filter reference.

Source:

api/profile.js, line 46

Parameters:

Name	Type	Description
`name`	`String`	The name of the profile to be retrieved.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getProfileP(name, options) → {Promise}

Retrieves a profile using the name of it as filter reference.

Source:

api/profile.js, line 66

Parameters:

Name	Type	Description
`name`	`String`	The name of the profile to be retrieved.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The profile requested by name.

getProfiles(options, callback) → {XMLHttpRequest}

Retrieve the list of profiles according to the provided options.

Source:

api/profile.js, line 11

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getProfilesP(options) → {Promise}

Retrieve the list of profiles according to the provided options.

Source:

api/profile.js, line 30

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The sequence of profiles for the options.

getProperties(properties) → {Object}

Gets the loaded config initials properties and returns an object with all the properties types grouped by name and a sorted array of all property types.

Source:

base/logic.js, line 169

Parameters:

Name	Type	Description
`properties`	`Array`	If provided overrides the default loaded config initials strategy for the retrieval of properties definition.

Returns:

Type:: Object

Returns an object with propertyNamesM and propertyTypes. propertyNamesM is a map with (key = name, value = type) entries for each property, where "type" is the type of the property (e.g. style) and "name" is the value for that property (e.g. gold). propertyTypes is an ordered list of types.

getSceneEnvironmentUrl(name, format, options) → {String}

Returns the URL for the environment file of the 3D scene.

Source:

api/brand.js, line 140

Parameters:

Name	Type	Description
`name`	`String`	The name of the environment map.
`format`	`String`	The file format of the environment map.
`options`	`Object`	A map with options.

Returns:

Type:: String

The URL of the environment for the 3D scene.

getShipment(number, options, callback) → {XMLHttpRequest}

Gets a shipment by number.

Source:

api/shipment.js, line 63

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getShipmentP(number, options) → {Promise}

Gets a shipment by number.

Source:

api/shipment.js, line 83

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to find by.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The shipment requested by number.

getShipments(options, callback) → {XMLHttpRequest}

Gets the shipments list, optionally filtered by a set of options.

Source:

api/shipment.js, line 20

Parameters:

Name	Type	Description
`options`	`Object`	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.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getShipmentsP(options) → {Promise}

Gets the shipments list, optionally filtered by a set of options.

Source:

api/shipment.js, line 47

Parameters:

Name	Type	Description
`options`	`Object`	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:

Type:: Promise

The shipments result list.

getSize(dimension, face) → {Array}

Obtains a tuple (array) containing the best possible size for the provided dimension and face. Uses the dimension retrieval process to obtain that size, defaulting to the base configuration `size` attribute in case no specific dimension value is available.

Source:

base/ripe.js, line 1667

Parameters:

Name	Type	Description
`dimension`	`String`	The name of the dimension we want to get information about.
`face`	`String`	The face we want to get the dimension of.

Returns:

Type:: Array

An array containing both the width and the height of the image for the given dimension and face.

getSizes(options, callback) → {XMLHttpRequest}

Provides a list of all the available size scales. To be used to know what scales are available for size conversions.

Source:

api/size.js, line 12

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getSku(id, options, callback) → {XMLHttpRequest}

Gets a SKU by its ID (not by its identifier).

Source:

api/sku.js, line 156

Parameters:

Name	Type	Description
`id`	`Object`	ID of the intended SKU (not the identifier).
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getSkuP(id, options) → {Promise}

Gets a SKU by its ID (not by its identifier).

Source:

api/sku.js, line 176

Parameters:

Name	Type	Description
`id`	`Object`	ID of the intended SKU (not the identifier).
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The SKU request by ID.

getSkus(options, callback) → {XMLHttpRequest}

Gets the existing SKUs, according to the provided filtering strategy as normalized values.

Source:

api/sku.js, line 19

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request, 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.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getSkusCsv(options, callback) → {XMLHttpRequest}

Gets the existing SKUs in a CSV file, according to the provided filtering strategy as normalized values.

Source:

api/sku.js, line 61

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request, such as: - 'filters[]' - List of filters that the query will use. - '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.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getSkusCsvP(options) → {Promise}

Gets the existing SKUs in a CSV file, according to the provided filtering strategy as normalized values.

Source:

api/sku.js, line 81

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

A CSV file containing the SKUs result list.

getSkusP(options) → {Promise}

Gets the existing SKUs, according to the provided filtering strategy as normalized values.

Source:

api/sku.js, line 39

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The SKUs result list.

getStructure(safe)

Retrieves the normalized structure that uniquely represents the current configuration "situation".

Source:

base/ripe.js, line 559

Parameters:

Name	Type	Description
`safe`	`Boolean`	If the structure should be retrieved using a safe approach (deep copy).

Returns:

The normalized map structure that represents the current configuration "situation".

getTextureMapUrl(map, options) → {String}

Returns the URL for the texture of the specified texture map type.

Source:

api/brand.js, line 154

Parameters:

Name	Type	Description
`map`	`String`	The texture map type that the should be url should point to.
`options`	`Object`	A map with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'version' - The version of the build, defaults to latest.

Returns:

Type:: String

The URL of the specified initials texture.

getTransportOrder(number, options, callback) → {XMLHttpRequest}

Gets an order transport info.

Source:

api/order.js, line 99

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getTransportOrderP(number, options) → {Promise}

Gets an order transport info.

Source:

api/order.js, line 119

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The order transport info.

getTransportRule(id, options, callback) → {XMLHttpRequest}

Gets an existing transport rule filtered by ID and according to the provided filtering strategy as normalized values.

Source:

api/transport-rule.js, line 86

Parameters:

Name	Type	Description
`id`	`Number`	The transport rule's ID.
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getTransportRuleP(id, options) → {Promise}

Gets an existing transport rule filtered by ID and according to the provided filtering strategy as normalized values.

Source:

api/transport-rule.js, line 107

Parameters:

Name	Type	Description
`id`	`Number`	The transport rule's ID.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The transport rule requested by ID.

getTransportRules(options, callback) → {XMLHttpRequest}

Gets the existing transport rules, according to the provided filtering strategy as normalized values.

Source:

api/transport-rule.js, line 12

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getTransportRulesP(options) → {Promise}

Gets the existing transport rules, according to the provided filtering strategy as normalized values.

Source:

api/transport-rule.js, line 32

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The transport rules list.

getVideo(options, callback) → {XMLHttpRequest}

Returns the video of a model's customization.

Source:

base/api.js, line 281

Parameters:

Name	Type	Description
`options`	`Object`	An object containing the information required to get a video for a model, more specifically `brand`, `model`, `name` of the video and `p` containing the model's customization.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getVideoP(options, callback) → {Promise}

Returns the video of a model's customization.

Source:

base/api.js, line 298

Parameters:

Name	Type	Description
`options`	`Object`	An object containing the information required to get a video for a model, more specifically `brand`, `model`, `name` of the video and `p` containing the model's customization.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The URL path to the video.

getVideoThumbnail(options, callback) → {XMLHttpRequest}

Returns the video thumbnail image of a model's customization.

Source:

base/api.js, line 315

Parameters:

Name	Type	Description
`options`	`Object`	An object containing the information required to get the thumbnail of a video for a model, more specifically `brand`, `model`, `name` of the video and `p` containing the model's customization.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

getVideoThumbnailP(options, callback) → {Promise}

Returns the video thumbnail image of a model's customization.

Source:

base/api.js, line 332

Parameters:

Name	Type	Description
`options`	`Object`	An object containing the information required to get a video for a model, more specifically `brand`, `model`, `name` of the video and `p` containing the model's customization.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The URL path to the video thumbnail image.

hasBundles() → {Promise}

Returns a promise that is resolved once the remote locale bundles are retrieved from their remote locations. This is relevant for situations where proper location is required for a certain scenario (eg: sizes).

Source:

base/ripe.js, line 1570

Returns:

Type:: Promise

The promise to be fulfilled on the base locale bundles are loaded.

hasFrame(frame) → {Boolean}

Determines if the model currently loaded (in case there's one) has the provided frame available in spec. Notice that this call does not assure that a render is possible it only determines that according to model's spec it should be possible to render such a frame.

Source:

base/logic.js, line 222

Parameters:

Name	Type	Description
`frame`	`String`	The name of the frame to determine "renderability" according to the {face}-{index} format.

Returns:

Type:: Boolean

If it's possible to render such frame for the currently loaded model.

hasTag(tag) → {Boolean}

Verifies if the provided tag exists in the sequence of tags that are part of the currently loaded configuration.

Source:

base/config.js, line 14

Parameters:

Name	Type	Description
`tag`	`String`	The tag to be tested for presence in the currently loaded configuration.

Returns:

Type:: Boolean

If the tag exists in the tags section of the current configuration.

hasVideo(frame) → {Boolean}

Determines if the model currently loaded (in case there's one) has the provided video name available in spec. Notice that this call does not assure that a video showing is possible it only determines if according to the model's spec it should be possible to get such a video.

Source:

base/logic.js, line 250

Parameters:

Name	Type	Description
`frame`	`String`	The name of the video to determine if it is possible to show that video.

Returns:

Type:: Boolean

If it's possible to show the video for the currently loaded model.

importBulkOrder(name, orders, options, callback) → {XMLHttpRequest}

Creates a bulk order on RIPE Core.

Source:

api/bulk-order.js, line 418

Parameters:

Name	Type	Description
`name`	`String`	The name for the bulk order.
`orders`	`Array`	The list of the order IDs for the bulk order.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

importBulkOrderP(name, options, orders) → {Promise}

Creates a bulk order on RIPE Core.

Source:

api/bulk-order.js, line 434

Parameters:

Name	Type	Description
`name`	`String`	The name for the bulk order.
`options`	`Object`	An object of options to configure the request.
`orders`	`Array`	The list of the order IDs for the bulk order.

Returns:

Type:: Promise

The bulk order's data.

importOrder(ffOrderId, options, callback) → {XMLHttpRequest}

Imports a production order to RIPE Core.

Source:

api/order.js, line 1902

Parameters:

Name	Type	Description
`ffOrderId`	`Number`	The e-commerce order identifier.
`options`	`Object`	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']).
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

importOrderP(ffOrderId, options) → {Promise}

Imports a production order to RIPE Core.

Source:

api/order.js, line 1932

Parameters:

Name	Type	Description
`ffOrderId`	`Number`	The e-commerce order identifier.
`options`	`Object`	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:

Type:: Promise

The production order's data.

importOrderSimple(order, options, callback) → {XMLHttpRequest}

Imports a production order to RIPE Core. Simplified version accepting JSON payload and resolving defaults.

Source:

api/order.js, line 1949

Parameters:

Name	Type	Description
`order`	`Object`	The order payload.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

importOrderSimpleP(order, options) → {Promise}

Imports a production order to RIPE Core. Simplified version accepting JSON payload and resolving defaults.

Source:

api/order.js, line 1971

Parameters:

Name	Type	Description
`order`	`Object`	The order payload.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The imported order.

info(options, callback) → {XMLHttpRequest}

Retrieves summary information about the Core server-side (such as version, description and others).

Source:

base/api.js, line 56

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

infoP(options) → {Promise}

Retrieves summary information about the Core server-side (such as version, description and others).

Source:

base/api.js, line 75

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

Summary information of the RIPE server.

init()

The initializer of the class, to be called whenever the instance is going to become active. Sets the various values for the Ripe instance taking into account the provided configuration and defaulting values policy.

Source:

base/ripe.js, line 66

initialsConfig(config, profiles) → {Object}

Retrieves the initials config with the specified profiles in the config. If the `profiles` argument is provided those profiles will be also used to compute the initials config. This method implements the same logic as `initials_config` in the composition engine and should be kept in sync with that implementation.

Source:

base/config.js, line 53

Parameters:

Name	Type	Description
`config`	`Object`	The model's config.
`profiles`	`Array`	The list of profiles to use.

Returns:

Type:: Object

The computed initials config based on the config profiles and specified profiles.

installArtifact(name, version, options) → {XMLHttpRequest}

Installs a build artifact by build name and artifact version.

Source:

api/build.js, line 365

Parameters:

Name	Type	Description
`name`	`String`	The name of the build associated with the artifact.
`version`	`String`	The version of the build artifact.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

installArtifactP(name, version, options) → {Promise}

Installs a build artifact by build name and artifact version.

Source:

api/build.js, line 386

Parameters:

Name	Type	Description
`name`	`String`	The name of the build associated with the artifact.
`version`	`String`	The version of the build artifact.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The build install (as a promise).

installBuild(name, options) → {XMLHttpRequest}

Installs a build on the server from remote repos for the given name.

Source:

api/build.js, line 114

Parameters:

Name	Type	Description
`name`	`String`	The build's name to be installed.
`options`	`Object`	An object with options, such as: - 'version' - The version of the build to install, if no version is given, installs the latest one.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

installBuildP(name, options) → {Promise}

Installs a build on the server from remote repos for the given name.

Source:

api/build.js, line 142

Parameters:

Name	Type	Description
`name`	`String`	The build's name to be installed.
`options`	`Object`	An object with options, such as: - 'version' - The version of the build to install, if no version is given, installs the latest one.

Returns:

Type:: Promise

The build install (as a promise).

isOAuthPending() → {Boolean}

Checks if a successfully OAuth process has been fulfilled.

Source:

base/auth.js, line 53

Returns:

Type:: Boolean

Boolean representing if an OAuth process has been fulfilled.

isReady() → {Promise}

Returns a promise that is fulfilled once the Ripe Instance is ready to be used. This can be used to actively wait for the initialization of the Ripe Instance under an async environment.

Source:

base/ripe.js, line 1547

Returns:

Type:: Promise

The promise to be fulfilled once the instance is ready to be used.

lineBreak(options, callback) → {XMLHttpRequest}

Returns the lines of the text after line breaking logic is applied, using the profiles of the model of a brand.

Source:

api/brand.js, line 480

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'brand' - The name of the brand to be considered when validating. - 'model' - The name of the model to be considered when validating. - 'value' - The text from which will be broken into lines by the line breaking logic. - 'frame' - The frame to be used to get the size of the image. - 'profiles' - The profiles to be used when drawing the text.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The lines calculated by applying line break logic to the given value.

lineBreakP(options) → {Promise}

Returns the lines of the text after line breaking logic is applied, using the profiles of the model of a brand.

Source:

api/brand.js, line 501

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'brand' - The name of the brand to be considered when validating. - 'model' - The name of the model to be considered when validating. - 'value' - The text from which will be broken into lines by the line breaking logic. - 'frame' - The frame to be used to get the size of the image. - 'profiles' - The profiles to be used when drawing the text.

Returns:

Type:: Promise

Resulting information for the callback execution.

load() → {Object}

Explicit entry point to the initial update. This method should be called before any significant RIPE operation can be performed on the instance.

Source:

base/ripe.js, line 296

Returns:

Type:: Object

The current Ripe Instance (for pipelining).

loadP() → {Object}

Same as `load` but providing a promise oriented solution ready to be "awaited".

Source:

base/ripe.js, line 318

Returns:

Type:: Object

The current Ripe Instance (for pipelining).

locale_(value, locale, options, callback) → {XMLHttpRequest}

Localizes a value to the provided locale.

Source:

api/locale.js, line 13

Parameters:

Name	Type	Description
`value`	`String`	The value to be localized.
`locale`	`String`	The locale to localize the value to.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

localeBundle(locale, context, options, callback) → {XMLHttpRequest}

Retrieves a bundle of locales for the provided locale value.

Source:

api/locale.js, line 68

Parameters:

Name	Type	Description
`locale`	`String`	The locale string to retrieve the bundle.
`context`	`String`	The inner context for the locale bundle.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

localeColor(color, owner, options) → {String}

Localizes the given color string value.

Source:

base/logic.js, line 421

Parameters:

Name	Type	Description
`color`	`String`	The base string value to be used in the localization.
`owner`	`Object`	The localization owner, which should implement the proper localization provider functions. If not provided the default implementation which used the local base values is used instead.
`options`	`Object`	Set of options to control the localization, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'part' - The name of the part of the model. - 'material' - The name of the material of the model. - 'locale' - The ISO-15897 standard locale definition to be used in the localization process. - 'defaultValue' - The default string value (if any) to be returned in case it's not possible to localize the provided value. - 'prefixes' - The list of prefixes that are taking into account for proper build locale usage. - 'suffixes' - The list of suffixes that are taking into account for proper build locale usage.

Returns:

Type:: String

The final localized string, that takes into account the current model context.

localeLocal(value, fallback) → {String}

Runs a local based localization, meaning that the data source for the locale strings should be already loaded in memory. This means that the process should be immediate and not async.

Source:

base/logic.js, line 82

Parameters:

Name	Type	Description
`value`	`String`	The base value string that is going to be used for the localization process.
`fallback`	`String`	The fallback string (default) to be used in case no localization is possible.

Returns:

Type:: String

The final localized string or the fallback in case localization is not possible.

localeMaterial(color, owner, options) → {String}

Localizes the given material string value.

Source:

base/logic.js, line 372

Parameters:

Name	Type	Description
`color`	`String`	The base string value to be used in the localization.
`owner`	`Object`	The localization owner, which should implement the proper localization provider functions. If not provided the default implementation which used the local base values is used instead.
`options`	`Object`	Set of options to control the localization, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'part' - The name of the part of the model. - 'locale' - The ISO-15897 standard locale definition to be used in the localization process. - 'defaultValue' - The default string value (if any) to be returned in case it's not possible to localize the provided value. - 'prefixes' - The list of prefixes that are taking into account for proper build locale usage. - 'suffixes' - The list of suffixes that are taking into account for proper build locale usage.

Returns:

Type:: String

The final localized string, that takes into account the current model context.

localeModel(value, owner, options) → {String}

Localizes the given string value taking into account the current brand and model context so that proper prefixes are taking into account for proper build locale usage.

Source:

base/logic.js, line 283

Parameters:

Name	Type	Description
`value`	`String`	The base string value to be used in the localization.
`owner`	`Object`	The localization owner, which should implement the proper localization provider functions. If not provided the default implementation which used the local base values is used instead.
`options`	`Object`	Set of options to control the localization, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'locale' - The ISO-15897 standard locale definition to be used in the localization process. - 'defaultValue' - The default string value (if any) to be returned in case it's not possible to localize the provided value. - 'fallback' - If the fallback process should be used, meaning that if the requested locale is not available for the requested model (not part of the list of available locales) the base locale is going to be used instead (fallback process).

Returns:

Type:: String

The final localized string, that takes into account the current model context.

localeMultiple(values, locale, options, callback) → {XMLHttpRequest}

Localizes a list of values to the provided locale.

Source:

api/locale.js, line 34

Parameters:

Name	Type	Description
`values`	`String`	The values to be localized.
`locale`	`String`	The locale to localize the value to.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

localePart(color, owner, options) → {String}

Localizes the given part string value.

Source:

base/logic.js, line 326

Parameters:

Name	Type	Description
`color`	`String`	The base string value to be used in the localization.
`owner`	`Object`	The localization owner, which should implement the proper localization provider functions. If not provided the default implementation which used the local base values is used instead.
`options`	`Object`	Set of options to control the localization, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'locale' - The ISO-15897 standard locale definition to be used in the localization process. - 'defaultValue' - The default string value (if any) to be returned in case it's not possible to localize the provided value. - 'prefixes' - The list of prefixes that are taking into account for proper build locale usage. - 'suffixes' - The list of suffixes that are taking into account for proper build locale usage.

Returns:

Type:: String

The final localized string, that takes into account the current model context.

localeProperty(color, owner, options) → {String}

Localizes the given property string value.

Source:

base/logic.js, line 472

Parameters:

Name	Type	Description
`color`	`String`	The base string value to be used in the localization.
`owner`	`Object`	The localization owner, which should implement the proper localization provider functions. If not provided the default implementation which used the local base values is used instead.
`options`	`Object`	Set of options to control the localization, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'type' - The type of the property. - 'locale' - The ISO-15897 standard locale definition to be used in the localization process. - 'defaultValue' - The default string value (if any) to be returned in case it's not possible to localize the provided value. - 'prefixes' - The list of prefixes that are taking into account for proper build locale usage. - 'suffixes' - The list of suffixes that are taking into account for proper build locale usage.

Returns:

Type:: String

The final localized string, that takes into account the current model context.

localeToNative(scale, value, gender, options, callback) → {XMLHttpRequest}

Converts a locale size value in the specified scale to the corresponding native size. The available scales, genders and sizes can be obtained with the method `getSizes`.

Source:

api/size.js, line 355

Parameters:

Name	Type	Description
`scale`	`String`	The scale which one wants to convert from.
`value`	`Number`	The value which one wants to convert.
`gender`	`String`	The gender of the scale and value to be converted.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

localeToNativeB(scales, values, genders, options, callback) → {XMLHttpRequest}

Converts multiple locale size values to the corresponding native size. The available scales, genders and sizes can be obtained with the method `getSizes`.

Source:

api/size.js, line 391

Parameters:

Name	Type	Description
`scales`	`Array`	A list of scales to convert from.
`values`	`Array`	A list of values to convert.
`genders`	`Array`	A list of genders corresponding to the values.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

logOrder(number, options, callback) → {XMLHttpRequest}

Returns all the states (logs) of an order.

Source:

api/order.js, line 557

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

logOrderP(number, options) → {Promise}

Returns all the states of an order.

Source:

api/order.js, line 577

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The states of an order requested by number.

nativeToLocale(scale, value, gender, options, callback) → {XMLHttpRequest}

Converts a native size value in the specified scale to the corresponding localized size. The available scales, genders and sizes can be obtained with the method `getSizes`.

Source:

api/size.js, line 280

Parameters:

Name	Type	Description
`scale`	`String`	The scale which one wants to convert from.
`value`	`Number`	The value which one wants to convert.
`gender`	`String`	The gender of the scale and value to be converted.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

nativeToLocaleB(scales, values, genders, options, callback) → {XMLHttpRequest}

Converts multiple native size values to the corresponding localized size. The available scales, genders and sizes can be obtained with the method `getSizes`.

Source:

api/size.js, line 316

Parameters:

Name	Type	Description
`scales`	`Array`	A list of scales to convert from.
`values`	`Array`	A list of values to convert.
`genders`	`Array`	A list of genders corresponding to the values.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

nativeToSize(scale, value, gender, options, callback) → {XMLHttpRequest}

Converts a size value in the specified scale to the corresponding native size. The available scales, genders and sizes can be obtained with the method `getSizes`.

Source:

api/size.js, line 125

Parameters:

Name	Type	Description
`scale`	`String`	The scale which one wants to convert from.
`value`	`Number`	The value which one wants to convert.
`gender`	`String`	The gender of the scale and value to be converted.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

nativeToSizeB(scales, values, genders, options, callback) → {XMLHttpRequest}

Converts multiple size values to the corresponding native size. The available scales, genders and sizes can be obtained with the method `getSizes`.

Source:

api/size.js, line 161

Parameters:

Name	Type	Description
`scales`	`Array`	A list of scales to convert from.
`values`	`Array`	A list of values to convert.
`genders`	`Array`	A list of genders corresponding to the values.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

normalizeEngraving(engraving, properties) → {string}

Normalizes the provided engraving (material) value according to the expected standard, producing a sequence of dictionaries containing the resulting property values.

Source:

base/logic.js, line 204

Parameters:

Name	Type	Description
`engraving`	`String`	The engraving to be normalized.
`properties`	`Array`	If provided overrides the default loaded config initials strategy for the retrieval of properties definition.

Returns:

Type:: string

The normalized engraving value.

normalizeParts(parts) → {Object}

Normalizes the parts dictionary by taking into account optional parts that should be set even for empty situations.

Source:

base/ripe.js, line 1606

Parameters:

Name	Type	Description
`parts`	`Object`	The parts object that should be cloned and then ensured to have the optional parts set.

Returns:

Type:: Object

A copy of the provided parts with the optional parts set even if not defined.

oauth(options, callback) → {oauthAccessToken}

Responsible for the beginning of the OAuth based authentication process may either start the redirection process (in case no valid token is found) or try to revalidate the session with the currently existing tokens or session ID.

Source:

base/auth.js, line 261

Parameters:

Name	Type	Description
`options`	`Object`	The set of options used for the OAuth process, should include client identifier and secret.
`callback`	`function`	The callback to be called once the logging or the access token retrieval functions are finished.

Returns:

Type:: oauthAccessToken

Either an invalid/unset value or the result of the login operation.

oauthAccessToken(code, options, callback) → {XMLHttpRequest}

Retrieves the complete set of OAuth elements to be used, such as: the access_token, token_type, expires_in, refresh_token, scope and tokens. Notice that both the scope and the tokens are retrieved providing the ability to modify experience taking that into account.

Source:

api/oauth.js, line 16

Parameters:

Name	Type	Description
`code`	`String`	The OAuth code.
`options`	`Object`	An object of options to configure the request, such as 'code', 'clientId', 'clientSecret', 'redirectUri' and the 'grantType'.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

oauthLogin(accessToken, options, callback) → {XMLHttpRequest}

Retrieves the session identifier (SID) for the currently active session, this is going to be used on all requests to refer to the proper session.

Source:

api/oauth.js, line 45

Parameters:

Name	Type	Description
`accessToken`	`String`	The access token to be used.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

onConfig(options, callback) → {XMLHttpRequest}

Server side callback method to be called for situations where a customization for a model has been started. This method allows the change of the current context of execution based on a server side implementation of the 3DB's business logic.

Source:

api/brand.js, line 607

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

onConfigP(options) → {Promise}

Server side callback method to be called for situations where a customization for a model has been started. This method allows the change of the current context of execution based on a server side implementation of the 3DB's business logic.

Source:

api/brand.js, line 626

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model.

Returns:

Type:: Promise

Resulting information for the callback execution.

onInitials(options, callback) → {XMLHttpRequest}

Server side callback method to be called for situations where the initials or engraving values were changed. This method allows the change of the current context of execution based on a server side implementation of the 3DB's business logic.

Source:

api/brand.js, line 686

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'group' - The name of the group that is going to be changed. - 'value' - The initials value to be changed. - 'engraving' - The engraving value to be changed.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

onInitialsP(options) → {Promise}

Server side callback method to be called for situations where the initials or engraving values were changed. This method allows the change of the current context of execution based on a server side implementation of the 3DB's business logic.

Source:

api/brand.js, line 706

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'group' - The name of the group that is going to be changed. - 'value' - The initials value to be changed. - 'engraving' - The engraving value to be changed.

Returns:

Type:: Promise

Resulting information for the callback execution.

onPart(options, callback) → {XMLHttpRequest}

Server side callback method to be called for situations where a customization change was made on a part. This method allows the change of the current context of execution based on a server side implementation of the 3DB's business logic.

Source:

api/brand.js, line 646

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'name' - The name of the part to be changed. - 'value' - The value (material and color) of the part to be changed.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

onPartP(options) → {Promise}

Server side callback method to be called for situations where a customization change was made on a part. This method allows the change of the current context of execution based on a server side implementation of the 3DB's business logic.

Source:

api/brand.js, line 665

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'name' - The name of the part to be changed. - 'value' - The value (material and color) of the part to be changed.

Returns:

Type:: Promise

Resulting information for the callback execution.

parseEngraving(engraving, properties) → {Object}

Parses the provided normalized engraving string according to the standard `:` format, using the loaded configurations. The provided string may not be normalized but for that situation typical guessing heuristics are going to be applied.

Source:

base/logic.js, line 120

Parameters:

Name	Type	Description
`engraving`	`String`	The engraving string to be parsed.
`properties`	`Array`	If provided overrides the default loaded config initials strategy for the retrieval of properties definition.

Returns:

Type:: Object

Returns an object with values and valuesM. valuesM is a map with (key = type, value = name) entries for each property defined in the engraving, where "type" is the type of the property (e.g. style) and "name" is the value for that property (e.g. gold) as defined in the engraving parameter. values is a list of (type, name) that respects the order of the properties.

ping(options, callback) → {XMLHttpRequest}

Runs a simple "ping" operation to validate the connection with the Core server-side.

Source:

base/api.js, line 28

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

precustomizationOrder(ffId, options, callback) → {XMLHttpRequest}

Setups a pre-customization on RIPE Core.

Source:

api/order.js, line 1999

Parameters:

Name	Type	Description
`ffId`	`Number`	The concrete identifier of the pre-customization, may represent just an entry point for a pre-customized product (used for mapping).
`options`	`Object`	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']).
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

precustomizationOrderP(ffId, options) → {Promise}

Setups a pre-customization on RIPE Core.

Source:

api/order.js, line 2026

Parameters:

Name	Type	Description
`ffId`	`Number`	The concrete identifier of the pre-customization, may represent just an entry point for a pre-customized product (used for mapping).
`options`	`Object`	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:

Type:: Promise

The production order's data.

produceBulkOrder(number, options, callback) → {XMLHttpRequest}

Sets the bulk order status to 'produce'.

Source:

api/bulk-order.js, line 145

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

produceBulkOrderP(number, options, callback) → {Promise}

Sets the bulk order status to 'produce'.

Source:

api/bulk-order.js, line 157

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The update bulk order.

produceOrder(number, options, callback) → {XMLHttpRequest}

Sets the order status to 'produce'.

Source:

api/order.js, line 1265

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

produceOrderP(number, options, callback) → {Promise}

Sets the order status to 'produce'.

Source:

api/order.js, line 1277

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The order with the updated status.

qualityAssureBulkOrder(number, options, callback) → {XMLHttpRequest}

Sets the bulk order status to 'quality_assure'.

Source:

api/bulk-order.js, line 173

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

qualityAssureBulkOrderP(number, options, callback) → {Promise}

Sets the bulk order status to 'quality_assure'.

Source:

api/bulk-order.js, line 185

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The update bulk order.

qualityAssureOrder(number, options, callback) → {XMLHttpRequest}

Sets the order status to 'quality_assure'.

Source:

api/order.js, line 1293

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

qualityAssureOrderP(number, options, callback) → {Promise}

Sets the order status to 'quality_assure'.

Source:

api/order.js, line 1305

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The order with the updated status.

readyBulkOrder(number, options, callback) → {XMLHttpRequest}

Sets the bulk order status to 'ready'.

Source:

api/bulk-order.js, line 229

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

readyBulkOrderP(number, options, callback) → {Promise}

Sets the bulk order status to 'ready'.

Source:

api/bulk-order.js, line 241

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The update bulk order.

readyOrder(number, options, callback) → {XMLHttpRequest}

Sets the order status to 'ready'.

Source:

api/order.js, line 1349

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

readyOrderP(number, options, callback) → {Promise}

Sets the order status to 'ready'.

Source:

api/order.js, line 1361

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The order with the updated status.

readyShipment(number, options, callback) → {XMLHttpRequest}

Sets the shipment status to 'ready'.

Source:

api/shipment.js, line 347

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

readyShipmentP(number, options, callback) → {Promise}

Sets the shipment status to 'ready'.

Source:

api/shipment.js, line 359

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The shipment with the updated status.

receiveBulkOrder(number, options, callback) → {XMLHttpRequest}

Sets the bulk order status to 'receive'.

Source:

api/bulk-order.js, line 333

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

receiveBulkOrderP(number, options, callback) → {Promise}

Sets the bulk order status to 'receive'.

Source:

api/bulk-order.js, line 345

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The update bulk order.

receiveOrder(number, options, callback) → {XMLHttpRequest}

Sets the order status to 'receive'.

Source:

api/order.js, line 1441

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

receiveOrderP(number, options, callback) → {Promise}

Sets the order status to 'receive'.

Source:

api/order.js, line 1453

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The order with the updated status.

redo()

Reapplies the last change to the parts that was undone. Notice that if there's a change when the history pointer is in the middle of the stack the complete stack forward is removed (history re-written).

Source:

base/ripe.js, line 1493

redoAll()

Executes the same operation as `redo` but goes all the way to the top of the stack that controls the history.

Source:

base/ripe.js, line 1507

refreshShippingOrder(number, options, callback) → {XMLHttpRequest}

Manually trigger an order shipping info refresh.

Source:

api/order.js, line 521

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to refresh the shipping info.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

refreshShippingOrderP(number, options) → {Promise}

Manually trigger an order shipping info refresh.

Source:

api/order.js, line 541

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to refresh the shipping info.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The order requested by number.

refreshShippingShipment(number, options, callback) → {XMLHttpRequest}

Manually trigger a shipment shipping status refresh.

Source:

api/shipment.js, line 965

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to refresh the shipping status.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

refreshShippingShipmentP(number, options) → {Promise}

Manually trigger a shipment shipping status refresh.

Source:

api/shipment.js, line 985

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to refresh the shipping status.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The contents of the requested status update.

rejectBulkOrder(number, options, callback) → {XMLHttpRequest}

Sets the bulk order status to 'reject'.

Source:

api/bulk-order.js, line 201

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

rejectBulkOrderP(number, options, callback) → {Promise}

Sets the bulk order status to 'reject'.

Source:

api/bulk-order.js, line 213

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The update bulk order.

rejectOrder(number, options, callback) → {XMLHttpRequest}

Sets the order status to 'reject'.

Source:

api/order.js, line 1321

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

rejectOrderP(number, options, callback) → {Promise}

Sets the order status to 'reject'.

Source:

api/order.js, line 1333

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The order with the updated status.

removeBundle(bundle, locale)

Removes the given set of locale strings from the globally defined locale registry.

Source:

base/logic.js, line 37

Parameters:

Name	Type	Description
`bundle`	`Object`	The locale strings bundle that is going to be globally removed.
`locale`	`String`	The ISO 639-1 based locale identifier in the underscore based form to be used in removal.

removeDeviceId(deviceId) → {XMLHttpRequest}

Removes a device ID from the the notify info instance associated with the user in session.

Source:

api/notify-info.js, line 49

Parameters:

Name	Type	Description
`deviceId`	`String`	The device identifier to be removed.

Returns:

Type:: XMLHttpRequest

The current user's notify info instance.

removeDeviceIdP(deviceId) → {Promise}

Removes a device ID from the the notify info instance associated with the user in session.

Source:

api/notify-info.js, line 70

Parameters:

Name	Type	Description
`deviceId`	`String`	The device identifier to be removed.

Returns:

Type:: Promise

The current user's notify info instance.

removePlugin(plugin)

Unregisters a plugin to this Ripe instance.

Source:

base/ripe.js, line 1592

Parameters:

Name	Type	Description
`plugin`	`Plugin`	The plugin to be unregistered.

resolveInvoiceRule(brand, model, country, size, options, callback) → {XMLHttpRequest}

Gets an existing invoice rule filtered by brand, model, country and size.

Source:

api/invoice-rule.js, line 199

Parameters:

Name	Type	Description
`brand`	`String`	The invoice rule's brand.
`model`	`String`	The invoice rule's model.
`country`	`String`	The invoice rule's country.
`size`	`Number`	The invoice rule's size.
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

resolveInvoiceRuleP(brand, model, country, size, options) → {Promise}

Gets an existing invoice rule filtered by brand, model and country.

Source:

api/invoice-rule.js, line 236

Parameters:

Name	Type	Description
`brand`	`String`	The invoice rule's brand.
`model`	`String`	The invoice rule's model.
`country`	`String`	The invoice rule's country.
`size`	`Number`	The invoice rule's size.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The invoice rule requested by brand, model and country.

resolveJustification(options, callback) → {XMLHttpRequest}

Gets the matching justification based on context and code or on a full code, if it exists.

Source:

api/justification.js, line 55

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

resolveJustificationP(options) → {Promise}

Gets the matching justification based on context and code or on a full code, if it exists.

Source:

api/justification.js, line 75

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The justification that better matches the provided parameters.

resolveTransportRule(brand, model, country, factory, size, options, callback) → {XMLHttpRequest}

Gets an existing transport rule filtered by brand, model, country, factory and size.

Source:

api/transport-rule.js, line 200

Parameters:

Name	Type	Description
`brand`	`String`	The transport rule's brand.
`model`	`String`	The transport rule's model.
`country`	`String`	The transport rule's country.
`factory`	`String`	The transport rule's factory.
`size`	`Number`	The transport rule's size.
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

resolveTransportRuleP(brand, model, country, factory, size, options) → {Promise}

Gets an existing transport rule filtered by brand, model, country, factory and size.

Source:

api/transport-rule.js, line 249

Parameters:

Name	Type	Description
`brand`	`String`	The transport rule's brand.
`model`	`String`	The transport rule's model.
`country`	`String`	The transport rule's country.
`factory`	`String`	The transport rule's factory.
`size`	`Number`	The transport rule's size.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The transport rule requested by brand, model and country.

returnBulkOrder(number, options, callback) → {XMLHttpRequest}

Sets the bulk order status to 'return'.

Source:

api/bulk-order.js, line 361

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

returnBulkOrderP(number, options, callback) → {Promise}

Sets the bulk order status to 'return'.

Source:

api/bulk-order.js, line 373

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The update bulk order.

returnOrder(number, options, callback) → {XMLHttpRequest}

Sets the order status to 'return'.

Source:

api/order.js, line 1469

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

returnOrderP(number, options, callback) → {Promise}

Sets the order status to 'return'.

Source:

api/order.js, line 1481

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The order with the updated status.

returnShipment(number, options, callback) → {XMLHttpRequest}

Sets the shipment status to 'returned'.

Source:

api/shipment.js, line 487

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

returnShipmentP(number, options, callback) → {Promise}

Sets the shipment status to 'returned'.

Source:

api/shipment.js, line 499

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The shipment with the updated status.

runLogic(options, callback) → {XMLHttpRequest}

Returns the result of the execution of the given method for the logic script of a model. Does this by running the provided method on the server side under a proper "sandboxed" environment.

Source:

api/brand.js, line 565

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'version' - The version of the build, defaults to latest. - 'method' - The method of the logic module of the model. - 'data' - The arguments to pass to the method.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The result of the logic function of the provided model.

runLogicP(options) → {Promise}

Returns the result of the execution of the given method for the logic script of a model. Does this by running the provided method on the server side under a proper "sandboxed" environment.

Source:

api/brand.js, line 587

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'version' - The version of the build, defaults to latest. - 'method' - The method of the logic module of the model. - 'data' - The arguments to pass to the method.

Returns:

Type:: Promise

The result of the logic function of the provided model.

searchOrders(filterString, options, callback) → {XMLHttpRequest}

Searches for orders using the filter string and the options that are provided.

Source:

api/order.js, line 1194

Parameters:

Name	Type	Description
`filterString`	`String`	An unstructured string to be used in the orders search operation.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

searchOrdersP(filterString, options) → {Promise}

Searches for orders using the filter string and the options that are provided.

Source:

api/order.js, line 1221

Parameters:

Name	Type	Description
`filterString`	`String`	An unstructured string to be used in the orders search operation.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The result of the order deletion.

selectPart(part, options)

Selects a part of the model. Triggers a 'selected_part' event with the part.

Source:

base/ripe.js, line 1271

Parameters:

Name	Type	Description
`part`	`String`	The name of the part to be selected.
`options`	`Object`	An Object with options to configure the operation.

sendBulkOrder(number, options, callback) → {XMLHttpRequest}

Sets the bulk order status to 'sent'.

Source:

api/bulk-order.js, line 257

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

sendBulkOrderP(number, options, callback) → {Promise}

Sets the bulk order status to 'sent'.

Source:

api/bulk-order.js, line 283

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The update bulk order.

sendOrder(number, options, callback) → {XMLHttpRequest}

Sets the order status to 'sent'.

Source:

api/order.js, line 1377

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

sendOrderP(number, options, callback) → {Promise}

Sets the order status to 'sent'.

Source:

api/order.js, line 1397

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The order with the updated status.

sendShipment(number, options, callback) → {XMLHttpRequest}

Sets the shipment status to 'sent'.

Source:

api/shipment.js, line 375

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

sendShipmentP(number, options, callback) → {Promise}

Sets the shipment status to 'sent'.

Source:

api/shipment.js, line 387

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to update.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The shipment with the updated status.

setBackgroundColor(backgroundColor, override, update)

Updates the background color setting for the current ripe instance, propagating the change to any interested child. Optionally an update operation may be performed so that the background background color changes are reflected in the user interface.

Source:

base/ripe.js, line 1142

Parameters:

Name	Type	Description
`backgroundColor`	`String`	The background color in hexadecimal to be set.
`override`	`Boolean`	If the options value should be override meaning that further config updates will have this new format set.
`update`	`Boolean`	If an update operation should be perform asynchronous.

setBulkOrderStatus(number, status, options, callback) → {XMLHttpRequest}

Sets the bulk order status to the one given.

Source:

api/bulk-order.js, line 93

Parameters:

Name	Type	Description
`number`	`Number`	The number of the bulk order to update.
`status`	`String`	The new status of the bulk order.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

setChoices(choices, events)

Updates the current internal state for parts material and colors, properly notifying any "listener" about these changes.

Source:

base/ripe.js, line 1021

Parameters:

Name	Type	Description
`choices`	`Object`	The object that contains the state for every single part, material, and color.
`events`	`Boolean`	If the choices events should be triggered (defaults to 'true').

setCtx(ctx)

Changes the current base context object (ctx) that is going to be sent for (3D) build logic on crucial workflow state changes.

Source:

base/ripe.js, line 986

Parameters:

Name	Type	Description
`ctx`	`Object`	The new base context to be used.

setFormat(format, override, update)

Updates the format setting for the current ripe instance, propagating the change to any interested child. Optionally an update operation may be performed so that the format changes are reflected in the user interface.

Source:

base/ripe.js, line 1094

Parameters:

Name	Type	Description
`format`	`String`	The image format to be used in the ripe instance (eg: png, webp, jpeg).
`override`	`Boolean`	If the options value should be override meaning that further config updates will have this new format set.
`update`	`Boolean`	If an update operation should be perform asynchronous.

setInitials(initials, engraving, events, override, params)

Changes the initials of the model, this is considered a simple legacy oriented strategy as the `setInitialsExtra` method should be used for more complex scenarios with multiple groups.

Source:

base/ripe.js, line 799

Parameters:

Name	Type	Description
`initials`	`String`	The initials value to be set.
`engraving`	`String`	The type of engraving to be set.
`events`	`Boolean`	If the events associated with the initials change should be triggered.
`override`	`Boolean`	If the options value should be override meaning that further config updates will have this new initials set.
`params`	`Object`	Extra parameters that control the behaviour of the set initials operation.

setInitialsExtra(initialsExtra, events, override, params)

Changes the initials of the model using an object as the input which allows setting the initials for multiple groups at the same time.

Source:

base/ripe.js, line 889

Parameters:

Name	Type	Description
`initialsExtra`	`Object`	Object that contains the values of the initials and engraving for all the initial groups.
`events`	`Boolean`	If the events associated with the changing of the initials (extra) should be triggered.
`override`	`Boolean`	If the options value should be override meaning that further config updates will have this new initials extra set.
`params`	`Object`	Extra parameters that control the behaviour of the set initials operation.

setMeta(number, key, value, options, callback) → {XMLHttpRequest}

Changes an entry of an order's meta adding the new meta entry according to the provided value or changing an existing one.

Source:

api/order.js, line 1530

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to change the meta.
`key`	`String`	The key to set.
`value`	`Object`	The value to set, which might be of any type (string, number, object or list), providing a `null` value deletes the key.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

setMetaP(number, key, value, options) → {Promise}

Changes an entry of an order's meta adding the new meta entry according to the provided value or changing an existing one.

Source:

api/order.js, line 1559

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to change the meta.
`key`	`String`	The key to set.
`value`	`Object`	The value to set, which might be of any type (string, number, object or list), providing a `null` value deletes the key.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The result of the order meta change.

setOptions(options)

Sets Ripe instance options according to the defaulting policy.

Source:

base/ripe.js, line 631

Parameters:

Name	Type	Description
`options`	`Object`	An object with the options to configure the Ripe instance, such as: - 'variant' - The variant of the model. - 'version' - The version of the model, obtained from the containing build. - 'dku' - The DKU (Dynamic Keeping Unit) to be used in the configuration (if any). - 'parts' - The initial parts of the model. - 'country' - The country where the model will be sold. - 'currency' - The currency that should be used to calculate the price. - 'locale' - The locale to be used by default when localizing values. - 'flag' - A specific attribute of the model. - 'format' - The format of the image that is going to be retrieved in case of image visual and interactive. - 'size' - The default size in pixels to be used by children for composition. - 'backgroundColor' - The background color in RGB format to be used for images. - 'guess' - If the optimistic guess mode should be used for config resolution (internal). - 'guessUrl' - If base production URL should be guessed using GeoIP information. - 'remoteCalls' - If the remote calls (eg: 'on_config') should be called in the middle of configuration. - 'useBundles' - If the bundles should be loaded during initial loading. - 'useDefaults' - If the default parts of the model should be used when no initials parts are set. - 'useCombinations' - If the combinations should be loaded as part of the initial RIPE loading. - 'usePrice' - If the price should be automatically retrieved whenever there is a customization change. - 'useDiag' - If the diagnostics module should be used.

setPart(part, material, color, events, options)

Changes the material and color of the provided part. This operations is an expensive one and should be used carefully to avoid unwanted resource usage. If many operations are meant to be used at the same time the `setParts` parts method should be used instead, as it is better suited for bulk based operations.

Source:

base/ripe.js, line 720

Parameters:

Name	Type	Description
`part`	`String`	The name of the part to be changed.
`material`	`String`	The material to change to.
`color`	`String`	The color to change to.
`events`	`Boolean`	If the parts events should be triggered (defaults to 'true').
`options`	`Object`	The options to be used in the set part operations (for internal use).

setParts(parts, events, options)

Allows changing the customization of a set of parts in bulk.

Source:

base/ripe.js, line 753

Parameters:

Name	Type	Description
`parts`	`Object`	An Object or array with part, material, color triplets to be set.
`events`	`Boolean`	If the parts events should be triggered (defaults to 'true').
`options`	`Object`	An object with options to configure the operation (for internal use).

setPickup(number, pickupNumber, options, callback) → {XMLHttpRequest}

Changes the pickup reference number of an order.

Source:

api/order.js, line 1806

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to change the pickup reference number.
`pickupNumber`	`String`	The new pickup reference number.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

setPickupP(number, pickupNumber, options) → {Promise}

Changes the pickup reference number of an order.

Source:

api/order.js, line 1830

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to change the pickup reference number.
`pickupNumber`	`String`	The new pickup reference number.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The result of the order tracking info change.

setPriority(number, priority, options, callback) → {XMLHttpRequest}

Changes the priority of an order.

Source:

api/order.js, line 1576

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to change the priority.
`priority`	`Number`	The new priority.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

setPriorityP(number, priority, options) → {Promise}

Changes the priority of an order.

Source:

api/order.js, line 1600

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to change the priority.
`priority`	`Number`	The new priority.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The result of the order priority change.

setProofOfDelivery(number, proofOfDeliveryUrl, options, callback) → {XMLHttpRequest}

Changes the proof of delivery info of an order.

Source:

api/order.js, line 1847

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to change the proof of delivery info.
`proofOfDeliveryUrl`	`String`	The new proof of delivery URL.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

setProofOfDeliveryP(number, proofOfDeliveryUrl, options) → {Promise}

Changes the proof of delivery info of an order.

Source:

api/order.js, line 1871

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to change the proof of delivery info.
`proofOfDeliveryUrl`	`String`	The new proof of delivery URL.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The result of the order proof of delivery info change.

setReturnTracking(number, returnTrackingNumber, returnTrackingUrl, options, callback) → {XMLHttpRequest}

Changes the return tracking info of an order.

Source:

api/order.js, line 1674

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to change the return tracking info.
`returnTrackingNumber`	`String`	The new return tracking number.
`returnTrackingUrl`	`String`	The new return tracking URL.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

setReturnTrackingP(number, returnTrackingNumber, returnTrackingUrl, options) → {Promise}

Changes the return tracking info of an order.

Source:

api/order.js, line 1706

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to change the return tracking info.
`returnTrackingNumber`	`String`	The new return tracking number.
`returnTrackingUrl`	`String`	The new return tracking URL.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The result of the order tracking info change.

setSize(size, override, update)

Updates the size setting for the current ripe instance, propagating the change to any interested child. Optionally an update operation may be performed so that the size changes are reflected in the user interface.

Source:

base/ripe.js, line 1118

Parameters:

Name	Type	Description
`size`	`String`	The size (in pixels) of the image to be used.
`override`	`Boolean`	If the options value should be override meaning that further config updates will have this new format set.
`update`	`Boolean`	If an update operation should be perform asynchronous.

setStructure(structure, safe)

Updates the current internal state of the Ripe instance with the contents defined by the provided structure (snapshot).

Source:

base/ripe.js, line 585

Parameters:

Name	Type	Description
`structure`	`Object`	The object structure that represents the configuration "situation" that is going to be set in the Ripe instance.
`safe`	`Boolean`	If the operation should be performed using a safe strategy (deep copy in objects).

setTracking(number, trackingNumber, trackingUrl, options, callback) → {XMLHttpRequest}

Changes the tracking info of an order.

Source:

api/order.js, line 1618

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to change the tracking info.
`trackingNumber`	`String`	The new tracking number.
`trackingUrl`	`String`	The new tracking URL.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

setTrackingP(number, trackingNumber, trackingUrl, options) → {Promise}

Changes the tracking info of an order.

Source:

api/order.js, line 1650

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to change the tracking info.
`trackingNumber`	`String`	The new tracking number.
`trackingUrl`	`String`	The new tracking URL.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The result of the order tracking info change.

Retrieves the complete set of session elements to be used, such as: the 'sid ', 'session_id', 'username ', 'name', 'email' and 'tokens'.

Source:

base/api.js, line 126

Parameters:

Name	Type	Description
`username`	`String`	The username to authenticate.
`password`	`String`	The username's password.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

signinAdmin(username, password, options, callback) → {XMLHttpRequest}

Retrieves the complete set of session elements to be used, such as: the 'sid ', 'session_id', 'username ', 'name', 'email' and 'tokens'. This strategy uses the admin back-end for authentication.

Source:

base/api.js, line 162

Parameters:

Name	Type	Description
`username`	`String`	The username to authenticate.
`password`	`String`	The username's password.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

signinPid(token, options, callback) → {XMLHttpRequest}

Retrieves the complete set of session elements to be used, such as: the 'sid ', 'session_id', 'username ', 'name', 'email'.

Source:

base/api.js, line 197

Parameters:

Name	Type	Description
`token`	`String`	The authentication token.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

sizeToLocale(scale, value, gender, options, callback) → {XMLHttpRequest}

Converts a size value in the specified scale to the corresponding localized size. The available scales, genders and sizes can be obtained with the method `getSizes`.

Source:

api/size.js, line 205

Parameters:

Name	Type	Description
`scale`	`String`	The scale which one wants to convert from.
`value`	`Number`	The value which one wants to convert.
`gender`	`String`	The gender of the scale and value to be converted.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

sizeToLocaleB(scales, values, genders, options, callback) → {XMLHttpRequest}

Converts multiple size values to the corresponding localized size. The available scales, genders and sizes can be obtained with the method `getSizes`.

Source:

api/size.js, line 241

Parameters:

Name	Type	Description
`scales`	`Array`	A list of scales to convert from.
`values`	`Array`	A list of values to convert.
`genders`	`Array`	A list of genders corresponding to the values.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

sizeToNative(scale, value, gender, options, callback) → {XMLHttpRequest}

Converts a size value from the native scale to the corresponding value in the specified scale. The available scales, genders and sizes can be obtained with the method `getSizes`.

Source:

api/size.js, line 44

Parameters:

Name	Type	Description
`scale`	`String`	The scale which one wants to convert to.
`value`	`Number`	The value which one wants to convert.
`gender`	`String`	The gender of the scale and value to be converted.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

sizeToNativeB(scales, values, genders, options, callback) → {XMLHttpRequest}

Converts multiple size values from the native scale to the corresponding values in the specified scales. The available scales, genders and sizes can be obtained with the method `getSizes`.

Source:

api/size.js, line 81

Parameters:

Name	Type	Description
`scales`	`Array`	A list of scales to convert to.
`values`	`Array`	A list of values to convert.
`genders`	`Array`	A list of genders corresponding to the values.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

stateAttachmentOrder(number, stateId, attachmentId, options, callback) → {XMLHttpRequest}

Gets the attachment with a specific ID of an order for a specific state.

Source:

api/order.js, line 1140

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`stateId`	`Number`	The ID of the state of the order to find by.
`attachmentId`	`Number`	The ID of the attachment to find.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

stateAttachmentOrderP(number, stateId, attachmentId, options, callback) → {Promise}

Gets the attachment with a specific ID of an order for a specific state.

Source:

api/order.js, line 1170

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`stateId`	`Number`	The ID of the state of the order to find by.
`attachmentId`	`Number`	The ID of the attachment to find.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The attachment file requested by ID.

stateAttachmentsCountOrder(number, stateId, options, callback) → {XMLHttpRequest}

Returns the number of attachments of an order for a specific state.

Source:

api/order.js, line 1044

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`stateId`	`Number`	The ID of the state of the order to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

stateAttachmentsCountOrderP(number, stateId, options, callback) → {Promise}

Returns the number of attachments of an order for a specific state.

Source:

api/order.js, line 1067

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`stateId`	`Number`	The ID of the state of the order to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

An object containing the number of attachments.

stateAttachmentsOrder(number, stateId, options, callback) → {XMLHttpRequest}

Returns all the attachments of an order for a specific state.

Source:

api/order.js, line 1004

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`stateId`	`Number`	The ID of the state of the order to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

stateAttachmentsOrderP(number, stateId, options, callback) → {Promise}

Returns all the attachments of an order for a specific state.

Source:

api/order.js, line 1027

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`stateId`	`Number`	The ID of the state of the order to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

All the attachments of a specific order and state.

stateChatCreateLineOrder(number, stateId, contents, options, callback) → {XMLHttpRequest}

Adds a new chat line message to a specific order for a specific state.

Source:

api/order.js, line 949

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order where the chat line message will be added.
`stateId`	`Number`	The ID of the state of the order where the chat line message will be added.
`contents`	`Object`	The contents of the chat message.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

stateChatCreateLineOrderP(number, stateId, contents, options, callback) → {Promise}

Adds a new chat line message to a specific order for a specific state.

Source:

api/order.js, line 981

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order where the chat line message will be added.
`stateId`	`Number`	The ID of the state of the order where the chat line message will be added.
`contents`	`Object`	The contents of the chat message.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

An object containing the chat lines for the specific state.

stateChatLinesCountOrder(number, stateId, options, callback) → {XMLHttpRequest}

Returns the number of chat lines of an order for a specific state.

Source:

api/order.js, line 908

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`stateId`	`Number`	The ID of the state of the order to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

stateChatLinesCountOrderP(number, stateId, options, callback) → {Promise}

Returns the number of chat lines of an order for a specific state.

Source:

api/order.js, line 931

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`stateId`	`Number`	The ID of the state of the order to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

An object containing the number of chat lines for a specific state.

stateChatLinesOrder(number, stateId, options, callback) → {XMLHttpRequest}

Returns all the chat lines of an order for a specific state.

Source:

api/order.js, line 868

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`stateId`	`Number`	The ID of the state of the order to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

stateChatLinesOrderP(number, stateId, options, callback) → {Promise}

Returns all the chat lines of an order for a specific state.

Source:

api/order.js, line 891

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`stateId`	`Number`	The ID of the state of the order to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

An object containing the chat lines for a specific state.

stateChatOrder(number, stateId, options, callback) → {XMLHttpRequest}

Returns the chat name and lines of an order for a specific state.

Source:

api/order.js, line 828

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`stateId`	`Number`	The ID of the state of the order to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

stateChatOrderP(number, stateId, options, callback) → {Promise}

Returns the chat name and lines of an order for a specific state.

Source:

api/order.js, line 851

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`stateId`	`Number`	The ID of the state of the order to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

An object containing the chat name and lines for a specific state.

stateCreateAttachmentOrder(number, stateId, options, callback) → {XMLHttpRequest}

Adds an attachment to an order for a specific state.

Source:

api/order.js, line 1084

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to add the attachment to.
`stateId`	`Number`	The ID of the state of the order to add the attachment to.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

stateCreateAttachmentOrderP(number, stateId, options, callback) → {Promise}

Adds an attachment to an order for a specific state.

Source:

api/order.js, line 1116

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to add the attachment to.
`stateId`	`Number`	The ID of the state of the order to add the attachment to.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The attachment added.

stateOrder(number, stateId, options, callback) → {XMLHttpRequest}

Returns the state of an order.

Source:

api/order.js, line 789

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`stateId`	`Number`	The ID of the state of the order to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

stateOrderP(number, stateId, options, callback) → {Promise}

Returns the state of an order.

Source:

api/order.js, line 811

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`stateId`	`Number`	The ID of the state of the order to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

The state requested by ID.

statesOrder(number, options, callback) → {XMLHttpRequest}

Returns all the states of an order.

Source:

api/order.js, line 752

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

statesOrderP(number, options) → {Promise}

Returns all the states of an order.

Source:

api/order.js, line 772

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to find by.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The states of an order requested by number.

subscribeOrder(number) → {XMLHttpRequest}

Adds the email of the user in session to subscriber list of an order.

Source:

api/order.js, line 2095

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to subscribe.

Returns:

Type:: XMLHttpRequest

The order subscription status.

subscribeOrderP(number) → {Promise}

Adds the email of the user in session to subscriber list of an order.

Source:

api/order.js, line 2114

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to subscribe.

Returns:

Type:: Promise

The order subscription status.

switchArtifact(name, version, options) → {XMLHttpRequest}

Switches the active version of a build, changing the active version of the build to the version defined in the request.

Source:

api/build.js, line 440

Parameters:

Name	Type	Description
`name`	`String`	The name of the build to be switched.
`version`	`String`	The version of the build artifact.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

switchArtifactP(name, version, options) → {Promise}

Switches the active version of a build, changing the active version of the build to the version defined in the request.

Source:

api/build.js, line 462

Parameters:

Name	Type	Description
`name`	`String`	The name of the build to be switched.
`version`	`String`	The version of the build artifact.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The build switch (as a promise).

switchBuild(name, options) → {XMLHttpRequest}

Switches the active version of a build, moving internal references to the newly selected build version.

Source:

api/build.js, line 241

Parameters:

Name	Type	Description
`name`	`String`	The name of the build to be switched.
`options`	`Object`	An object with options, such as: - 'version' - The version of the build to activate.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

switchBuildP(name, options) → {Promise}

Switches the active version of a build, moving internal references to the newly selected build version.

Source:

api/build.js, line 269

Parameters:

Name	Type	Description
`name`	`String`	The name of the build to be switched.
`options`	`Object`	An object with options, such as: - 'version' - The version of the build to activate.

Returns:

Type:: Promise

The build switch (as a promise).

tenancyAccountMe(options, callback) → {XMLHttpRequest}

Retrieves the complete set of tenancy account data to the current session.

Source:

api/account.js, line 46

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

tenancyAccountMeP(options, callback) → {Promise}

Retrieves the complete set of tenancy account data to the current session.

Source:

api/account.js, line 66

Parameters:

Name	Type	Description
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: Promise

Resulting information for the callback execution.

textLength(options, callback) → {XMLHttpRequest}

Returns the length in pixels of text drawn using the profiles of the model of a brand.

Source:

api/brand.js, line 438

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'brand' - The name of the brand to be considered when validating. - 'model' - The name of the model to be considered when validating. - 'value' - The text from which the length in pixels will be returned. - 'profiles' - The profiles to be used when drawing the text.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The length in pixels of the text value given.

textLengthP(options) → {Promise}

Returns the length in pixels of text drawn using the profiles of the model of a brand.

Source:

api/brand.js, line 457

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'brand' - The name of the brand to be considered when validating. - 'model' - The name of the model to be considered when validating. - 'value' - The text from which the length in pixels will be returned. - 'profiles' - The profiles to be used when drawing the text.

Returns:

Type:: Promise

Resulting information for the callback execution.

touchOrder(number, options, callback) → {XMLHttpRequest}

Marks an order as having been touched by the user that is currently authenticated.

Source:

api/order.js, line 2164

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to touch.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

touchOrderP(number, options) → {Promise}

Marks an order as having been touched by the user that is currently authenticated.

Source:

api/order.js, line 2185

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to touch.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The order.

unauth(options, callback)

Responsible for the beginning of the unauth process, triggering the 'unauth' event.

Source:

base/auth.js, line 233

Parameters:

Name	Type	Description
`options`	`Object`	The set of options used for unauth process.
`callback`	`function`	The callback to be called once session is unauth'ed.

unbindInteractable(element) → {Interactable}

Unbinds ab Interactable from this Ripe instance.

Source:

base/ripe.js, line 1242

Parameters:

Name	Type	Description
`element`	`Interactable`	The Interactable instance to be unbound.

Returns:

Type:: Interactable

Returns the unbounded Interactable.

undo()

Reverses the last change to the parts. It is possible to undo all the changes done from the initial state.

Source:

base/ripe.js, line 1463

undoAll()

Executes the same operation as `undo` but goes all the way to the bottom of the stack that controls the history.

Source:

base/ripe.js, line 1477

uninstallArtifact(name, version, options) → {XMLHttpRequest}

Uninstalls a build artifact by build name and artifact version.

Source:

api/build.js, line 402

Parameters:

Name	Type	Description
`name`	`String`	The name of the build associated with the artifact.
`version`	`String`	The version of the build artifact.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

uninstallArtifactP(name, version, options) → {Promise}

Uninstalls a build artifact by build name and artifact version.

Source:

api/build.js, line 423

Parameters:

Name	Type	Description
`name`	`String`	The name of the build associated with the artifact.
`version`	`String`	The version of the build artifact.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The artifact uninstall (as a promise).

uninstallBuild(name, options) → {XMLHttpRequest}

Uninstalls a build from the server according to provided values.

Source:

api/build.js, line 159

Parameters:

Name	Type	Description
`name`	`String`	The name of the build to be uninstalled.
`options`	`Object`	An object with options, such as: - 'version' - The version of the build to uninstall, if no version is given, uninstalls all builds for the name.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

uninstallBuildP(name, options) → {Promise}

Uninstalls a build from the server according to provided values.

Source:

api/build.js, line 187

Parameters:

Name	Type	Description
`name`	`String`	The name of the build to be uninstalled.
`options`	`Object`	An object with options, such as: - 'version' - The version of the build to uninstall, if no version is given, uninstalls all builds for the name.

Returns:

Type:: Promise

The build uninstall (as a promise).

unload() → {Object}

Explicit entry point for the unloading of the Ripe Instance. Should be called for a clean exit of the instance.

Source:

base/ripe.js, line 308

Returns:

Type:: Object

The current Ripe Instance (for pipelining).

unloadP() → {Object}

Same as `unload` but providing a promise oriented solution ready to be "awaited".

Source:

base/ripe.js, line 329

Returns:

Type:: Object

The current Ripe Instance (for pipelining).

unsetReturnTracking(number, options, callback) → {XMLHttpRequest}

Unsets the return tracking info of an order.

Source:

api/order.js, line 1769

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to unset the return tracking info.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

unsetReturnTrackingP(number, options) → {Promise}

Unsets the return tracking info of an order.

Source:

api/order.js, line 1789

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to unset the return tracking info.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The result of the order tracking info change.

unsetTracking(number, options, callback) → {XMLHttpRequest}

Unsets the tracking info of an order.

Source:

api/order.js, line 1733

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to unset the tracking info.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

unsetTrackingP(number, options) → {Promise}

Unsets the tracking info of an order.

Source:

api/order.js, line 1753

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to unset the tracking info.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The result of the order tracking info change.

unsubscribeOrder(number) → {XMLHttpRequest}

Removes email of the user in session from the subscriber list of an order.

Source:

api/order.js, line 2128

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to unsubscribe.

Returns:

Type:: XMLHttpRequest

The order subscription status.

unsubscribeOrderP(number) → {Promise}

Removes email of the user in session from the subscriber list of an order.

Source:

api/order.js, line 2147

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to unsubscribe.

Returns:

Type:: Promise

The order subscription status.

update(state, options, children)

Triggers the update of the children so that they represent the current state of the model. This is considered the many state change operation and should be called whenever a relevant internal state value is changed so that the visuals are updated in accordance.

Source:

base/ripe.js, line 1306

Parameters:

Name	Type	Description
`state`	`Object`	An Object with the current customization and personalization, if not provided the current internal state of the instance will be used instead.
`options`	`Object`	Set of update options that change the way the update operation is going to be performed.
`children`	`Array`	The set of children that are going to be affected by the updated operation, if not provided all of the currently registered children in the instance will be used.

Returns:

The result of the update operation, meaning that if any child operation has been performed the result is true otherwise in case this is a no-op from the "visual" point of view the result is false.

updateAvailabilityRule(availabilityRule, options, callback) → {XMLHttpRequest}

Updates an availability rule on RIPE Core.

Source:

api/availability-rule.js, line 123

Parameters:

Name	Type	Description
`availabilityRule`	`Object`	The availability rule's data.
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

updateAvailabilityRuleP(availabilityRule, options) → {Promise}

Updates an availability rule on RIPE Core.

Source:

api/availability-rule.js, line 144

Parameters:

Name	Type	Description
`availabilityRule`	`Object`	The Availability Rule's data.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The availability rule's data.

updateBuild(name, options) → {XMLHttpRequest}

Updates a build to the latest version, maintaining the installation of the previous versions.

Source:

api/build.js, line 203

Parameters:

Name	Type	Description
`name`	`String`	The build's name of the build to update name.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

updateBuildP(name, options) → {Promise}

Updates a build to the latest version, maintaining the installation of the previous versions.

Source:

api/build.js, line 224

Parameters:

Name	Type	Description
`name`	`String`	The build's name of the build to update name.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The build update (as a promise).

updateCountryGroup(id, countryGroup, options, callback) → {XMLHttpRequest}

Updates an existing country group.

Source:

api/country-group.js, line 131

Parameters:

Name	Type	Description
`id`	`Object`	ID of the country group to be updated.
`countryGroup`	`Object`	An object with the updated information of the country group.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

updateCountryGroupP(id, countryGroup, options) → {Promise}

Updates an existing country group.

Source:

api/country-group.js, line 153

Parameters:

Name	Type	Description
`id`	`Object`	ID of the country group to be updated.
`countryGroup`	`Object`	An object with the updated information of the country group.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The country group's data.

updateEvent(event, options, callback) → {XMLHttpRequest}

Updates an event on RIPE Core.

Source:

api/admin/event.js, line 123

Parameters:

Name	Type	Description
`event`	`Object`	The event's data.
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

updateEventP(event, options) → {Promise}

Updates an event on RIPE Core.

Source:

api/admin/event.js, line 144

Parameters:

Name	Type	Description
`event`	`Object`	The event's data.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The event's data.

updateFactoryRule(factoryRule, options, callback) → {XMLHttpRequest}

Updates a factory rule on RIPE Core.

Source:

api/factory-rule.js, line 123

Parameters:

Name	Type	Description
`factoryRule`	`Object`	An object with information needed to update a factory rule.
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

updateFactoryRuleP(factoryRule, options) → {Promise}

Updates a factory rule on RIPE Core.

Source:

api/factory-rule.js, line 144

Parameters:

Name	Type	Description
`factoryRule`	`Object`	An object with information needed to update a factory rule.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The factory rule's data.

updateInvoiceRule(invoiceRule, options, callback) → {XMLHttpRequest}

Updates a invoice rule on RIPE Core.

Source:

api/invoice-rule.js, line 123

Parameters:

Name	Type	Description
`invoiceRule`	`Object`	An object with information needed to update a invoice rule.
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

updateInvoiceRuleP(invoiceRule, options) → {Promise}

Updates a invoice rule on RIPE Core.

Source:

api/invoice-rule.js, line 144

Parameters:

Name	Type	Description
`invoiceRule`	`Object`	An object with information needed to update a invoice rule.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The invoice rule's data.

updateLetterRule(letterRule, options, callback) → {XMLHttpRequest}

Updates a letter rule on RIPE Core.

Source:

api/letter-rule.js, line 123

Parameters:

Name	Type	Description
`letterRule`	`Object`	An object with information needed to update a letter rule.
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

updateLetterRuleP(letterRule, options) → {Promise}

Updates a letter rule on RIPE Core.

Source:

api/letter-rule.js, line 144

Parameters:

Name	Type	Description
`letterRule`	`Object`	An object with information needed to update a letter rule.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The letter rule's data.

updatePriceRule(priceRule, options, callback) → {XMLHttpRequest}

Updates a price rule on RIPE Core.

Source:

api/price-rule.js, line 123

Parameters:

Name	Type	Description
`priceRule`	`Object`	An object with information needed to update a price rule.
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

updatePriceRuleP(priceRule, options) → {Promise}

Updates a price rule on RIPE Core.

Source:

api/price-rule.js, line 144

Parameters:

Name	Type	Description
`priceRule`	`Object`	An object with information needed to update a price rule.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The price rule's data.

updateShipment(shipment, options, callback) → {XMLHttpRequest}

Updates a shipment on RIPE Core.

Source:

api/shipment.js, line 218

Parameters:

Name	Type	Description
`shipment`	`Object`	The shipment to update, with options such as: - 'number' - The existing shipment number. - 'status' - The shipment status. - 'description' - A brief description of this shipment. - 'weight' - Weight of the package being shipped. - 'weight_units' - Weight units (e.g. "kilograms" or "pounds"). - 'courier' - The courier for this shipment. - 'service' - The transportation service used. - 'package' - The package used. - 'tracking_number' - The tracking number associated with this shipment. - 'tracking_url' - The tracking URL associated with this shipment. - 'carbon_neutral' - If this shipment should be carbon neutral. - 'access_point_delivery' - If this shipment should be sent to an access point (e.g. "no", "optional" or "mandatory"). - 'pickup' - Pickup information. - 'offset' - Time offset for pickup scheduling relative to shipment creation (milliseconds). - 'ready_time' - Opening hours for shipper facility (milliseconds). - 'close_time' - Closing hours for shipper facility (milliseconds). - 'shipping_date' - The date the shipment ended. - 'delivery_date' - The date the shipment began. - 'shipper' - Shipper's information. - 'name' - Shipper's contact name. - 'phone' - Shipper's contact phone. - 'address' - Shipper's address. - 'customer' - Customer's information. - 'name' - Customer's contact name. - 'phone' - Customer's contact phone. - 'address' - Customer's address. - 'orders' - A list of RIPE Core order numbers. - 'attachments' - A list of RIPE Core attachment IDs.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

updateShipmentP(shipment, options) → {Promise}

Updates a shipment on RIPE Core.

Source:

api/shipment.js, line 267

Parameters:

Name	Type	Description
`shipment`	`Object`	The shipment to update, with options such as: - 'number' - The existing shipment number. - 'status' - The shipment status. - 'description' - A brief description of this shipment. - 'weight' - Weight of the package being shipped. - 'weight_units' - Weight units (e.g. "kilograms" or "pounds"). - 'courier' - The courier for this shipment. - 'service' - The transportation service used. - 'package' - The package used. - 'tracking_number' - The tracking number associated with this shipment. - 'tracking_url' - The tracking URL associated with this shipment. - 'carbon_neutral' - If this shipment should be carbon neutral. - 'access_point_delivery' - If this shipment should be sent to an access point (e.g. "no", "optional" or "mandatory"). - 'pickup' - Pickup information. - 'offset' - Time offset for pickup scheduling relative to shipment creation (milliseconds). - 'ready_time' - Opening hours for shipper facility (milliseconds). - 'close_time' - Closing hours for shipper facility (milliseconds). - 'shipping_date' - The date the shipment ended. - 'delivery_date' - The date the shipment began. - 'shipper' - Shipper's information. - 'name' - Shipper's contact name. - 'phone' - Shipper's contact phone. - 'address' - Shipper's address. - 'customer' - Customer's information. - 'name' - Customer's contact name. - 'phone' - Customer's contact phone. - 'address' - Customer's address. - 'orders' - A list of RIPE Core order numbers. - 'attachments' - A list of RIPE Core attachment IDs.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The shipment's data.

updateSku(id, identifier, domain, options, callback) → {XMLHttpRequest}

Updates an existing SKU, according to the provided options.

Source:

api/sku.js, line 202

Parameters:

Name	Type	Description
`id`	`Object`	ID of the SKU to be updated.
`identifier`	`String`	The SKU identifier as a plain string.
`domain`	`Object`	The SKU's domain, within the SKU is going to be defined.
`options`	`Object`	An object with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'variant' - The variant of the model. - 'version' - The version of the build. - '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.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

updateSkuP(id, identifier, domain, options) → {Promise}

Updates an existing SKU, according to the provided options.

Source:

api/sku.js, line 237

Parameters:

Name	Type	Description
`id`	`Object`	ID of the SKU to be updated.
`identifier`	`String`	The SKU identifier as a plain string.
`domain`	`Object`	The SKU's domain, within the SKU is going to be defined.
`options`	`Object`	An object with options, such as: - 'brand' - The brand of the model. - 'model' - The name of the model. - 'variant' - The variant of the model. - 'version' - The version of the build. - '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.

Returns:

Type:: Promise

The SKU's data.

updateTagOrder(number, identifier, type, options, callback) → {XMLHttpRequest}

Updates the tag for an order and, by default, activates it as well.

Source:

api/order.js, line 2203

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`identifier`	`String`	The unique identifier of the tag.
`type`	`String`	The tag type.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

updateTagOrderP(number, identifier, type, options) → {Promise}

Updates the tag for an order and, by default, activates it as well.

Source:

api/order.js, line 2230

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to update.
`identifier`	`String`	The unique identifier of the tag.
`type`	`String`	The tag type.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The order.

updateTransportRule(transportRule, options, callback) → {XMLHttpRequest}

Updates a transport rule on RIPE Core.

Source:

api/transport-rule.js, line 123

Parameters:

Name	Type	Description
`transportRule`	`Object`	An object with information needed to update a transport rule.
`options`	`Object`	An object of options to configure the request
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

updateTransportRuleP(transportRule, options) → {Promise}

Updates a transport rule on RIPE Core.

Source:

api/transport-rule.js, line 144

Parameters:

Name	Type	Description
`transportRule`	`Object`	An object with information needed to update a transport rule.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The transport rule's data.

validateModel(options, callback) → {XMLHttpRequest}

Returns the result of the server side validation of model configurations considering a given build's brand, model and version.

Source:

api/brand.js, line 397

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'brand' - The name of the brand to be considered when validating. - 'model' - The name of the model to be considered when validating. - 'version' - The target build version to be considered when validating. - 'parts' - The parts to be validated. - 'engraving' - The engraving value to be validated. - 'size' - The size to be validated.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

Resulting information for the callback execution.

validateModelP(options) → {Promise}

Returns the result of the server side validation of model configurations considering a given build's brand, model and version.

Source:

api/brand.js, line 418

Parameters:

Name	Type	Description
`options`	`Object`	An object with options, such as: - 'brand' - The name of the brand to be considered when validating. - 'model' - The name of the model to be considered when validating. - 'version' - The target build version to be considered when validating. - 'parts' - The parts to be validated. - 'engraving' - The engraving value to be validated. - 'size' - The size to be validated.

Returns:

Type:: Promise

Resulting information for the callback execution.

validateSku(id, options, callback) → {XMLHttpRequest}

Validates a given SKU according to spec and model rules.

Source:

api/sku.js, line 289

Parameters:

Name	Type	Description
`id`	`Object`	ID of the SKU to be validated.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

validateSkuP(id, options) → {Promise}

Validates a given SKU according to spec and model rules.

Source:

api/sku.js, line 308

Parameters:

Name	Type	Description
`id`	`Object`	ID of the SKU to be validated.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The result of the SKU's validation.

voidReturnWaybillOrder(number, options, callback) → {XMLHttpRequest}

Voids the return waybill for the order with the provided number.

Source:

api/order.js, line 485

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to void the return waybill for.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

voidReturnWaybillOrderP(number, options) → {Promise}

Voids the return waybill for the order with the provided number.

Source:

api/order.js, line 505

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to void the return waybill for.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The result of the waybill deletion.

voidReturnWaybillShipment(number, options, callback) → {XMLHttpRequest}

Voids the return waybill for the shipment with the provided number.

Source:

api/shipment.js, line 929

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to void the return waybill for.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

voidReturnWaybillShipmentP(number, options) → {Promise}

Voids the return waybill for the shipment with the provided number.

Source:

api/shipment.js, line 949

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to void the return waybill for.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The result of the waybill deletion.

voidWaybillOrder(number, options, callback) → {XMLHttpRequest}

Voids the waybill for the order with the provided number.

Source:

api/order.js, line 449

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to void the waybill for.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

voidWaybillOrderP(number, options) → {Promise}

Voids the waybill for the order with the provided number.

Source:

api/order.js, line 469

Parameters:

Name	Type	Description
`number`	`Number`	The number of the order to void the waybill for.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The result of the waybill deletion.

voidWaybillShipment(number, options, callback) → {XMLHttpRequest}

Voids the waybill for the shipment with the provided number.

Source:

api/shipment.js, line 893

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to void the waybill for.
`options`	`Object`	An object of options to configure the request.
`callback`	`function`	Function with the result of the request.

Returns:

Type:: XMLHttpRequest

The XMLHttpRequest instance of the API request.

voidWaybillShipmentP(number, options) → {Promise}

Voids the waybill for the shipment with the provided number.

Source:

api/shipment.js, line 913

Parameters:

Name	Type	Description
`number`	`Number`	The number of the shipment to void the waybill for.
`options`	`Object`	An object of options to configure the request.

Returns:

Type:: Promise

The result of the waybill deletion.

Constructor

new Ripe(brand, model, options)

Parameters:

Extends

Members

unbindConfigurator

unbindImage

Methods

(static) fromStructure(structure, safe, options)

Parameters:

_buildProfiles(engraving, profiles, context, sep) → {Array}

Parameters:

Returns:

_errorHandler(error)

Parameters:

_generateProfiles(group, viewport) → {Array}

Parameters:

Returns:

_getVideoOptions(options) → {Object}

Parameters:

Returns:

_getVideoThumbnailOptions(options) → {Object}

Parameters:

Returns:

_getVideoThumbnailURL(options) → {String}

Parameters:

Returns:

_getVideoURL(options) → {String}

Parameters:

Returns:

_handleCtx(result)

Parameters:

_initialsBuilder(initials, engraving, group, viewport, context) → {Object}

Parameters:

Returns:

_loadInitialsBuilder()

_toChoices(loadedConfig) → {Object}

Parameters:

Returns:

accessPointShipment(number, options, callback) → {XMLHttpRequest}

Parameters:

Returns:

accessPointShipmentP(number, options, callback) → {Promise}

Parameters:

Returns:

accountMe(options, callback) → {XMLHttpRequest}

Parameters:

Returns:

accountMeP(options, callback) → {Promise}

Parameters:

Returns:

activateTagOrder(number, options, callback) → {XMLHttpRequest}

Parameters:

Returns:

activateTagOrderP(number, options) → {Promise}

Parameters:

Returns:

addBundle(bundle, locale)

Parameters:

addPlugin(plugin)

Parameters:

attachmentOrder(number, attachmentId, options, callback) → {XMLHttpRequest}

Parameters:

Returns:

attachmentOrderP(number, attachmentId, options, callback) → {Promise}

Parameters:

Returns:

attachmentsBulkOrder(number, options, callback) → {XMLHttpRequest}

Parameters:

Returns:

attachmentsBulkOrderP(number, options, callback) → {Promise}

Parameters:

Returns:

attachmentShipment(number, attachmentId, options, callback) → {XMLHttpRequest}

Parameters:

Returns:

attachmentShipmentP(number, attachmentId, options, callback) → {Promise}

Parameters:

Returns: