oneentry 1.0.173 → 1.0.175

package/esm/orders/ordersApi.js

@@ -22,8 +22,8 @@ export default class OrdersApi extends AsyncModules {
      * Getting all the order storage objects.
      * @handleName getAllOrdersStorage
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Optional parameter for pagination. Default: 0.
-     * @param {number} [limit] - Optional parameter for pagination. Default: 30.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<IOrdersEntity[] | IError>} Returns an array of order storage objects.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
@@ -37,10 +37,10 @@ export default class OrdersApi extends AsyncModules {
     /**
      * Getting all orders from the orders storage object created by the user.
      * @handleName getAllOrdersByMarker
-     * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
+     * @param {string} marker - Marker of the order storage. Example: "order_storage_1".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Offset parameter. Default: 0.
-     * @param {number} [limit] - Limit parameter. Default: 30.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<IOrdersByMarkerEntity | IError>} Returns an object with the orders.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
@@ -56,7 +56,7 @@ export default class OrdersApi extends AsyncModules {
     /**
      * Retrieve one order storage object by marker.
      * @handleName getOrdersStorageByMarker
-     * @param {string} marker - Marker of the order object. Example: "order_storage_1".
+     * @param {string} marker - Marker of the order storage. Example: "order_storage_1".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IOrdersEntity | IError>} Return object of order information.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -71,8 +71,8 @@ export default class OrdersApi extends AsyncModules {
     /**
      * Getting a single order from the order storage object created by the user.
      * @handleName getOrderByMarkerAndId
-     * @param {string} marker - The text identifier of the order storage object. Example: "order_storage_1".
-     * @param {number} id - ID of the order object. Example: 12345.
+     * @param {string} marker - Marker of the order storage. Example: "order_storage_1".
+     * @param {number} id - Order ID. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IOrderByMarkerEntity | IError>} Returns an object with the order.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -89,7 +89,7 @@ export default class OrdersApi extends AsyncModules {
     /**
      * Getting a single order created by the user, by its own id.
      * @handleName getOrderById
-     * @param {number} id - ID of the order object. Example: 12345.
+     * @param {number} id - Order ID. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IOrderByMarkerEntity | IError>} Returns an object with the order.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -108,7 +108,7 @@ export default class OrdersApi extends AsyncModules {
     /**
      * Preview order calculation with discounts and coupons (without saving).
      * @handleName previewOrder
-     * @param {ICreateOrderPreview} body - Order preview body.
+     * @param {ICreateOrderPreview} body - Order preview parameters.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IOrderPreviewResponse | IError>} Returns an object with the order preview.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -123,8 +123,8 @@ export default class OrdersApi extends AsyncModules {
     /**
      * Creation of an order in the order storage.
      * @handleName createOrder
-     * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
-     * @param {IOrderData} body - Object for creating an order.
+     * @param {string} marker - Marker of the order storage. Example: "order_storage_1".
+     * @param {IOrderData} body - Data for the new order.
      * @example
         {
           "formIdentifier": "bar-orders-form",
@@ -157,9 +157,9 @@ export default class OrdersApi extends AsyncModules {
     /**
      * Changing an order in the orders storage
      * @handleName updateOrderByMarkerAndId
-     * @param {string} marker - The text identifier of the order storage object. Example: "order_storage_1".
-     * @param {number} id - ID of the order object. Example: 12345.
-     * @param {IOrderData} body - Object for updating an order.
+     * @param {string} marker - Marker of the order storage. Example: "order_storage_1".
+     * @param {number} id - Order ID. Example: 12345.
+     * @param {IOrderData} body - Data for updating the order.
      * @example
         {
           "formIdentifier": "bar-orders-form",
@@ -193,10 +193,10 @@ export default class OrdersApi extends AsyncModules {
     /**
      * Get all orders statuses by Storage marker
      * @handleName getAllStatusesByStorageMarker
-     * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
+     * @param {string} marker - Marker of the order storage. Example: "order_storage_1".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Offset parameter. Default: 0.
-     * @param {number} [limit] - Limit parameter. Default: 30.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<IOrderStatus[] | IError>} Returns an object with the orders statuses.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
@@ -214,7 +214,7 @@ export default class OrdersApi extends AsyncModules {
     /**
      * Get all refund requests for an order.
      * @handleName getRefunds
-     * @param {number} id - Order id. Example: 1.
+     * @param {number} id - Order ID. Example: 1.
      * @returns {Promise<IRefundRequest[] | IError>} Returns array of refund requests.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getRefunds getRefunds} documentation.
@@ -226,8 +226,8 @@ export default class OrdersApi extends AsyncModules {
     /**
      * Create a refund request for an order.
      * @handleName createRefundRequest
-     * @param {number} id - Order id. Example: 1.
-     * @param {ICreateRefundRequest} body - Refund request body.
+     * @param {number} id - Order ID. Example: 1.
+     * @param {ICreateRefundRequest} body - Refund request data.
      * @returns {Promise<boolean | IError>} Returns true if the refund request was created successfully.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/orders/createRefundRequest createRefundRequest} documentation.
@@ -239,7 +239,7 @@ export default class OrdersApi extends AsyncModules {
     /**
      * Cancel a refund request for an order.
      * @handleName cancelRefundRequest
-     * @param {number} id - Order id. Example: 1.
+     * @param {number} id - Order ID. Example: 1.
      * @returns {Promise<boolean | IError>} Returns true if the refund request was cancelled successfully.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/orders/cancelRefundRequest cancelRefundRequest} documentation.
@@ -251,10 +251,10 @@ export default class OrdersApi extends AsyncModules {
     /**
      * Semantic (vector) search for the current user's orders.
      * @handleName getOrdersByVectorSearch
-     * @param {IOrdersVectorSearch} body - Vector search body. Example: `{ queryText: "winter jacket" }`.
+     * @param {IOrdersVectorSearch} body - Vector search parameters. Example: `{ queryText: "winter jacket" }`.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Parameter for pagination. Default: 0.
-     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<IVectorSearchResponse<IOrdersByMarkerEntity> | IError>} Returns an object with an array of found orders and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search over the orders of the authorized user. It requires user authorization.
@@ -299,7 +299,7 @@ export default class OrdersApi extends AsyncModules {
      * a reused body — a retry, a shared template — arrive wrapped twice: `createOrder`
      * answered `400 formData's marker '#0' marker is required`, and
      * `updateOrderByMarkerAndId` answered `200` and stored the broken `formData` in
-     * the order (CMS-1063).
+     * the order.
      * @param {IOrderData} body - Order body as the caller passed it. Left unchanged.
      * @param {string} langCode - Locale key to wrap `formData` into.
      * @returns {object} A new body with `formData` as `{ [langCode]: [...] }`.