oneentry 1.0.130 → 1.0.133

package/dist/blocks/blocksApi.js

@@ -29,7 +29,6 @@ class BlocksApi extends asyncModules_1.default {
      * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {IBlocksResponse} Returns BlocksEntity object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     async getBlocks(type = '', langCode = this.state.lang, offset = 0, limit = 30) {
         const response = await this._fetchPost(`?langCode=${langCode}&type=${type}&offset=${offset}&limit=${limit}`);
@@ -135,7 +134,6 @@ class BlocksApi extends asyncModules_1.default {
      * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {IProductsResponse} - Returns the total count and an array of product items in object by specified block marker.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     async getSimilarProducts(marker, langCode = this.state.lang, offset = 0, limit = 30) {
         const query = {
@@ -155,7 +153,6 @@ class BlocksApi extends asyncModules_1.default {
      * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {IProductsEntity[]} Return array of BlocksEntity object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     async getProductsByBlockMarker(marker, langCode = this.state.lang, offset = 0, limit = 30) {
         const query = {
@@ -173,7 +170,6 @@ class BlocksApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {ISearchBlock[]} Returns an array of ISearchBlock objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     async searchBlock(name, langCode = this.state.lang) {
         const result = await this._fetchGet(`/quick/search?langCode=${langCode}&name=${name}`);

package/dist/blocks/blocksInterfaces.d.ts

@@ -50,7 +50,8 @@ interface IBlocks {
  * Represents a response from the blocks API.
  * @interface IBlocksResponse
  * @property {number} total - Total number of found records. Example: 100.
- * @property {IBlockEntity[]} items - Array of block entities. Example:
+ * @property {IBlockEntity[]} items - Array of block entities.
+ * @example
     [
       {
         "attributeValues": [],
@@ -89,7 +90,8 @@ interface IBlocksResponse {
 /**
  * Represents a block entity with various attributes and properties.
  * @interface IBlockEntity
- * @property {AttributeType} attributeValues - Type of attributes used in the block. Example:
+ * @property {AttributeType} attributeValues - Type of attributes used in the block.
+ * @example
    {
     "block-text": {
       "type": "string",
@@ -101,7 +103,11 @@ interface IBlocksResponse {
     }
    }
  * @property {number} id - Unique identifier of the block. Example: 1234.
- * @property {ILocalizeInfo} localizeInfos - Localization information for the block. Example: {"key": "value"}
+ * @property {ILocalizeInfo} localizeInfos - Localization information for the block.
+ * @example
+    {
+      "key": "value"
+    }
  * @property {number} version - Version of the block entity. Example: 1.
  * @property {string} identifier - Unique string identifier for the block. Example: "block1".
  * @property {string} type - Type of the block, such as 'product', 'error_page', etc. Example: "product".
@@ -109,22 +115,24 @@ interface IBlocksResponse {
  * @property {boolean} isVisible - Indicates whether the block is visible. Example: true.
  * @property {number} [countElementsPerRow] - Number of elements displayed per row in the block, if applicable. Example: 3.
  * @property {number} [quantity] - Quantity of items in the block, if applicable. Example: 5.
- * @property {IProductsResponse} [similarProducts] - Response containing similar products associated with the block. Example:
-   {
-    "total": 10,
-    "items": []
-   }
- * @property {IProductsEntity[]} [products] - Array of product entities associated with the block. Example:
-   [
+ * @property {IProductsResponse} [similarProducts] - Response containing similar products associated with the block.
+ * @example
     {
-      "id": 1,
-      "name": "Product 1"
-    },
-    {
-      "id": 2,
-      "name": "Product 2"
+     "total": 10,
+     "items": []
     }
-   ]
+ * @property {IProductsEntity[]} [products] - Array of product entities associated with the block.
+ * @example
+    [
+     {
+       "id": 1,
+       "name": "Product 1"
+     },
+     {
+       "id": 2,
+       "name": "Product 2"
+     }
+    ]
  * @description Represents a block entity with various attributes and properties.
  */
 interface IBlockEntity {

package/dist/config.d.ts

@@ -1,4 +1,4 @@
-export declare const projectUrl = "https://stage.oneentry.cloud";
+export declare const projectUrl = "https://js-sdk-tests.oneentry.cloud";
 export declare const projectToken = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiTlBNIiwic2VyaWFsTnVtYmVyIjozLCJpYXQiOjE3NDA1OTE0MzgsImV4cCI6MTc3MjEyNzQzMX0.MWbtBoXh-MqGTWgmiMTZSkfN8N-WYv3Cv2kSPhRpFlk";
 /**
  * authData

package/dist/config.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.authData2 = exports.authData = exports.projectToken = exports.projectUrl = void 0;
-exports.projectUrl = 'https://stage.oneentry.cloud';
+// export const projectUrl = 'https://stage.oneentry.cloud';
+// export const projectToken = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiTlBNIiwic2VyaWFsTnVtYmVyIjozLCJpYXQiOjE3NDA1OTE0MzgsImV4cCI6MTc3MjEyNzQzMX0.MWbtBoXh-MqGTWgmiMTZSkfN8N-WYv3Cv2kSPhRpFlk';
+exports.projectUrl = 'https://js-sdk-tests.oneentry.cloud';
 exports.projectToken = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiTlBNIiwic2VyaWFsTnVtYmVyIjozLCJpYXQiOjE3NDA1OTE0MzgsImV4cCI6MTc3MjEyNzQzMX0.MWbtBoXh-MqGTWgmiMTZSkfN8N-WYv3Cv2kSPhRpFlk';
 /**
  * authData

package/dist/events/eventsApi.d.ts

@@ -29,7 +29,8 @@ export default class EventsApi extends AsyncModules implements IEvents {
      * @param {number} [limit] - Optional limit for pagination. Default: 30.
      * @returns {ISubscriptions} Returns an object containing all subscriptions or an error object if there was an issue.
      * @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}.
      */
     getAllSubscriptions(offset?: number, limit?: number): Promise<ISubscriptions | IError>;
     /**
@@ -40,7 +41,8 @@ export default class EventsApi extends AsyncModules implements IEvents {
      * @param {string} [langCode] - Language code. Default: "en_US".=
      * @returns {Promise<boolean | IError>} Returns true if subscription was successful, or an error object if there was an issue.
      * @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}.
      */
     subscribeByMarker(marker: string, productId: number, langCode?: string): Promise<boolean | IError>;
     /**
@@ -51,7 +53,8 @@ export default class EventsApi extends AsyncModules implements IEvents {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {any} - Returns a promise that resolves to the result of the unsubscription operation or an error object if there was an issue.
      * @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}.
      */
     unsubscribeByMarker(marker: string, productId: number, langCode?: string): Promise<boolean | IError>;
 }

package/dist/events/eventsApi.js

@@ -34,7 +34,8 @@ class EventsApi extends asyncModules_1.default {
      * @param {number} [limit] - Optional limit for pagination. Default: 30.
      * @returns {ISubscriptions} Returns an object containing all subscriptions or an error object if there was an issue.
      * @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 getAllSubscriptions(offset = 0, limit = 30) {
         const query = {
@@ -52,7 +53,8 @@ class EventsApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".=
      * @returns {Promise<boolean | IError>} Returns true if subscription was successful, or an error object if there was an issue.
      * @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 subscribeByMarker(marker, productId, langCode = this.state.lang) {
         const body = {
@@ -75,7 +77,8 @@ class EventsApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {any} - Returns a promise that resolves to the result of the unsubscription operation or an error object if there was an issue.
      * @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 unsubscribeByMarker(marker, productId, langCode = this.state.lang) {
         const body = {

package/dist/events/eventsInterfaces.d.ts

@@ -42,7 +42,8 @@ interface IEvents {
  * Represents a response from the events API containing a total count and an array of subscription items.
  * @interface ISubscriptions
  * @property {number} total - Total number of found records. Example: 100.
- * @property {{ eventMarker: string; productId: number }[]} items - Array of subscription items, each containing an event marker and a product ID. Example:
+ * @property {{ eventMarker: string; productId: number }[]} items - Array of subscription items, each containing an event marker and a product ID.
+ * @example
    [
      {
        eventMarker: 'product_price_change',

package/dist/file-uploading/fileUploadingApi.d.ts

@@ -14,15 +14,17 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
     protected state: StateModule;
     protected _url: string;
     /**
-     *
+     * Constructs a new instance of the FileUploadingApi class.
      */
     constructor(state: StateModule);
+    /** FileUploadingApi class */
     private _defaultQuery;
     /**
      * Upload file function.
      * @handleName upload
      * @param {File | Blob} file - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @example
         {
           "type": "page",
           "entity": "editor",
@@ -41,14 +43,14 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * @param {any} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {IUploadingReturn[]} Uploads a file to an Amazon S3-compatible cloud file storage.
      * @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.
      */
     upload(file: File | Blob, fileQuery?: IUploadingQuery): Promise<IUploadingReturn[] | IError>;
     /**
      * Deletes a file from the cloud file storage.
      * @handleName delete
      * @param {string} filename - File name. Example: "file.png".
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @example
         {
           "type": "page",
           "entity": "editor",
@@ -61,9 +63,16 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {any} Returns a promise that resolves to the result of the deletion operation or an error object if there was an issue.
      * @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.
      */
     delete(filename: string, fileQuery?: IUploadingQuery): Promise<any | IError>;
+    /**
+     * Create a File object from a URL.
+     * @param {string} url - The URL to fetch the file from.
+     * @param {string} filename - The name to give the created file.
+     * @param {string} [mimeType] - Optional MIME type for the file.
+     * @returns {Promise<File>} A promise that resolves to a File object.
+     */
+    createFileFromUrl(url: string, filename: string, mimeType?: string): Promise<File>;
     /**
      * Get file by parameters.
      * @handleName getFile
@@ -74,7 +83,6 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * @param {string} [template] - Preview template identifier. Example: 1.
      * @returns {any} Returns a promise that resolves to a Blob object containing the file data or an error object if there was an issue.
      * @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.
      */
     getFile(id: number, type: string, entity: string, filename: string, template?: string): Promise<any | IError>;
 }

package/dist/file-uploading/fileUploadingApi.js

@@ -4,6 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable jsdoc/reject-any-type */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/// <reference lib="dom" />
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 // import { IFileEntity } from './fileUploadingInterfaces';
 /**
@@ -16,10 +18,11 @@ const asyncModules_1 = __importDefault(require("../base/asyncModules"));
  */
 class FileUploadingApi extends asyncModules_1.default {
     /**
-     *
+     * Constructs a new instance of the FileUploadingApi class.
      */
     constructor(state) {
         super(state);
+        /** FileUploadingApi class */
         this._defaultQuery = {
             type: null,
             entity: null,
@@ -34,7 +37,8 @@ class FileUploadingApi extends asyncModules_1.default {
      * Upload file function.
      * @handleName upload
      * @param {File | Blob} file - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @example
         {
           "type": "page",
           "entity": "editor",
@@ -53,7 +57,6 @@ class FileUploadingApi extends asyncModules_1.default {
      * @param {any} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {IUploadingReturn[]} Uploads a file to an Amazon S3-compatible cloud file storage.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     async upload(file, fileQuery) {
         const query = { ...this._defaultQuery, ...fileQuery };
@@ -66,7 +69,8 @@ class FileUploadingApi extends asyncModules_1.default {
      * Deletes a file from the cloud file storage.
      * @handleName delete
      * @param {string} filename - File name. Example: "file.png".
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @example
         {
           "type": "page",
           "entity": "editor",
@@ -79,13 +83,26 @@ class FileUploadingApi extends asyncModules_1.default {
      * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {any} Returns a promise that resolves to the result of the deletion operation or an error object if there was an issue.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     async delete(filename, fileQuery) {
         const query = { ...this._defaultQuery, ...fileQuery };
         const result = await this._fetchDelete(`?filename=${filename}&` + this._queryParamsToString(query));
         return result;
     }
+    /**
+     * Create a File object from a URL.
+     * @param {string} url - The URL to fetch the file from.
+     * @param {string} filename - The name to give the created file.
+     * @param {string} [mimeType] - Optional MIME type for the file.
+     * @returns {Promise<File>} A promise that resolves to a File object.
+     */
+    async createFileFromUrl(url, filename, mimeType) {
+        // eslint-disable-next-line no-undef
+        const response = await fetch(url);
+        const blob = await response.blob();
+        const file = new File([blob], filename, { type: mimeType || blob.type });
+        return file;
+    }
     /**
      * Get file by parameters.
      * @handleName getFile
@@ -96,7 +113,6 @@ class FileUploadingApi extends asyncModules_1.default {
      * @param {string} [template] - Preview template identifier. Example: 1.
      * @returns {any} Returns a promise that resolves to a Blob object containing the file data or an error object if there was an issue.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     async getFile(id, type, entity, filename, template) {
         // eslint-disable-next-line no-undef

package/dist/file-uploading/fileUploadingInterfaces.d.ts

@@ -8,11 +8,20 @@ import type { IError } from '../base/utils';
  * @description This interface defines methods for uploading, deleting, and retrieving files in the CMS.
  */
 interface IFileUploading {
+    /**
+     * Create a File object from a URL.
+     * @param {string} url - The URL to fetch the file from.
+     * @param {string} filename - The name to give the created file.
+     * @param {string} [mimeType] - Optional MIME type for the file.
+     * @returns {Promise<File>} A promise that resolves to a File object.
+     */
+    createFileFromUrl(url: string, filename: string, mimeType?: string): Promise<File>;
     /**
      * Upload file function.
      * @handleName upload
      * @param {File | Blob} file - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @example
         {
           "type": "page",
           "entity": "editor",
@@ -31,14 +40,14 @@ interface IFileUploading {
      * @param {any} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {IUploadingReturn[]} Uploads a file to an Amazon S3-compatible cloud file storage.
      * @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.
      */
     upload(file: File | Blob, fileQuery?: IUploadingQuery): Promise<IUploadingReturn[] | IError>;
     /**
      * Deletes a file from the cloud file storage.
      * @handleName delete
      * @param {string} [filename] - File name. Example: "file.png".
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @example
         {
           "type": "page",
           "entity": "editor",
@@ -51,24 +60,23 @@ interface IFileUploading {
      * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {any} Returns a promise that resolves to the result of the deletion operation or an error object if there was an issue.
      * @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.
      */
     delete(filename: string, fileQuery?: IUploadingQuery): Promise<any | IError>;
     /**
-     * Retrieves a file by its parameters.
+     * Get file by parameters.
      * @handleName getFile
-     * @param {number} id - The ID of the file entity. Example: 3787.
-     * @param {string} type - The type of the file. Example: "page".
-     * @param {string} entity - The entity associated with the file. Example: "editor".
-     * @param {string} [filename] - Optional filename to retrieve. Example: "file.png".
-     * @returns {Blob} A promise that resolves to a Blob object or an error.
+     * @param {number} id - Object identifier, from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {string} type - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} entity - Entity name, from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {string} filename - Filename. Example: "file.png".
+     * @param {string} [template] - Preview template identifier. Example: 1.
+     * @returns {any} Returns a promise that resolves to a Blob object containing the file data or an error object if there was an issue.
      * @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.
      */
-    getFile(id: number, type: string, entity: string, filename?: string): Promise<any | IError>;
+    getFile(id: number, type: string, entity: string, filename: string, template?: string): Promise<any | IError>;
 }
 /**
- * Represents a file entity with a file object or string path.
+ * Represents a file entity that may contain a file object or a path as a string.
  * @interface IFileEntity
  * @property {File | string | null} file - File object or string representing the file path. Example: new File(["content"], "file.png", { "type": "image/png" }) or "/path/to/file.png".
  * @description Represents a file entity that may contain a file object or a path as a string.

package/dist/forms/formsApi.d.ts

@@ -28,7 +28,6 @@ export default class FormsApi extends AsyncModules implements IForms {
      * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {IFormsEntity[]} Returns array for all objects of type FormEntity.
      * @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.
      */
     getAllForms(langCode?: string, offset?: number, limit?: number): Promise<IFormsEntity[] | IError>;
     /**
@@ -38,7 +37,6 @@ export default class FormsApi extends AsyncModules implements IForms {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IFormsEntity} Returns object of type FormEntity.
      * @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.
      */
     getFormByMarker(marker: string, langCode?: string): Promise<IFormsEntity | IError>;
 }

package/dist/forms/formsApi.js

@@ -31,7 +31,6 @@ class FormsApi extends asyncModules_1.default {
      * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {IFormsEntity[]} Returns array for all objects of type FormEntity.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     async getAllForms(langCode = this.state.lang, offset = 0, limit = 30) {
         const result = await this._fetchGet(`?langCode=${langCode}&offset=${offset}&limit=${limit}`);
@@ -44,7 +43,6 @@ class FormsApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IFormsEntity} Returns object of type FormEntity.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     async getFormByMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);

package/dist/forms/formsInterfaces.d.ts

@@ -37,7 +37,8 @@ interface IForms {
  * @property {number} pageId - The identifier of the page. Example: 12.
  * @property {number} formId - The identifier of the form. Example: 321.
  * @property {number} positionId - The identifier of the position. Example: 1.
- * @property {IPosition} position - The position object. Example:
+ * @property {IPosition} position - The position object.
+ * @example
     {
       "id": 1,
       "position": 1,
@@ -61,13 +62,21 @@ interface IFromPages {
  * @property {number} id - The identifier of the object. Example: 12345.
  * @property {number | null} attributeSetId - The identifier of the attribute set being used, or null if not applicable. Example: 1234.
  * @property {string | null} type - Form type. Example: "contact".
- * @property {ILocalizeInfo} localizeInfos - The name of the form, taking into account localization. Example: {"key": "value"}.
+ * @property {ILocalizeInfo} localizeInfos - The name of the form, taking into account localization.
+ * @example
+    {
+      "key": "value"
+    }
  * @property {number} version - The version number of the object. Example: 1.
  * @property {number} position - The position of the object. Example: 1.
  * @property {string} identifier - The textual identifier for the record field. Example: "form_contact_us".
  * @property {string} processingType - Type of form processing. Example: "async".
  * @property {number | null} templateId - The identifier of the template used by the form, or null if no template is used. Example: 6789.
- * @property {IAttributes[] | Record<string, any>} attributes - The attributes of the form, which can be an array of attribute objects or a record of key-value pairs. Example: {"key": "value"}.
+ * @property {IAttributes[] | Record<string, any>} attributes - The attributes of the form, which can be an array of attribute objects or a record of key-value pairs.
+ * @example
+    {
+      "key": "value"
+    }
  * @description This interface defines the structure of a form entity, including its identifiers, attributes, and processing data.
  */
 interface IFormsEntity {

package/dist/forms-data/formsDataApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { IBodyPostFormData, IFormsByMarkerDataEntity, IFormsData, IFormsDataEntity, IPostFormResponse } from './formsDataInterfaces';
+import type { IBodyPostFormData, IFormsByMarkerDataEntity, IFormsData, IPostFormResponse } from './formsDataInterfaces';
 /**
  * Controllers for working with form data
  * @handle /api/content/form-data
@@ -17,21 +17,11 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      * Constructor for FormsDataApi class.
      */
     constructor(state: StateModule);
-    /**
-     * Get all forms data.
-     * @handleName getFormsData
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Parameter for pagination. Default: 0.
-     * @param {number} [limit] - Parameter for pagination. Default: 30.
-     * @returns {IFormsDataEntity} Returns an object containing all forms data or an error object if there was an issue.
-     * @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.
-     */
-    getFormsData(langCode?: string, offset?: number, limit?: number): Promise<IFormsDataEntity | IError>;
     /**
      * Creating an object of data save information by form
      * @handleName postFormsData
-     * @param {IBodyPostFormData} body - Request body. Example:
+     * @param {IBodyPostFormData} body - Request body.
+     * @example
         {
           "formIdentifier": "test-form",
           "formModuleConfigId": 2,
@@ -47,7 +37,12 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
           ]
         }
      * @param {string} body.formIdentifier - The identifier for the form. Example: "form".
-     * @param {FormDataType[]} body.formData - Form data. Example:
+     * @param {number} body.formModuleConfigId - The ID of the form module configuration. Example: 2.
+     * @param {string} body.moduleEntityIdentifier - The identifier of the module entity. Example: "form".
+     * @param {string | null} [body.replayTo] - The email address to which the reply should be sent.
+     * @param {string | null} [body.status] - The status of the form submission.
+     * @param {FormDataType[]} body.formData - Form data.
+     * @example
         [
           {
             "marker": "name",
@@ -55,13 +50,12 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
             "value": "Jack"
           }
         ]
-     * @param {string} body.formData.marker - The marker identifying the form field. Example: "name".
-     * @param {string} body.formData.type - The type of the form field. Example: "string".
-     * @param {string} body.formData.value - The value of the form field. Example: "Jack".
+     * @param {string} body.formData[].marker - The marker identifying the form field. Example: "name".
+     * @param {string} body.formData[].type - The type of the form field. Example: "string".
+     * @param {string} body.formData[].value - The value of the form field. Example: "Jack".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IPostFormResponse} Returns an object containing the created form data entry and message.
      * @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.
      */
     postFormsData(body: IBodyPostFormData, langCode?: string): Promise<IPostFormResponse | IError>;
     /**
@@ -69,7 +63,8 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      * @handleName getFormsDataByMarker
      * @param {string} marker - Marker of the form. Example: "contact_form".
      * @param {number} formModuleConfigId - Form module configuration ID. Example: 4.
-     * @param {object} [body] - Request body. Example:
+     * @param {object} [body] - Request body.
+     * @example
         {
           "entityIdentifier": "test",
           "userIdentifier": "",
@@ -83,7 +78,6 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {IFormsByMarkerDataEntity} Returns an object containing the form data or an error object if there was an issue.
      * @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.
      */
     getFormsDataByMarker(marker: string, formModuleConfigId: number, body?: object, isNested?: number, langCode?: string, offset?: number, limit?: number): Promise<IFormsByMarkerDataEntity | IError>;
 }