oneentry 1.0.128 → 1.0.131

package/dist/integration-collections/integrationCollectionsApi.d.ts

@@ -22,7 +22,8 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * Get all collections.
      * @handleName getICollections
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {object} [userQuery] - Optional set query parameters. Example:
+     * @param {object} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 0,
           "offset": 30,
@@ -58,7 +59,8 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * @handleName getICollectionRowsById
      * @param {number} id - Collection id. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {any} [userQuery] - Optional set query parameters. Example:
+     * @param {any} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 0,
           "offset": 30,
@@ -83,7 +85,8 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * Check for the existence of a text identifier (marker).
      * @handleName validateICollectionMarker
      * @param {string} marker - Collection marker. Example: "collection1".
-     * @returns {ICollectionIsValid} Returns an object with a boolean property `valid` indicating whether the marker is valid or not. Example:
+     * @returns {ICollectionIsValid} Returns an object with a boolean property `valid` indicating whether the marker is valid or not.
+     * @example
         {
           "valid": true
         }
@@ -116,7 +119,8 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * Create a record in the collection.
      * @handleName createICollectionRow
      * @param {string} marker - Collection text identifier. Example: "collection1".
-     * @param {ICollectionFormObject} body - Object for creating a record. Example:
+     * @param {ICollectionFormObject} body - Object for creating a record.
+     * @example
         {
           "formIdentifier": "collection-form",
           "formData": [
@@ -138,7 +142,8 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * @handleName updateICollectionRow
      * @param {string} marker - Text identifier of the collection. Example: "collection1".
      * @param {number} id - Row identifier in the collection. Example: 12.
-     * @param {object} body - Object for updating a record in the collection. Example:
+     * @param {object} body - Object for updating a record in the collection.
+     * @example
         {
           "formIdentifier": "collection-form",
           "formData": [

package/dist/integration-collections/integrationCollectionsApi.js

@@ -31,7 +31,8 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      * Get all collections.
      * @handleName getICollections
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {object} [userQuery] - Optional set query parameters. Example:
+     * @param {object} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 0,
           "offset": 30,
@@ -70,7 +71,8 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      * @handleName getICollectionRowsById
      * @param {number} id - Collection id. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {any} [userQuery] - Optional set query parameters. Example:
+     * @param {any} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 0,
           "offset": 30,
@@ -98,7 +100,8 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      * Check for the existence of a text identifier (marker).
      * @handleName validateICollectionMarker
      * @param {string} marker - Collection marker. Example: "collection1".
-     * @returns {ICollectionIsValid} Returns an object with a boolean property `valid` indicating whether the marker is valid or not. Example:
+     * @returns {ICollectionIsValid} Returns an object with a boolean property `valid` indicating whether the marker is valid or not.
+     * @example
         {
           "valid": true
         }
@@ -140,7 +143,8 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      * Create a record in the collection.
      * @handleName createICollectionRow
      * @param {string} marker - Collection text identifier. Example: "collection1".
-     * @param {ICollectionFormObject} body - Object for creating a record. Example:
+     * @param {ICollectionFormObject} body - Object for creating a record.
+     * @example
         {
           "formIdentifier": "collection-form",
           "formData": [
@@ -165,7 +169,8 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      * @handleName updateICollectionRow
      * @param {string} marker - Text identifier of the collection. Example: "collection1".
      * @param {number} id - Row identifier in the collection. Example: 12.
-     * @param {object} body - Object for updating a record in the collection. Example:
+     * @param {object} body - Object for updating a record in the collection.
+     * @example
         {
           "formIdentifier": "collection-form",
           "formData": [

package/dist/integration-collections/integrationCollectionsInterfaces.d.ts

@@ -17,7 +17,8 @@ interface ICollectionsApi {
      * Get all collections.
      * @handleName getICollections
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {any} [userQuery] - Query parameters. Example:
+     * @param {any} [userQuery] - Query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -53,7 +54,8 @@ interface ICollectionsApi {
      * @handleName getICollectionRowsById
      * @param {number} id - Collection id.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {any} [userQuery] - Optional set query parameters. Example:
+     * @param {any} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -73,7 +75,8 @@ interface ICollectionsApi {
      * Check for the existence of a text identifier (marker).
      * @handleName validateICollectionMarker
      * @param {string} marker - Collection marker. Example: "collection1".
-     * @returns {ICollectionIsValid} Returns an object with a boolean property `valid` indicating whether the marker is valid or not. Example:
+     * @returns {ICollectionIsValid} Returns an object with a boolean property `valid` indicating whether the marker is valid or not.
+     * @example
         {
           "valid": true
         }
@@ -106,7 +109,8 @@ interface ICollectionsApi {
      * Create a record in the collection.
      * @handleName createICollectionRow
      * @param {string} marker - Collection text identifier. Example: "collection1".
-     * @param {ICollectionFormObject} body - Object for creating a record. Example:
+     * @param {ICollectionFormObject} body - Object for creating a record.
+     * @example
         {
           "formIdentifier": "collection-form",
           "formData": [
@@ -128,7 +132,8 @@ interface ICollectionsApi {
      * @handleName updateICollectionRow
      * @param {string} marker - Text identifier of the collection. Example: "collection1".
      * @param {number} id - Row id. Example: 12.
-     * @param {ICollectionFormObject} body - Object for updating a record in the collection. Example:
+     * @param {ICollectionFormObject} body - Object for updating a record in the collection.
+     * @example
         {
           "formIdentifier": "collection-form",
           "formData": [
@@ -162,7 +167,8 @@ interface ICollectionsApi {
  * @property {number} id - Object identifier. Example: 1.
  * @property {string | null} identifier - Text identifier for record field. Example: "collection1".
  * @property {number | null} formId - Identifier for the form used by the order storage. Example: 1234.
- * @property {ILocalizeInfo} localizeInfos - Localized information about the collection. Example:
+ * @property {ILocalizeInfo} localizeInfos - Localized information about the collection.
+ * @example
     {
       "title": "Admins text"
     }
@@ -181,7 +187,8 @@ interface ICollectionEntity {
 /**
  * Collection response object
  * @interface ICollectionResponce
- * @property {ICollectionEntity[]} items - Array of collection objects. Example:
+ * @property {ICollectionEntity[]} items - Array of collection objects.
+ * @example
     [
       {
         "id": 1,
@@ -212,7 +219,8 @@ interface ICollectionFormData {
  * Collection form object
  * @interface ICollectionFormObject
  * @property {string} formIdentifier - Text identifier (marker) of the form. Example: "collection-form".
- * @property {Record<string, ICollectionFormData>} formData - An object where keys are form field markers and values are arrays of ICollectionFormData objects. Example:
+ * @property {Record<string, ICollectionFormData>} formData - An object where keys are form field markers and values are arrays of ICollectionFormData objects.
+ * @example
     [
       {
         "marker": "name_1",
@@ -238,7 +246,8 @@ interface ICollectionFormObject {
  * @property {string} createdDate - Date of creation of the record. Example: "2023-01-01T00:00:00Z".
  * @property {string} updatedDate - Date of last update of the record. Example: "2023-01-02T00:00:00Z".
  * @property {number | null} [collectionId] - collectionId associated with the collection row. Example: "product", "order", "etc".
- * @property {ICollectionFormData[]} formData - Array of form data objects associated with the collection row. Example:
+ * @property {ICollectionFormData[]} formData - Array of form data objects associated with the collection row.
+ * @example
     [
       {
         "marker": "name_1",
@@ -266,7 +275,8 @@ interface ICollectionRow {
 /**
  * Collection rows response object
  * @interface ICollectionRowsResponce
- * @property {ICollectionRow[]} items - Array of collection row objects. Example:
+ * @property {ICollectionRow[]} items - Array of collection row objects.
+ * @example
     [
       {
         "id": 1,

package/dist/menus/menusInterfaces.d.ts

@@ -18,7 +18,8 @@ interface IMenus {
 }
 /**
  * @interface IMenusPages
- * @property {IMenusPages[]} children - Contains array with child page objects. Example:
+ * @property {IMenusPages[]} children - Contains array with child page objects.
+ * @example
     [
       {
         "id": null,
@@ -31,11 +32,13 @@ interface IMenus {
     ]
  * @property {number} id - The unique identifier of the menu. Example: 1.
  * @property {string} pageUrl - The page url string. Example: "about".
- * @property {ILocalizeInfo} localizeInfos - The menu data, taking into account localization. Example:
+ * @property {ILocalizeInfo} localizeInfos - The menu data, taking into account localization.
+ * @example
     {
       "title": "menu"
     }
- * @property {IAttributeValues} attributeValues - Attributes sets. Example:
+ * @property {IAttributeValues} attributeValues - Attributes sets.
+ * @example
     {
       "color": "red",
       "size": "large"
@@ -58,7 +61,8 @@ interface IMenusPages {
  * @property {number} id - The unique identifier of the menu. Example: 1.
  * @property {string} identifier - The menu identifier. Example: "main_menu".
  * @property {ILocalizeInfo} localizeInfos - Contains localization information. Example: {"title": "menu"}.
- * @property {IMenusPages[]} pages - Array of menu pages. Example:
+ * @property {IMenusPages[]} pages - Array of menu pages.
+ * @example
     [
       {
         "id": null,

package/dist/orders/ordersApi.d.ts

@@ -25,7 +25,8 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      * @param {number} [limit] - Optional parameter for pagination. Default: 30.
      * @returns {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.
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     getAllOrdersStorage(langCode?: string, offset?: number, limit?: number): Promise<IOrdersEntity[] | IError>;
     /**
@@ -37,7 +38,8 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      * @param {number} [limit] - Limit parameter. Default: 30.
      * @returns {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.
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     getAllOrdersByMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<IOrdersByMarkerEntity | IError>;
     /**
@@ -47,7 +49,8 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {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.
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     getOrderByMarker(marker: string, langCode?: string): Promise<IOrdersEntity | IError>;
     /**
@@ -58,14 +61,16 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {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.
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     getOrderByMarkerAndId(marker: string, id: number, langCode?: string): Promise<IOrderByMarkerEntity | IError>;
     /**
      * 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:
+     * @param {IOrderData} body - Object for creating an order.
+     * @example
         {
           "formIdentifier": "bar-orders-form",
           "paymentAccountIdentifier": "usd-payment",
@@ -84,7 +89,8 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {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.
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     createOrder(marker: string, body: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | IError>;
     /**
@@ -92,7 +98,8 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      * @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:
+     * @param {IOrderData} body - Object for updating an order.
+     * @example
         {
           "formIdentifier": "bar-orders-form",
           "paymentAccountIdentifier": "usd-payment",
@@ -112,7 +119,8 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {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.
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     updateOrderByMarkerAndId(marker: string, id: number, body: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | IError>;
 }

package/dist/orders/ordersApi.js

@@ -28,7 +28,8 @@ class OrdersApi extends asyncModules_1.default {
      * @param {number} [limit] - Optional parameter for pagination. Default: 30.
      * @returns {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.
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     async getAllOrdersStorage(langCode = this.state.lang, offset = 0, limit = 30) {
         const result = await this._fetchGet(`?langCode=${langCode}&limit=${limit}&offset=${offset}`);
@@ -43,7 +44,8 @@ class OrdersApi extends asyncModules_1.default {
      * @param {number} [limit] - Limit parameter. Default: 30.
      * @returns {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.
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     async getAllOrdersByMarker(marker, langCode = this.state.lang, offset = 0, limit = 30) {
         const result = await this._fetchGet(`/marker/${marker}/orders?langCode=${langCode}&limit=${limit}&offset=${offset}`);
@@ -56,7 +58,8 @@ class OrdersApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {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.
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     async getOrderByMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
@@ -70,7 +73,8 @@ class OrdersApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {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.
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     async getOrderByMarkerAndId(marker, id, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}/orders/${id}?langCode=${langCode}`);
@@ -80,7 +84,8 @@ class OrdersApi extends asyncModules_1.default {
      * 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:
+     * @param {IOrderData} body - Object for creating an order.
+     * @example
         {
           "formIdentifier": "bar-orders-form",
           "paymentAccountIdentifier": "usd-payment",
@@ -99,7 +104,8 @@ class OrdersApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {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.
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     async createOrder(marker, body, langCode = this.state.lang) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -116,7 +122,8 @@ class OrdersApi extends asyncModules_1.default {
      * @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:
+     * @param {IOrderData} body - Object for updating an order.
+     * @example
         {
           "formIdentifier": "bar-orders-form",
           "paymentAccountIdentifier": "usd-payment",
@@ -136,7 +143,8 @@ class OrdersApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {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.
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     async updateOrderByMarkerAndId(marker, id, body, langCode = this.state.lang) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/dist/orders/ordersInterfaces.d.ts

@@ -19,7 +19,8 @@ interface IOrdersApi {
      * @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.
+     * @description This method gets all the order storage objects. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     getAllOrdersStorage(langCode?: string, offset?: number, limit?: number): Promise<IOrdersEntity[] | IError>;
     /**
@@ -31,7 +32,8 @@ interface IOrdersApi {
      * @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.
+     * @description This method gets all orders from the orders storage object created by the user. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     getAllOrdersByMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<IOrdersByMarkerEntity | IError>;
     /**
@@ -41,7 +43,8 @@ interface IOrdersApi {
      * @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.
+     * @description This method retrieves one order storage object by marker. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     getOrderByMarker(marker: string, langCode?: string): Promise<IOrdersEntity | IError>;
     /**
@@ -52,14 +55,16 @@ interface IOrdersApi {
      * @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.
+     * @description This method gets a single order from the order storage object created by the user. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     getOrderByMarkerAndId(marker: string, id: number, langCode?: string): Promise<IOrderByMarkerEntity | IError>;
     /**
      * 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:
+     * @param {IOrderData} body - Object for creating an order.
+     * @example
         {
           "formIdentifier": "bar-orders-form",
           "paymentAccountIdentifier": "usd-payment",
@@ -78,7 +83,8 @@ interface IOrdersApi {
      * @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.
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     createOrder(marker: string, body: IOrderData, langCode: string): Promise<IBaseOrdersEntity | IError>;
     /**
@@ -86,7 +92,8 @@ interface IOrdersApi {
      * @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:
+     * @param {IOrderData} body - Object for updating an order.
+     * @example
         {
           "formIdentifier": "bar-orders-form",
           "paymentAccountIdentifier": "usd-payment",
@@ -106,14 +113,16 @@ interface IOrdersApi {
      * @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.
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     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:
+ * @property {IOrderByMarkerEntity[]} items - Array of order storage objects.
+ * @example
     [
       {
         "id": 55,
@@ -177,7 +186,8 @@ interface IPicture {
  * @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:
+ * @property {any} previewImage - Product previewImage.
+ * @example
     {
       "filename": "image.jpg",
       "downloadLink": "https://example.com/image.jpg",
@@ -244,7 +254,8 @@ interface IOrderProductsData {
  * @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:
+ * @property {IOrdersFormData[]} formData - Data submitted by the form linked to the order store.
+ * @example
     [
       {
         "marker": "name_1",
@@ -252,7 +263,8 @@ interface IOrderProductsData {
         "type": "string"
       }
     ]
- * @property {IOrderProductsData[]} products - Array of products added to order. Example:
+ * @property {IOrderProductsData[]} products - Array of products added to order.
+ * @example
     [
       {
         "id": 2957,
@@ -282,7 +294,8 @@ interface IBaseOrdersEntity {
 /**
  * Interface representing a response from the order storage.
  * @interface IBaseOrdersEntityResponse
- * @property {IBaseOrdersEntity[]} items - Array of order storage objects. Example:
+ * @property {IBaseOrdersEntity[]} items - Array of order storage objects.
+ * @example
     [
       {
         "id": 2957,
@@ -338,7 +351,8 @@ interface IPaymentAccountIdentifiers {
  * @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:
+ * @property {IOrdersFormData | IOrdersFormData[]} formData - Form data linked to the order repository.
+ * @example
     [
       {
         "marker": "name_1",
@@ -346,7 +360,7 @@ interface IPaymentAccountIdentifiers {
         "type": "string"
       }
     ]
- * @property {IOrderProductData[]} products - An array of ordered products. Example: .
+ * @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 {
@@ -363,7 +377,8 @@ interface IOrderData {
  * @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:
+ * @property {IOrdersFormData[]} formData - Data submitted by the form linked to the order store.
+ * @example
     [
       {
         "marker": "order_name",
@@ -375,8 +390,14 @@ interface IOrderData {
  * @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:
+ * @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,

package/dist/pages/pagesApi.d.ts

@@ -97,7 +97,8 @@ export default class PageApi extends AsyncModules implements IPageApi {
     /**
      * Add template data to pages
      * @handleName addTemplateToPages
-     * @param {IPagesEntity[]} data - An array of page objects (IPagesEntity[]) to which template data will be added. Example:
+     * @param {IPagesEntity[]} data - An array of page objects (IPagesEntity[]) to which template data will be added.
+     * @example
         [
           {
             "id": 8,

package/dist/pages/pagesApi.js

@@ -245,7 +245,8 @@ class PageApi extends asyncModules_1.default {
     /**
      * Add template data to pages
      * @handleName addTemplateToPages
-     * @param {IPagesEntity[]} data - An array of page objects (IPagesEntity[]) to which template data will be added. Example:
+     * @param {IPagesEntity[]} data - An array of page objects (IPagesEntity[]) to which template data will be added.
+     * @example
         [
           {
             "id": 8,

package/dist/pages/pagesInterfaces.d.ts

@@ -112,7 +112,8 @@ interface IPageConfig {
  * @property {ILocalizeInfo} localizeInfos  - The name of the page, taking into account localization. Example:
  * @property {object} processingData - Form data. Example: {}.
  * @property {number} position - The position of the object. Example: 0.
- * @property {IAttributes[]} attributes - Array of attribute values from the used attribute set for displaying the form (taking into account the specified language). Example:
+ * @property {IAttributes[]} attributes - Array of attribute values from the used attribute set for displaying the form (taking into account the specified language).
+ * @example
     [
       {
         "type": "list",
@@ -164,7 +165,8 @@ interface IPositionForm {
  * @property {string | null} templateIdentifier     - User id of the linked template. Example: null.
  * @property {boolean} isVisible - A sign of page visibility. Example: true.
  * @property {boolean} isSync - Indication of page indexing. Example: false.
- * @property {AttributeType} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value). Example:
+ * @property {AttributeType} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value).
+ * @example
     {
       "block-text": {
         "type": "string",
@@ -212,7 +214,8 @@ interface IPositionBlock {
  * @property {Types} type - Page type. Example: "common_page".
  * @property {string | null} templateIdentifier - User id of the linked template. Example: "template".
  * @property {string | null} attributeSetIdentifier - Set of attributes id. Example: "page".
- * @property {AttributeType} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value). Example:
+ * @property {AttributeType} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value).
+ * @example
     {
       "text": {
         "type": "string",
@@ -224,14 +227,16 @@ interface IPositionBlock {
  * @property {boolean} isSync - Indication of page indexing. Example: true.
  * @property {any} [template] - Template object. Example:
  * @property {number} [position] - Item number (for sorting). Example: 2.
- * @property {any} [config] - Output settings for catalog pages. Example:
+ * @property {any} [config] - Output settings for catalog pages.
+ * @example
     {
       "rowsPerPage": 1,
       "productsPerRow": 1
     }
  * @property {number} [products] - The number of products linked to the page. Example: 0.
  * @property {number} [childrenCount] - Children count. Example: 1.
- * @property {any} [blocks] - blocks. Example:
+ * @property {any} [blocks] - blocks.
+ * @example
     {
       "id": 4,
       "attributeSetIdentifier": null,