oneentry 1.0.122 → 1.0.124

package/dist/orders/ordersInterfaces.d.ts

@@ -1,6 +1,6 @@
 import type { IError } from '../base/utils';
 /**
- * Represents an interface object of Orders Api.
+ * @interface IOrdersApi
  *
  * @property {function} getOrderByMarker - Retrieve one order storage object by marker.
  * @property {function} createOrder - Creation of an order in the order storage.
@@ -9,32 +9,105 @@ 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 {
-    createOrder(marker: string, data: IOrderData): Promise<IBaseOrdersEntity | IError>;
+    /**
+     * 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.
+     * @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>;
+    /**
+     * 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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getOrderByMarker(marker: string, langCode?: string): Promise<IOrdersEntity | IError>;
-    updateOrderByMarkerAndId(marker: string, id: number, data: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | 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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getOrderByMarkerAndId(marker: string, id: number, langCode?: string): Promise<IOrderByMarkerEntity | IError>;
-    getAllOrdersStorage(langCode?: string, offset?: number, limit?: number): Promise<Array<IOrdersEntity> | 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} 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 {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>;
+    /**
+     * 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 {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>;
 }
 /**
- * Represents a form data.
+ * @interface IOrdersByMarkerEntity
+ *
+ * @property {number} total - Total number of found records. Example: 100.
+ * @property {Array<IOrderByMarkerEntity>} items - Array of order storage objects. Example: .
  *
- * @interface
- * @property {number} total - Total number of found records.
- * @property {Array<IOrderByMarkerEntity>} items
+ * @description Represents a response from the order storage by marker.
  */
 interface IOrdersByMarkerEntity {
     total: number;
     items: Array<IOrderByMarkerEntity>;
 }
 /**
- * @property {string} filename
- * @property {string} downloadLink
- * @property {number} size
- * @property {string} previewLink
+ * Interface representing a picture entity.
+ *
+ * @interface IPicture
+ *
+ * @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".
+ *
+ * @description This interface defines the structure for a picture entity, including its filename, download link, size, and preview link.
  */
 interface IPicture {
     filename: string;
@@ -43,7 +116,16 @@ interface IPicture {
     previewLink: string;
 }
 /**
- * IOrderProducts
+ * @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.
+ *
+ * @description Represents a product in an order.
  */
 interface IOrderProducts {
     id: number;
@@ -51,12 +133,16 @@ interface IOrderProducts {
     sku: string | null;
     price: number;
     quantity: number | null;
-    previewImage: Array<IPicture>;
+    previewImage: Array<IPicture> | null;
 }
 /**
- * @property {string} marker - Marker of form field.
- * @property {string} value - Value
- * @property {string} type - Type of value. Example "string"
+ * @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".
+ *
+ * @description Represents a form data for orders.
  */
 interface IOrdersFormData {
     marker: string;
@@ -64,28 +150,32 @@ interface IOrdersFormData {
     type: string;
 }
 /**
- * @interface
- * @property {number} productId - Product identifier.
- * @property {number} quantity - Quantity of the product.
+ * @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 {
     productId: number;
     quantity: number;
 }
 /**
- * @interface
- * @property {string} statusIdentifier - Text identifier of the order status.
- * @property {string} formIdentifier - Text identifier of the form status.
- * @property {string} statusIdentifier - Text identifier of order status object (if not set, default status will be assigned).
- * @property {string} paymentAccountIdentifier - Text identifier of the order payment.
- * @property {Array<IOrdersFormData>} formData - Data submitted by the form linked to the order store.
- * @property {Array<IOrderProducts>} products - Array of products added to order.
- * @property {string} createdDate - Order creation date.
- * @property {string} totalSum - Total order amount.
- * @property {string} currency - Currency used to pay for the order.
- * @property {string} createdDate - Date when the order was created.
+ * @interface IBaseOrdersEntity
+ *
+ * @property {number} id - Object identifier. Example: 1.
+ * @property {string} formIdentifier - Text identifier of the form status. 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 {string} currency - Currency used to pay for the order. Example: "USD".
+ * @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>;
@@ -93,22 +183,32 @@ interface IBaseOrdersEntity {
     createdDate?: string;
     totalSum: number;
     currency: string;
-    id: number;
     statusIdentifier?: string;
 }
+/**
+ * @interface IBaseOrdersEntityResponse
+ *
+ * @property {Array<IBaseOrdersEntity>} items - Array of order storage objects. Example: .
+ * @property {string | number} total - Total number of found records. Example: 100.
+ *
+ * @description Represents a response from the order storage.
+ */
 interface IBaseOrdersEntityResponse {
     items: Array<IBaseOrdersEntity>;
     total: string | number;
 }
 /**
- * @interface
- * @property {number} id - Object identifier.
- * @property {Record<string, any>} localizeInfos - Name considering localization.
- * @property {string} identifier - Textual identifier for the record field.
- * @property {number} generalTypeId - Type identifier.
- * @property {string} formIdentifier - Textual identifier for the form used by the order storage.
- * @property {Array<{identifier:string}>} paymentAccountIdentifiers - Array of textual identifiers of payment accounts used by the order storage.
- * @property {number | null} position
+ * @interface IOrdersEntity
+ *
+ * @property {number} id - Object identifier. Example: 1.
+ * @property {Record<string, any>} localizeInfos - Name considering localization. Example: .
+ * @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.
+ *
+ * @description Represents an order storage object.
  */
 interface IOrdersEntity {
     id: number;
@@ -120,17 +220,24 @@ interface IOrdersEntity {
     position: number | null;
 }
 /**
- * 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 {
     identifier: string;
 }
 /**
- * @interface
- * @property {string} formIdentifier - Text identifier of the form object linked to the order repository.
- * @property {string} paymentAccountIdentifier - Text identifier of the payment object linked to the order repository.
- * @property {IOrdersFormData | Array<IOrdersFormData>} formData - Form data linked to the order repositor.
- * @property {Array<IOrderProductData>} products - An array of ordered products.
+ * @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 | 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: .
+ *
+ * @description Represents the data required to create or update an order in the order storage.
  */
 interface IOrderData {
     formIdentifier: string;
@@ -139,17 +246,23 @@ interface IOrderData {
     products: Array<IOrderProductData>;
 }
 /**
- * @interface
- * @property {string} statusIdentifier - Text identifier of the order status.
- * @property {string} formIdentifier - Text identifier of the form status.
- * @property {Array<IOrdersFormData>} formData - Data submitted by the form linked to the order store.
- * @property {Array<IOrderProducts>} products - Array of products added to order.
- * @property {string} totalSum - Total order amount.
- * @property {string} currency - Currency used to pay for the order.
- * @property {string} createdDate - Date when the order was created.
- * @property {string} paymentAccountIdentifier - Textual identifier for the order payment.
- * @property {Record<string, any>} paymentAccountLocalizeInfos - Payment account name considering localization.
- * @property {boolean} isHistory - Indicates that the order has been saved in the order history.
+ * @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 {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 {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 {boolean} isCompleted - Indicates that the order has been completed. Example: true.
+ *
+ * @description Represents an order storage object created by the user.
  */
 interface IOrderByMarkerEntity {
     attributeSetIdentifier?: string;
@@ -161,8 +274,9 @@ interface IOrderByMarkerEntity {
     currency: string;
     createdDate: string;
     paymentAccountIdentifier: string;
-    paymentAccountLocalizeInfos: Record<string, any>;
-    isHistory: boolean;
+    paymentAccountLocalizeInfos?: Record<string, any>;
     id: number;
+    storageId: number;
+    isCompleted: boolean;
 }
 export type { IBaseOrdersEntity, IBaseOrdersEntityResponse, IOrderByMarkerEntity, IOrderData, IOrderProductData, IOrderProducts, IOrdersApi, IOrdersByMarkerEntity, IOrdersEntity, IOrdersFormData, IPaymentAccountIdentifiers, IPicture, };

package/dist/pages/pagesApi.d.ts

@@ -13,91 +13,150 @@ export default class PageApi extends AsyncModules implements IPageApi {
     /**
      * Get all top-level page objects.
      *
-     * @param {string} [langCode] - lang code
+     * @handleName getRootPages
      *
-     * @returns Returns all created pages without parents as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity[]} Returns all created pages without parents as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description
      */
     getRootPages(langCode?: string): Promise<Array<IPagesEntity> | IError>;
     /**
      * Get all page objects with product information as an array.
      *
-     * @param {string} [langCode] - lang code
+     * @handleName getPages
+     *
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity[]} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data).
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @description Get all page objects with product information as an array.
      */
     getPages(langCode?: string): Promise<Array<IPagesEntity> | IError>;
     /**
      * Get page object with information about forms, blocks, menus, linked to the page.
      *
-     * @param {number} [id] - Page object identifier
-     * @param {string} [langCode] - lang code
+     * @handleName getPageById
      *
-     * @returns Returns PageEntity object
+     * @param {number} id - The unique identifier of the page to be fetched. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity} Returns PageEntity object
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Get page object with information about forms, blocks, menus, linked to the page.
      */
     getPageById(id: number, langCode?: string): Promise<IPagesEntity | IError>;
     /**
      * Get page object with information about forms, blocks, menus, linked to the page by URL.
      *
-     * @param {string} [url] - Page URL
-     * @param {string} [langCode] - lang code
+     * @handleName getPageByUrl
+     *
+     * @param {string} url - Page URL. Example: "about".
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @returns Returns PageEntity object
+     * @return {IPagesEntity} Returns PageEntity object
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Get page object with information about forms, blocks, menus, linked to the page by URL.
      */
     getPageByUrl(url: string, langCode?: string): Promise<IPagesEntity | IError>;
     /**
      * Get child pages object with information as an array.
      *
-     * @param {string} [url] - Parent page URL
-     * @param {string} [langCode] - Required parameter lang code
+     * @handleName getChildPagesByParentUrl
+     *
+     * @param {string} url - The URL of the parent page for which child pages are to be fetched. Example: "about/our-team".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data) for the selected parent
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data) for the selected parent
+     * @description Get child pages object with information as an array.
      */
     getChildPagesByParentUrl(url: string, langCode?: string): Promise<Array<IPagesEntity> | IError>;
     /**
      * Get all blocks by page url.
      *
-     * @param {string} [url] - Page URL
-     * @param {string} [langCode] - lang code
+     * @handleName getBlocksByPageUrl
      *
-     * @returns Returns all blocks as an array of PositionBlock objects or an empty array [] (if there is no data) for the selected parent
+     * @param {string} url - Page URL. Example: "about".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPositionBlock[]} Returns all blocks as an array of PositionBlock objects or an empty array [] (if there is no data) for the selected parent
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Get all blocks by page url.
      */
     getBlocksByPageUrl(url: string, langCode?: string): Promise<Array<IPositionBlock> | IError>;
     /**
      * Get all forms by page url.
      *
-     * @param {string} [url] - Page URL
-     * @param {string} [langCode] - lang code
+     * @handleName getFormsByPageUrl
+     *
+     * @param {string} url - The URL of the page for which forms are to be fetched. Example: "about".
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @returns Returns all forms as an array of PositionForm objects or an empty array [] (if there is no data) for the selected parent
+     * @return {IPositionForm[]} Returns all forms as an array of PositionForm objects or an empty array [] (if there is no data) for the selected parent
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Get all forms by page url.
      */
     getFormsByPageUrl(url: string, langCode?: string): Promise<Array<IPositionForm> | IError>;
     /**
      * Get settings for the page.
      *
-     * @param {string} [url] - Page URL
+     * @handleName getConfigPageByUrl
+     *
+     * @param {string} url - Page URL. Example: "about".
      *
-     * @returns Returns a ConfigPage object with page display settings
+     * @return {IPageConfig} Returns a ConfigPage object with page display settings
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Get settings for the page.
      */
     getConfigPageByUrl(url: string): Promise<IPageConfig | IError>;
     /**
      * Quick search for page objects with limited output.
      *
-     * @param {string} [name] - Text for searching page objects (search is performed on the title field of the localizeInfos object with the language taken into account)
-     * @param {string} [langCode] - lang code
+     * @handleName searchPage
+     *
+     * @param {string} name - Text for searching page objects (search is performed on the title field of the localizeInfos object with the language taken into account). Example: "About Us".
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @returns Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @return {IPagesEntity[]} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Quick search for page objects with limited output.
      */
     searchPage(name: string, langCode?: string): Promise<Array<IPagesEntity> | IError>;
     /**
-     * addTemplateToPages
-     * @param data
-     * @returns
+     * Add template data to pages
+     *
+     * @handleName addTemplateToPages
+     *
+     * @param data - An array of page objects (IPagesEntity[]) to which template data will be added. Example: .
+     *
+     * @return - An array of page objects with template data added
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Add template data to pages
      */
     protected addTemplateToPages(data: IPagesEntity[]): Promise<IPagesEntity[]>;
     /**
-     * addTemplateToPage by page templateIdentifier
-     * @param data - page object
-     * @returns
+     * Add template data to page by page templateIdentifier
+     *
+     * @handleName addTemplateToPage
+     *
+     * @param data - An array of page objects (IPagesEntity[]) to which template data will be added. Example: .
+     *
+     * @return - An array of page objects with template data added
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description
      */
     protected addTemplateToPage(data: IPagesEntity): Promise<IPagesEntity>;
 }