oneentry 1.0.126 → 1.0.127

package/dist/orders/ordersInterfaces.d.ts

@@ -1,151 +1,154 @@
 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} 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} 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.
  * @description Represents the API for managing orders in the order storage.
  */
 interface IOrdersApi {
     /**
      * Getting all the order storage objects.
-     *
-     * @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.
+     * @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.
      * @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.
      */
     getAllOrdersStorage(langCode?: string, offset?: number, limit?: number): Promise<IOrdersEntity[] | IError>;
     /**
      * Getting all orders from the orders storage object created by the user.
-     *
-     * @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.
-     * @return {IOrdersByMarkerEntity} Returns an object with the orders.
+     * @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.
      * @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.
      */
     getAllOrdersByMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<IOrdersByMarkerEntity | IError>;
     /**
      * Retrieve one order storage object by marker.
-     *
-     * @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.
+     * @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.
      * @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.
      */
     getOrderByMarker(marker: string, langCode?: string): Promise<IOrdersEntity | IError>;
     /**
      * Getting a single order from the order storage object created by the user.
-     *
-     * @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.
+     * @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.
      * @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.
      */
     getOrderByMarkerAndId(marker: string, id: number, langCode?: string): Promise<IOrderByMarkerEntity | IError>;
     /**
      * Creation of an order in the order storage.
-     *
-     * @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".
-     * @return {IBaseOrdersEntity} Returns an object with the created order.
+     * @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.
      * @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, 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} 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.
+     * @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.
      * @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, body: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | IError>;
 }
 /**
+ * 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 {
@@ -154,13 +157,11 @@ 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 {
@@ -170,22 +171,36 @@ interface IPicture {
     previewLink: string;
 }
 /**
+ * Interface representing a product in an order.
  * @interface IOrderProducts
- *
- * @property {number} productId - Product title. Example: 2957.
- * @property {number} quantity - Product quantity. Example: 1.
+ * @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 {
-    productId: number;
+    id: number;
     quantity: number;
+    title: string;
+    sku: string | null;
+    previewImage: any;
+    price: number;
 }
 /**
+ * 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 {
@@ -194,10 +209,10 @@ interface IOrdersFormData {
     value: any;
 }
 /**
+ * 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 {
@@ -205,61 +220,80 @@ interface IOrderProductData {
     quantity: number;
 }
 /**
+ * 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".
+ * @description Represents a product data in an order.
+ */
+interface IOrderProductsData {
+    id: number;
+    previewImage: any;
+    price: number;
+    quantity: number;
+    sku: string;
+    title: string;
+}
+/**
+ * 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 {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".
+ * @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;
     formIdentifier: string;
     paymentAccountIdentifier: string;
     formData: IOrdersFormData[];
-    products: IOrderProductData[];
+    products: IOrderProductsData[];
     currency: string;
     totalSum: number;
     createdDate?: string;
     statusIdentifier?: string;
 }
 /**
+ * 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 {
@@ -267,17 +301,17 @@ interface IBaseOrdersEntityResponse {
     total: string | number;
 }
 /**
+ * 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.
  */
@@ -291,8 +325,8 @@ interface IOrdersEntity {
     paymentAccountIdentifiers: IPaymentAccountIdentifiers[];
 }
 /**
+ * Interface representing an identifier for a payment account used in an order.
  * @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.
  */
@@ -300,19 +334,19 @@ interface IPaymentAccountIdentifiers {
     identifier: string;
 }
 /**
+ * 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 {
@@ -322,28 +356,29 @@ interface IOrderData {
     products: IOrderProductData[];
 }
 /**
+ * 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 {