oneentry 1.0.127 → 1.0.128

package/dist/orders/ordersInterfaces.d.ts

@@ -1,23 +1,23 @@
 import type { IError, ILocalizeInfo } from '../base/utils';
 /**
  * @interface IOrdersApi
- * @property {Function} getOrderByMarker         - Retrieve one order storage object by marker.
- * @property {Function} createOrder              - Creation of an order in the order storage.
+ * @property {Function} getOrderByMarker - Retrieve one order storage object by marker.
+ * @property {Function} createOrder - Creation of an order in the order storage.
  * @property {Function} updateOrderByMarkerAndId - Changing an order in the order store.
- * @property {Function} getOrderByMarkerAndId    - Getting a single order from the order storage object created by the user.
- * @property {Function} getAllOrders             - Getting all the order storage objects.
- * @property {Function} getAllOrdersByMarker     - Getting one order storage object by marker.
- * @property {Function} setAccessToken           - Only for custom authorization. An intermediate method for setting up an access token.
+ * @property {Function} getOrderByMarkerAndId - Getting a single order from the order storage object created by the user.
+ * @property {Function} getAllOrders - Getting all the order storage objects.
+ * @property {Function} getAllOrdersByMarker - Getting one order storage object by marker.
+ * @property {Function} setAccessToken - Only for custom authorization. An intermediate method for setting up an access token.
  * @description Represents the API for managing orders in the order storage.
  */
 interface IOrdersApi {
     /**
      * 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.
-     * @returns {Promise<IOrdersEntity[] | IError>}            Returns an array of order storage objects.
+     * @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.
+     * @returns {Promise<IOrdersEntity[] | IError>} Returns an array of order storage objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method gets all the order storage objects.
      */
@@ -25,11 +25,11 @@ interface IOrdersApi {
     /**
      * 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}                                  [langCode] - Language code. Default: "en_US".
-     * @param   {number}                                  [offset]   - Offset parameter. Default: 0.
-     * @param   {number}                                  [limit]    - Limit parameter. Default: 30.
-     * @returns {Promise<IOrdersByMarkerEntity | IError>}            Returns an object with the orders.
+     * @param {string} marker - Textual identifier of the order storage object. 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.
+     * @returns {Promise<IOrdersByMarkerEntity | IError>} Returns an object with the orders.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method gets all orders from the orders storage object created by the user.
      */
@@ -37,9 +37,9 @@ interface IOrdersApi {
     /**
      * Retrieve one order storage object by marker.
      * @handleName getOrderByMarker
-     * @param   {string}                          marker     - Marker of the order object. Example: "order_storage_1".
-     * @param   {string}                          [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<IOrdersEntity | IError>}            Return object of order information.
+     * @param {string} marker - Marker of the order object. Example: "order_storage_1".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IOrdersEntity | IError>} Return object of order information.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method retrieves one order storage object by marker.
      */
@@ -47,10 +47,10 @@ interface IOrdersApi {
     /**
      * 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}                                 [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<IOrderByMarkerEntity | IError>}            Returns an object with the order.
+     * @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} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IOrderByMarkerEntity | IError>} Returns an object with the order.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method gets a single order from the order storage object created by the user.
      */
@@ -58,25 +58,25 @@ interface IOrdersApi {
     /**
      * 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. Example:
-                                                                 {
-                                                                 "formIdentifier": "bar-orders-form",
-                                                                 "paymentAccountIdentifier": "usd-payment",
-                                                                 "formData": {
-                                                                 "marker": "name_1",
-                                                                 "value": "Name",
-                                                                 "type": "string"
-                                                                 },
-                                                                 "products": [
-                                                                 {
-                                                                 "productId": 1,
-                                                                 "quantity": 2
-                                                                 }
-                                                                 ]
-                                                                 }
-     * @param   {string}                              [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<IBaseOrdersEntity | IError>}            Returns an object with the created order.
+     * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
+     * @param {IOrderData} body - Object for creating an order. Example:
+        {
+          "formIdentifier": "bar-orders-form",
+          "paymentAccountIdentifier": "usd-payment",
+          "formData": {
+            "marker": "name_1",
+            "value": "Name",
+            "type": "string"
+          },
+          "products": [
+            {
+            "productId": 1,
+            "quantity": 2
+            }
+          ]
+        }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IBaseOrdersEntity | IError>} Returns an object with the created order.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
@@ -84,27 +84,27 @@ interface IOrdersApi {
     /**
      * 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. Example:
-                                                                 {
-                                                                 "formIdentifier": "bar-orders-form",
-                                                                 "paymentAccountIdentifier": "usd-payment",
-                                                                 "formData": {
-                                                                 "marker": "name_1",
-                                                                 "value": "Name",
-                                                                 "type": "string"
-                                                                 },
-                                                                 "products": [
-                                                                 {
-                                                                 "productId": 1,
-                                                                 "quantity": 2
-                                                                 }
-                                                                 ],
-                                                                 "currency": "USD"
-                                                                 }
-     * @param   {string}                              [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<IBaseOrdersEntity | IError>}            Returns an object with the updated order.
+     * @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. Example:
+        {
+          "formIdentifier": "bar-orders-form",
+          "paymentAccountIdentifier": "usd-payment",
+          "formData": {
+            "marker": "name_1",
+            "value": "Name",
+            "type": "string"
+          },
+          "products": [
+            {
+            "productId": 1,
+            "quantity": 2
+            }
+          ],
+          "currency": "USD"
+        }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IBaseOrdersEntity | IError>} Returns an object with the updated order.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
@@ -114,41 +114,41 @@ interface IOrdersApi {
  * Interface for the orders storage object.
  * @interface IOrdersByMarkerEntity
  * @property {IOrderByMarkerEntity[]} items - Array of order storage objects. Example:
-                                            [
-                                            {
-                                            "id": 55,
-                                            "storageId": 1,
-                                            "createdDate": "2025-03-22T21:12:42.371Z",
-                                            "statusIdentifier": "inProgress",
-                                            "formIdentifier": "orderForm",
-                                            "formData": [
-                                            {
-                                            "marker": "order_name",
-                                            "value": "Ivan",
-                                            "type": "string"
-                                            }
-                                            ],
-                                            "attributeSetIdentifier": "order_form",
-                                            "totalSum": "300.00",
-                                            "currency": "",
-                                            "paymentAccountIdentifier": "cash",
-                                            "paymentAccountLocalizeInfos": {
-                                            "title": "Cash"
-                                            },
-                                            "products": [
-                                            {
-                                            "id": 2957,
-                                            "title": "Cosmo",
-                                            "sku": null,
-                                            "previewImage": null,
-                                            "price": 150,
-                                            "quantity": 2
-                                            }
-                                            ],
-                                            "isCompleted": false
-                                            }
-                                            ]
- * @property {number}                 total - Total number of found records. Example: 100.
+    [
+      {
+        "id": 55,
+        "storageId": 1,
+        "createdDate": "2025-03-22T21:12:42.371Z",
+        "statusIdentifier": "inProgress",
+        "formIdentifier": "orderForm",
+        "formData": [
+          {
+          "marker": "order_name",
+          "value": "Ivan",
+          "type": "string"
+          }
+        ],
+        "attributeSetIdentifier": "order_form",
+        "totalSum": "300.00",
+        "currency": "",
+        "paymentAccountIdentifier": "cash",
+        "paymentAccountLocalizeInfos": {
+          "title": "Cash"
+        },
+        "products": [
+          {
+          "id": 2957,
+          "title": "Cosmo",
+          "sku": null,
+          "previewImage": null,
+          "price": 150,
+          "quantity": 2
+          }
+        ],
+        "isCompleted": false
+      }
+    ]
+ * @property {number} total - Total number of found records. Example: 100.
  * @description Represents a response from the order storage by marker.
  */
 interface IOrdersByMarkerEntity {
@@ -158,10 +158,10 @@ interface IOrdersByMarkerEntity {
 /**
  * Interface representing a picture entity.
  * @interface IPicture
- * @property {string} filename     - The name of the file. Example: "image.jpg".
+ * @property {string} filename - The name of the file. Example: "image.jpg".
  * @property {string} downloadLink - The URL link to download the picture. Example: "https://example.com/image.jpg".
- * @property {number} size         - The size of the picture in bytes. Example: 102400.
- * @property {string} previewLink  - The URL link to preview the picture. Example: "https://example.com/image-preview.jpg".
+ * @property {number} size - The size of the picture in bytes. Example: 102400.
+ * @property {string} previewLink - The URL link to preview the picture. Example: "https://example.com/image-preview.jpg".
  * @description This interface defines the structure for a picture entity, including its filename, download link, size, and preview link.
  */
 interface IPicture {
@@ -173,18 +173,18 @@ interface IPicture {
 /**
  * Interface representing a product in an order.
  * @interface IOrderProducts
- * @property {number}        id           - Product id. Example: 2957.
- * @property {number}        quantity     - Product quantity. Example: 1.
- * @property {string}        title        - Product title. Example: "Cosmo".
- * @property {string | null} sku          - Product sku. Example: "SKU".
- * @property {any}           previewImage - Product previewImage. Example:
-                                          {
-                                          "filename": "image.jpg",
-                                          "downloadLink": "https://example.com/image.jpg",
-                                          "size": 102400,
-                                          "previewLink": "https://example.com/image-preview.jpg"
-                                          }
- * @property {number}        price        - Product price. Example: 150.
+ * @property {number} id - Product id. Example: 2957.
+ * @property {number} quantity - Product quantity. Example: 1.
+ * @property {string} title - Product title. Example: "Cosmo".
+ * @property {string | null} sku - Product sku. Example: "SKU".
+ * @property {any} previewImage - Product previewImage. Example:
+    {
+      "filename": "image.jpg",
+      "downloadLink": "https://example.com/image.jpg",
+      "size": 102400,
+      "previewLink": "https://example.com/image-preview.jpg"
+    }
+ * @property {number} price - Product price. Example: 150.
  * @description Represents a product in an order.
  */
 interface IOrderProducts {
@@ -199,8 +199,8 @@ interface IOrderProducts {
  * Interface representing form data for orders.
  * @interface IOrdersFormData
  * @property {string} marker - Marker of form field. Example: "name_1".
- * @property {string} type   - Type of value. Example: "string".
- * @property {string} value  - Value. Example: "Name".
+ * @property {string} type - Type of value. Example: "string".
+ * @property {string} value - Value. Example: "Name".
  * @description Represents a form data for orders.
  */
 interface IOrdersFormData {
@@ -212,7 +212,7 @@ interface IOrdersFormData {
  * Interface representing product data in an order.
  * @interface IOrderProductData
  * @property {number} productId - Product identifier. Example: 1.
- * @property {number} quantity  - Quantity of the product. Example: 2.
+ * @property {number} quantity - Quantity of the product. Example: 2.
  * @description Represents a product data in an order.
  */
 interface IOrderProductData {
@@ -222,12 +222,12 @@ interface IOrderProductData {
 /**
  * Interface representing product data in an order.
  * @interface IOrderProductsData
- * @property {number} id           - Product identifier. Example: 1.
- * @property {any}    previewImage - Product preview image.
- * @property {number} price        - Product price. Example: 10.
- * @property {number} quantity     - Quantity of the product. Example: 2.
- * @property {string} sku          - Product SKU. Example: "sku_1".
- * @property {string} title        - Product title. Example: "Product 1".
+ * @property {number} id - Product identifier. Example: 1.
+ * @property {any} previewImage - Product preview image.
+ * @property {number} price - Product price. Example: 10.
+ * @property {number} quantity - Quantity of the product. Example: 2.
+ * @property {string} sku - Product SKU. Example: "sku_1".
+ * @property {string} title - Product title. Example: "Product 1".
  * @description Represents a product data in an order.
  */
 interface IOrderProductsData {
@@ -241,32 +241,32 @@ interface IOrderProductsData {
 /**
  * Interface representing an order storage object.
  * @interface IBaseOrdersEntity
- * @property {number}               id                       - Object identifier. Example: 1.
- * @property {string}               formIdentifier           - Text identifier of the form. Example: "bar-orders-form".
- * @property {string}               paymentAccountIdentifier - Text identifier of the order payment. Example: "payment-1".
- * @property {IOrdersFormData[]}    formData                 - Data submitted by the form linked to the order store. Example:
-                                                             [
-                                                             {
-                                                             "marker": "name_1",
-                                                             "value": "Name",
-                                                             "type": "string"
-                                                             }
-                                                             ]
- * @property {IOrderProductsData[]} products                 - Array of products added to order. Example:
-                                                             [
-                                                             {
-                                                             "id": 2957,
-                                                             "title": "Cosmo",
-                                                             "sku": null,
-                                                             "previewImage": null,
-                                                             "price": 150,
-                                                             "quantity": 2
-                                                             }
-                                                             ]
- * @property {string}               currency                 - Currency used to pay for the order. Example: "USD".
- * @property {number}               totalSum                 - Total order amount. Example: "150".
- * @property {string}               [createdDate]            - Order creation date. Example: "2023-10-01T12:00:00Z".
- * @property {string}               [statusIdentifier]       - Text identifier of order status object (if not set, default status will be assigned). Example: "status-1".
+ * @property {number} id - Object identifier. Example: 1.
+ * @property {string} formIdentifier - Text identifier of the form. Example: "bar-orders-form".
+ * @property {string} paymentAccountIdentifier - Text identifier of the order payment. Example: "payment-1".
+ * @property {IOrdersFormData[]} formData - Data submitted by the form linked to the order store. Example:
+    [
+      {
+        "marker": "name_1",
+        "value": "Name",
+        "type": "string"
+      }
+    ]
+ * @property {IOrderProductsData[]} products - Array of products added to order. Example:
+    [
+      {
+        "id": 2957,
+        "title": "Cosmo",
+        "sku": null,
+        "previewImage": null,
+        "price": 150,
+        "quantity": 2
+      }
+    ]
+ * @property {string} currency - Currency used to pay for the order. Example: "USD".
+ * @property {number} totalSum - Total order amount. Example: "150".
+ * @property {string} [createdDate] - Order creation date. Example: "2023-10-01T12:00:00Z".
+ * @property {string} [statusIdentifier] - Text identifier of order status object (if not set, default status will be assigned). Example: "status-1".
  */
 interface IBaseOrdersEntity {
     id: number;
@@ -283,17 +283,17 @@ interface IBaseOrdersEntity {
  * Interface representing a response from the order storage.
  * @interface IBaseOrdersEntityResponse
  * @property {IBaseOrdersEntity[]} items - Array of order storage objects. Example:
-                                         [
-                                         {
-                                         "id": 2957,
-                                         "title": "Cosmo",
-                                         "sku": null,
-                                         "previewImage": null,
-                                         "price": 150,
-                                         "quantity": 2
-                                         }
-                                         ]
- * @property {string | number}     total - Total number of found records. Example: 100.
+    [
+      {
+        "id": 2957,
+        "title": "Cosmo",
+        "sku": null,
+        "previewImage": null,
+        "price": 150,
+        "quantity": 2
+      }
+    ]
+ * @property {string | number} total - Total number of found records. Example: 100.
  * @description Represents a response from the order storage.
  */
 interface IBaseOrdersEntityResponse {
@@ -303,15 +303,15 @@ interface IBaseOrdersEntityResponse {
 /**
  * Interface representing an order storage object.
  * @interface IOrdersEntity
- * @property {number}                       id                        - Object identifier. Example: 1.
- * @property {ILocalizeInfo}                localizeInfos             - Name considering localization. Example:
-                                                                      {
-                                                                      "title": "Cash"
-                                                                      }
- * @property {number | null}                position                  - Position in orders storage. Example: 1.
- * @property {string}                       identifier                - Textual identifier for the record field. Example: "order_storage_1".
- * @property {string}                       formIdentifier            - Textual identifier for the form used by the order storage. Example: "bar-orders-form".
- * @property {number | null}                generalTypeId             - Type identifier. Example: 1.
+ * @property {number} id - Object identifier. Example: 1.
+ * @property {ILocalizeInfo} localizeInfos - Name considering localization. Example:
+    {
+      "title": "Cash"
+    }
+ * @property {number | null} position - Position in orders storage. Example: 1.
+ * @property {string} identifier - Textual identifier for the record field. Example: "order_storage_1".
+ * @property {string} formIdentifier - Textual identifier for the form used by the order storage. Example: "bar-orders-form".
+ * @property {number | null} generalTypeId - Type identifier. Example: 1.
  * @property {IPaymentAccountIdentifiers[]} paymentAccountIdentifiers - Array of textual identifiers of payment accounts used by the order storage. Example: [{ "identifier": "payment-1" }].
  * @description Represents an order storage object.
  */
@@ -336,17 +336,17 @@ interface IPaymentAccountIdentifiers {
 /**
  * Interface representing the data required to create or update an order in the order storage.
  * @interface IOrderData
- * @property {string}                              formIdentifier           - Text identifier of the form object linked to the order repository. Example: "bar-orders-form".
- * @property {string}                              paymentAccountIdentifier - Text identifier of the payment object linked to the order repository. Example: "payment-1".
- * @property {IOrdersFormData | IOrdersFormData[]} formData                 - Form data linked to the order repository. Example:
-                                                                            [
-                                                                            {
-                                                                            "marker": "name_1",
-                                                                            "value": "Name",
-                                                                            "type": "string"
-                                                                            }
-                                                                            ]
- * @property {IOrderProductData[]}                 products                 - An array of ordered products. Example: .
+ * @property {string} formIdentifier - Text identifier of the form object linked to the order repository. Example: "bar-orders-form".
+ * @property {string} paymentAccountIdentifier - Text identifier of the payment object linked to the order repository. Example: "payment-1".
+ * @property {IOrdersFormData | IOrdersFormData[]} formData - Form data linked to the order repository. Example:
+    [
+      {
+        "marker": "name_1",
+        "value": "Name",
+        "type": "string"
+      }
+    ]
+ * @property {IOrderProductData[]} products - An array of ordered products. Example: .
  * @description Represents the data required to create or update an order in the order storage.
  */
 interface IOrderData {
@@ -358,27 +358,33 @@ interface IOrderData {
 /**
  * Interface representing an order product data.
  * @interface IOrderByMarkerEntity
- * @property {number}              id                          - Object identifier. Example: 125.
- * @property {number}              storageId                   - Identifier of the order storage object. Example: 1.
- * @property {string}              createdDate                 - Date when the order was created. Example: "2023-10-01T12:00:00Z".
- * @property {string}              [statusIdentifier]          - Text identifier of the order status. Example: "order-status-1".
- * @property {string}              [formIdentifier]            - Text identifier of the form. Example: "bar-orders-form".
- * @property {IOrdersFormData[]}   formData                    - Data submitted by the form linked to the order store. Example:
-                                                               [
-                                                               {
-                                                               "marker": "order_name",
-                                                               "value": "Ivan",
-                                                               "type": "string"
-                                                               }
-                                                               ]
- * @property {string | null}       [attributeSetIdentifier]    - Text identifier of the attribute set. Example: "attribute-set-1".
- * @property {string}              totalSum                    - Total order amount. Example: "100.00".
- * @property {string}              currency                    - Currency used to pay for the order. Example: "USD".
- * @property {string | null}       [paymentAccountIdentifier]  - Textual identifier for the order payment. Example: "payment-1".
+ * @property {number} id - Object identifier. Example: 125.
+ * @property {number} storageId - Identifier of the order storage object. Example: 1.
+ * @property {string} createdDate - Date when the order was created. Example: "2023-10-01T12:00:00Z".
+ * @property {string} [statusIdentifier] - Text identifier of the order status. Example: "order-status-1".
+ * @property {string} [formIdentifier] - Text identifier of the form. Example: "bar-orders-form".
+ * @property {IOrdersFormData[]} formData - Data submitted by the form linked to the order store. Example:
+    [
+      {
+        "marker": "order_name",
+        "value": "Ivan",
+        "type": "string"
+      }
+    ]
+ * @property {string | null} [attributeSetIdentifier] - Text identifier of the attribute set. Example: "attribute-set-1".
+ * @property {string} totalSum - Total order amount. Example: "100.00".
+ * @property {string} currency - Currency used to pay for the order. Example: "USD".
+ * @property {string | null} [paymentAccountIdentifier] - Textual identifier for the order payment. Example: "payment-1".
  * @property {Record<string, any>} paymentAccountLocalizeInfos - Payment account name considering localization. Example: { "en_US": "USD Payment", "ru_RU": "Оплата в долларах США" }.
- * @property {IOrderProducts[]}    products                    - Array of products added to order. Example:
-                                                               [{ "id": 1, "name": "Product 1", "quantity": 2 }].
- * @property {boolean}             isCompleted                 - Indicates that the order has been completed. Example: true.
+ * @property {IOrderProducts[]} products - Array of products added to order. Example:
+    [
+      {
+        "id": 1,
+        "name": "Product 1",
+        "quantity": 2
+      }
+    ]
+ * @property {boolean} isCompleted - Indicates that the order has been completed. Example: true.
  * @description Represents an order storage object created by the user.
  */
 interface IOrderByMarkerEntity {