oneentry 1.0.124 → 1.0.126

package/dist/orders/ordersApi.js

@@ -9,7 +9,6 @@ const asyncModules_1 = __importDefault(require("../base/asyncModules"));
  *
  * @handle /api/content/orders-storage
  * @module OrdersApi
- *
  * @description This module provides methods for working with orders, including retrieving, creating, and updating orders in the order storage.
  */
 class OrdersApi extends asyncModules_1.default {
@@ -22,13 +21,11 @@ class OrdersApi extends asyncModules_1.default {
      *
      * @handleName getAllOrdersStorage
      *
-     * @param {number} [langCode] - Language code. Default: "en_US".
+     * @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.
-     *
      * @return {IOrdersEntity[]} 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 requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      **/
     async getAllOrdersStorage(langCode = this.state.lang, offset = 0, limit = 30) {
@@ -44,10 +41,8 @@ class OrdersApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Offset parameter. Default: 0.
      * @param {number} [limit] - Limit parameter. Default: 30.
-     *
      * @return {IOrdersByMarkerEntity} 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 requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     async getAllOrdersByMarker(marker, langCode = this.state.lang, offset = 0, limit = 30) {
@@ -62,10 +57,8 @@ class OrdersApi extends asyncModules_1.default {
      *
      * @param {string} marker - Marker of the order object. Example: "order_storage_1".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     *
      * @return {IOrdersEntity} 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 requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     async getOrderByMarker(marker, langCode = this.state.lang) {
@@ -80,10 +73,8 @@ class OrdersApi extends asyncModules_1.default {
      * @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".
-     *
      * @return {IOrderByMarkerEntity} 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 requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     async getOrderByMarkerAndId(marker, id, langCode = this.state.lang) {
@@ -96,22 +87,35 @@ class OrdersApi extends asyncModules_1.default {
      * @handleName createOrder
      *
      * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
-     * @param {IOrderData} data - 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 {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".
-     *
      * @return {IBaseOrdersEntity} 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.
      */
-    async createOrder(marker, data, langCode = this.state.lang) {
+    async createOrder(marker, body, langCode = this.state.lang) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const formData = {};
-        formData[langCode] = Array.isArray(data.formData)
-            ? data.formData
-            : [data.formData];
-        data.formData = formData;
-        const result = await this._fetchPost(`/marker/${marker}/orders`, data);
+        formData[langCode] = Array.isArray(body.formData)
+            ? body.formData
+            : [body.formData];
+        body.formData = formData;
+        const result = await this._fetchPost(`/marker/${marker}/orders`, body);
         return this._normalizeData(result);
     }
     /**
@@ -121,12 +125,26 @@ class OrdersApi extends asyncModules_1.default {
      *
      * @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 {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".
-     *
      * @return {IBaseOrdersEntity} 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.
      */
     async updateOrderByMarkerAndId(marker, id, body, langCode = this.state.lang) {

package/dist/orders/ordersInterfaces.d.ts

@@ -1,4 +1,4 @@
-import type { IError } from '../base/utils';
+import type { IError, ILocalizeInfo } from '../base/utils';
 /**
  * @interface IOrdersApi
  *
@@ -9,7 +9,6 @@ import type { IError } from '../base/utils';
  * @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 {
@@ -19,11 +18,10 @@ interface IOrdersApi {
      * @param {number} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Optional parameter for pagination. Default: 0.
      * @param {number} [limit] - Optional parameter for pagination. Default: 30.
-     *
      * @return {IOrdersEntity[]} Returns an array of order storage objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
-    getAllOrdersStorage(langCode?: string, offset?: number, limit?: number): Promise<Array<IOrdersEntity> | IError>;
+    getAllOrdersStorage(langCode?: string, offset?: number, limit?: number): Promise<IOrdersEntity[] | IError>;
     /**
      * Getting all orders from the orders storage object created by the user.
      *
@@ -31,7 +29,6 @@ interface IOrdersApi {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Offset parameter. Default: 0.
      * @param {number} [limit] - Limit parameter. Default: 30.
-     *
      * @return {IOrdersByMarkerEntity} Returns an object with the orders.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
@@ -41,7 +38,6 @@ interface IOrdersApi {
      *
      * @param {string} marker - Marker of the order object. Example: "order_storage_1".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     *
      * @return {IOrdersEntity} Return object of order information.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
@@ -52,7 +48,6 @@ interface IOrdersApi {
      * @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".
-     *
      * @return {IOrderByMarkerEntity} Returns an object with the order.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
@@ -61,41 +56,101 @@ interface IOrdersApi {
      * Creation of an order in the order storage.
      *
      * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
-     * @param {IOrderData} data - 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 {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".
-     *
      * @return {IBaseOrdersEntity} 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.
      */
-    createOrder(marker: string, data: IOrderData, langCode: string): Promise<IBaseOrdersEntity | IError>;
+    createOrder(marker: string, body: IOrderData, langCode: string): Promise<IBaseOrdersEntity | IError>;
     /**
      * Changing an order in the orders storage
      *
      * @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} data - 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 {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".
-     *
      * @return {IBaseOrdersEntity} 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.
      */
-    updateOrderByMarkerAndId(marker: string, id: number, data: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | IError>;
+    updateOrderByMarkerAndId(marker: string, id: number, body: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | IError>;
 }
 /**
  * @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.
- * @property {Array<IOrderByMarkerEntity>} items - Array of order storage objects. Example: .
- *
  * @description Represents a response from the order storage by marker.
  */
 interface IOrdersByMarkerEntity {
     total: number;
-    items: Array<IOrderByMarkerEntity>;
+    items: IOrderByMarkerEntity[];
 }
 /**
  * Interface representing a picture entity.
@@ -106,7 +161,6 @@ interface IOrdersByMarkerEntity {
  * @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".
- *
  * @description This interface defines the structure for a picture entity, including its filename, download link, size, and preview link.
  */
 interface IPicture {
@@ -118,43 +172,32 @@ interface IPicture {
 /**
  * @interface IOrderProducts
  *
- * @property {number} id - Object identifier. Example: 1.
- * @property {string} title - Product title. Example: "Product 1".
- * @property {string | null} sku - Product SKU. Example: "SKU-123".
- * @property {number} price - Product price. Example: 99.99.
- * @property {number | null} quantity - Product quantity. Example: 2.
- * @property {Array<IPicture>} previewImage - Array of product images.
- *
+ * @property {number} productId - Product title. Example: 2957.
+ * @property {number} quantity - Product quantity. Example: 1.
  * @description Represents a product in an order.
  */
 interface IOrderProducts {
-    id: number;
-    title: string;
-    sku: string | null;
-    price: number;
-    quantity: number | null;
-    previewImage: Array<IPicture> | null;
+    productId: number;
+    quantity: number;
 }
 /**
  * @interface IOrdersFormData
  *
  * @property {string} marker - Marker of form field. Example: "name_1".
- * @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 {
     marker: string;
-    value: any;
     type: string;
+    value: any;
 }
 /**
  * @interface IOrderProductData
  *
  * @property {number} productId - Product identifier. Example: 1.
  * @property {number} quantity - Quantity of the product. Example: 2.
- *
  * @description Represents a product data in an order.
  */
 interface IOrderProductData {
@@ -165,65 +208,92 @@ interface IOrderProductData {
  * @interface IBaseOrdersEntity
  *
  * @property {number} id - Object identifier. Example: 1.
- * @property {string} formIdentifier - Text identifier of the form status. Example: "bar-orders-form".
+ * @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 {Array<IOrdersFormData>} formData - Data submitted by the form linked to the order store. Example: [{ marker: "name_1", value: "Name", type: "string" }].
- * @property {Array<IOrderProducts>} products - Array of products added to order. Example: .
- * @property {string} [createdDate] - Order creation date. Example: "2023-10-01T12:00:00Z".
- * @property {string} totalSum - Total order amount. Example: "99.99".
+ * @property {IOrdersFormData[]} formData - Data submitted by the form linked to the order store. Example:
+    [
+      {
+        "marker": "name_1",
+        "value": "Name",
+        "type": "string"
+      }
+    ]
+ * @property {IOrderProducts[]} 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: "99.99".
+ * @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;
     formIdentifier: string;
     paymentAccountIdentifier: string;
-    formData: Array<IOrdersFormData>;
-    products: Array<IOrderProductData>;
-    createdDate?: string;
-    totalSum: number;
+    formData: IOrdersFormData[];
+    products: IOrderProductData[];
     currency: string;
+    totalSum: number;
+    createdDate?: string;
     statusIdentifier?: string;
 }
 /**
  * @interface IBaseOrdersEntityResponse
  *
- * @property {Array<IBaseOrdersEntity>} items - Array of order storage objects. Example: .
+ * @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.
- *
  * @description Represents a response from the order storage.
  */
 interface IBaseOrdersEntityResponse {
-    items: Array<IBaseOrdersEntity>;
+    items: IBaseOrdersEntity[];
     total: string | number;
 }
 /**
  * @interface IOrdersEntity
  *
  * @property {number} id - Object identifier. Example: 1.
- * @property {Record<string, any>} localizeInfos - Name considering localization. Example: .
+ * @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 {number | null} generalTypeId - Type identifier. Example: 1
  * @property {string} formIdentifier - Textual identifier for the form used by the order storage. Example: "bar-orders-form".
- * @property {Array<{identifier:string}>} paymentAccountIdentifiers - Array of textual identifiers of payment accounts used by the order storage. Example: [{ identifier: "payment-1" }].
- * @property {number | null} position - Example: 1.
- *
+ * @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.
  */
 interface IOrdersEntity {
     id: number;
-    localizeInfos: Record<string, any>;
+    localizeInfos: ILocalizeInfo;
+    position: number | null;
     identifier: string | null;
-    generalTypeId: number | null;
     formIdentifier: string | null;
-    paymentAccountIdentifiers: Array<IPaymentAccountIdentifiers>;
-    position: number | null;
+    generalTypeId: number | null;
+    paymentAccountIdentifiers: IPaymentAccountIdentifiers[];
 }
 /**
  * @interface IPaymentAccountIdentifiers
  *
  * @property {string} identifier - Textual identifier of the payment account. Example: "payment-1".
- *
  * @description Represents an identifier for a payment account used in an order.
  */
 interface IPaymentAccountIdentifiers {
@@ -234,49 +304,61 @@ interface IPaymentAccountIdentifiers {
  *
  * @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 | Array<IOrdersFormData>} formData - Form data linked to the order repository. Example: [{ marker: "name_1", value: "Name", type: "string" }].
- * @property {Array<IOrderProductData>} products - An array of ordered products. Example: .
- *
+ * @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 {
     formIdentifier: string;
     paymentAccountIdentifier: string;
-    formData: IOrdersFormData | Array<IOrdersFormData>;
-    products: Array<IOrderProductData>;
+    formData: IOrdersFormData | IOrdersFormData[];
+    products: IOrderProductData[];
 }
 /**
  * @interface IOrderByMarkerEntity
  *
- * @property {string} [attributeSetIdentifier] - Text identifier of the attribute set. Example: "attribute-set-1".
- * @property {string} statusIdentifier - Text identifier of the order status. Example: "order-status-1".
- * @property {string} formIdentifier - Text identifier of the form status. Example: "bar-orders-form".
- * @property {Array<IOrdersFormData>} formData - Data submitted by the form linked to the order store. Example: .
- * @property {Array<IOrderProducts>} products - Array of products added to order. Example: [{ id: 1, name: "Product 1", quantity: 2 }].
+ * @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} createdDate - Date when the order was created. Example: "2023-10-01T12:00:00Z".
- * @property {string} paymentAccountIdentifier - Textual identifier for the order payment. Example: "payment-1".
+ * @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 {number} id - Object identifier.
- * @property {number} storageId - Identifier of the order storage object. Example: 1.
+ * @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 {
+    id: number;
+    storageId: number;
+    createdDate: string;
+    statusIdentifier?: string;
+    formIdentifier?: string;
+    formData: IOrdersFormData[];
     attributeSetIdentifier?: string;
-    statusIdentifier: string;
-    formIdentifier: string;
-    formData: Array<IOrdersFormData>;
-    products: Array<IOrderProducts>;
     totalSum: string;
     currency: string;
-    createdDate: string;
-    paymentAccountIdentifier: string;
+    paymentAccountIdentifier?: string;
     paymentAccountLocalizeInfos?: Record<string, any>;
-    id: number;
-    storageId: number;
+    products: IOrderProducts[];
     isCompleted: boolean;
 }
 export type { IBaseOrdersEntity, IBaseOrdersEntityResponse, IOrderByMarkerEntity, IOrderData, IOrderProductData, IOrderProducts, IOrdersApi, IOrdersByMarkerEntity, IOrdersEntity, IOrdersFormData, IPaymentAccountIdentifiers, IPicture, };