oneentry 1.0.126 → 1.0.127

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

@@ -4,80 +4,75 @@ import type { IError } from '../base/utils';
 import type { IFileUploading, IUploadingQuery, IUploadingReturn } from './fileUploadingInterfaces';
 /**
  * Controllers for working with file uploading
- *
  * @handle /api/content/files
  * @class FileUploadingApi
- * @extends AsyncModules
+ * @augments AsyncModules
  * @implements {IFileUploading}
- *
  * @description This class provides methods to upload and delete files in a cloud file storage, as well as retrieve files by parameters.
  */
 export default class FileUploadingApi extends AsyncModules implements IFileUploading {
     protected state: StateModule;
     protected _url: string;
+    /**
+     *
+     */
     constructor(state: StateModule);
     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:
-        {
-          "type": "page",
-          "entity": "editor",
-          "id": 3787,
-          "width": 0,
-          "height": 0,
-          "compress": true,
-          "template": 1
-        }
-     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
-     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
-     * @param {number} [fileQuery.width] - Optional width parameter. Example: 0.
-     * @param {number} [fileQuery.height] - Optional height parameter. Example: 0.
-     * @param {boolean} [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true.
-     * @param {any} [fileQuery.template] - preview template identifier. Example: 1.
-     * @return {IUploadingReturn[]} Uploads a file to an Amazon S3-compatible cloud file storage.
+     * @param   {File | Blob}        file                 - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
+     * @param   {IUploadingQuery}    [fileQuery]          - Optional set query parameters. Example:
+                                                          {
+                                                          "type": "page",
+                                                          "entity": "editor",
+                                                          "id": 3787,
+                                                          "width": 0,
+                                                          "height": 0,
+                                                          "compress": true,
+                                                          "template": 1
+                                                          }
+     * @param   {string}             [fileQuery.type]     - Type, determines the folder name in the storage. Example: "page".
+     * @param   {string}             [fileQuery.entity]   - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param   {number}             [fileQuery.id]       - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param   {number}             [fileQuery.width]    - Optional width parameter. Example: 0.
+     * @param   {number}             [fileQuery.height]   - Optional height parameter. Example: 0.
+     * @param   {boolean}            [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true.
+     * @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:
-        {
-          "type": "page",
-          "entity": "editor",
-          "id": 3787,
-          "template": 1
-        }
-     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
-     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
-     * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
-     * @return {any} Returns a promise that resolves to the result of the deletion operation or an error object if there was an issue.
+     * @param   {string}          [filename]           - File name. Example: "file.png".
+     * @param   {IUploadingQuery} [fileQuery]          - Optional set query parameters. Example:
+                                                       {
+                                                       "type": "page",
+                                                       "entity": "editor",
+                                                       "id": 3787,
+                                                       "template": 1
+                                                       }
+     * @param   {string}          [fileQuery.type]     - Type, determines the folder name in the storage. Example: "page".
+     * @param   {string}          [fileQuery.entity]   - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param   {number}          [fileQuery.id]       - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @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>;
     /**
      * Get file by parameters.
-     *
      * @handleName getFile
-     *
-     * @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.
-     * @return {any} Returns a promise that resolves to a Blob object containing the file data or an error object if there was an issue.
+     * @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.
      */

package/dist/file-uploading/fileUploadingApi.js

@@ -3,19 +3,21 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable jsdoc/reject-any-type */
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 // import { IFileEntity } from './fileUploadingInterfaces';
 /**
  * Controllers for working with file uploading
- *
  * @handle /api/content/files
  * @class FileUploadingApi
- * @extends AsyncModules
+ * @augments AsyncModules
  * @implements {IFileUploading}
- *
  * @description This class provides methods to upload and delete files in a cloud file storage, as well as retrieve files by parameters.
  */
 class FileUploadingApi extends asyncModules_1.default {
+    /**
+     *
+     */
     constructor(state) {
         super(state);
         this._defaultQuery = {
@@ -30,28 +32,26 @@ 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:
-        {
-          "type": "page",
-          "entity": "editor",
-          "id": 3787,
-          "width": 0,
-          "height": 0,
-          "compress": true,
-          "template": 1
-        }
-     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
-     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
-     * @param {number} [fileQuery.width] - Optional width parameter. Example: 0.
-     * @param {number} [fileQuery.height] - Optional height parameter. Example: 0.
-     * @param {boolean} [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true.
-     * @param {any} [fileQuery.template] - preview template identifier. Example: 1.
-     * @return {IUploadingReturn[]} Uploads a file to an Amazon S3-compatible cloud file storage.
+     * @param   {File | Blob}        file                 - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
+     * @param   {IUploadingQuery}    [fileQuery]          - Optional set query parameters. Example:
+                                                          {
+                                                          "type": "page",
+                                                          "entity": "editor",
+                                                          "id": 3787,
+                                                          "width": 0,
+                                                          "height": 0,
+                                                          "compress": true,
+                                                          "template": 1
+                                                          }
+     * @param   {string}             [fileQuery.type]     - Type, determines the folder name in the storage. Example: "page".
+     * @param   {string}             [fileQuery.entity]   - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param   {number}             [fileQuery.id]       - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param   {number}             [fileQuery.width]    - Optional width parameter. Example: 0.
+     * @param   {number}             [fileQuery.height]   - Optional height parameter. Example: 0.
+     * @param   {boolean}            [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true.
+     * @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.
      */
@@ -64,22 +64,20 @@ 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:
-        {
-          "type": "page",
-          "entity": "editor",
-          "id": 3787,
-          "template": 1
-        }
-     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
-     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
-     * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
-     * @return {any} Returns a promise that resolves to the result of the deletion operation or an error object if there was an issue.
+     * @param   {string}          [filename]           - File name. Example: "file.png".
+     * @param   {IUploadingQuery} [fileQuery]          - Optional set query parameters. Example:
+                                                       {
+                                                       "type": "page",
+                                                       "entity": "editor",
+                                                       "id": 3787,
+                                                       "template": 1
+                                                       }
+     * @param   {string}          [fileQuery.type]     - Type, determines the folder name in the storage. Example: "page".
+     * @param   {string}          [fileQuery.entity]   - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param   {number}          [fileQuery.id]       - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @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.
      */
@@ -90,19 +88,18 @@ class FileUploadingApi extends asyncModules_1.default {
     }
     /**
      * Get file by parameters.
-     *
      * @handleName getFile
-     *
-     * @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.
-     * @return {any} Returns a promise that resolves to a Blob object containing the file data or an error object if there was an issue.
+     * @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.
      */
     async getFile(id, type, entity, filename, template) {
+        // eslint-disable-next-line no-undef
         const response = await fetch(this._getFullPath(`?id=${id}&type=${type}&entity=${entity}${`&filename=${filename}`}${template ? `&template=${template}` : ''}`), {
             method: 'GET',
             headers: {

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

@@ -1,82 +1,75 @@
 import type { IError } from '../base/utils';
 /**
  * Interface for uploading, deleting, and retrieving files in the CMS.
- *
  * @interface IFileUploading
- *
- * @property {function} upload - Upload file from CMS.
- * @property {function} delete - Delete file from CMS.
- * @property {function} getFile - Get file by parameters.
+ * @property {Function} upload  - Upload file from CMS.
+ * @property {Function} delete  - Delete file from CMS.
+ * @property {Function} getFile - Get file by parameters.
  * @description This interface defines methods for uploading, deleting, and retrieving files in the CMS.
  */
 interface IFileUploading {
     /**
      * 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:
-        {
-          "type": "page",
-          "entity": "editor",
-          "id": 3787,
-          "width": 0,
-          "height": 0,
-          "compress": true,
-          "template": 1
-        }
-     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
-     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
-     * @param {number} [fileQuery.width] - Optional width parameter. Example: 0.
-     * @param {number} [fileQuery.height] - Optional height parameter. Example: 0.
-     * @param {boolean} [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true.
-     * @param {any} [fileQuery.template] - preview template identifier. Example: 1.
-     * @return {IUploadingReturn[]} Uploads a file to an Amazon S3-compatible cloud file storage.
+     * @param   {File | Blob}        file                 - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
+     * @param   {IUploadingQuery}    [fileQuery]          - Optional set query parameters. Example:
+                                                          {
+                                                          "type": "page",
+                                                          "entity": "editor",
+                                                          "id": 3787,
+                                                          "width": 0,
+                                                          "height": 0,
+                                                          "compress": true,
+                                                          "template": 1
+                                                          }
+     * @param   {string}             [fileQuery.type]     - Type, determines the folder name in the storage. Example: "page".
+     * @param   {string}             [fileQuery.entity]   - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param   {number}             [fileQuery.id]       - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param   {number}             [fileQuery.width]    - Optional width parameter. Example: 0.
+     * @param   {number}             [fileQuery.height]   - Optional height parameter. Example: 0.
+     * @param   {boolean}            [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true.
+     * @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:
-        {
-          "type": "page",
-          "entity": "editor",
-          "id": 3787,
-          "template": 1
-        }
-     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
-     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
-     * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
-     * @return {any} Returns a promise that resolves to the result of the deletion operation or an error object if there was an issue.
+     * @param   {string}          [filename]           - File name. Example: "file.png".
+     * @param   {IUploadingQuery} [fileQuery]          - Optional set query parameters. Example:
+                                                       {
+                                                       "type": "page",
+                                                       "entity": "editor",
+                                                       "id": 3787,
+                                                       "template": 1
+                                                       }
+     * @param   {string}          [fileQuery.type]     - Type, determines the folder name in the storage. Example: "page".
+     * @param   {string}          [fileQuery.entity]   - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param   {number}          [fileQuery.id]       - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @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.
-     *
-     * @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".
-     * @return {Blob} A promise that resolves to a Blob object or an error.
+     * @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.
      * @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>;
 }
 /**
  * Represents a file entity with a file object or string path.
- *
  * @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.
  */
@@ -85,14 +78,12 @@ interface IFileEntity {
 }
 /**
  * Represents a query for uploading files, including type, entity, and optional parameters like width, height, and compression.
- *
  * @interface IUploadingQuery
- *
- * @property {string} type - Type, determines the folder name in the storage. Example: "page".
- * @property {string} entity - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
- * @property {number} id - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
- * @property {number} [width] - Width parameter. Example: 0.
- * @property {number} [height] - Height parameter. Example: 0.
+ * @property {string}  type       - Type, determines the folder name in the storage. Example: "page".
+ * @property {string}  entity     - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+ * @property {number}  id         - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+ * @property {number}  [width]    - Width parameter. Example: 0.
+ * @property {number}  [height]   - Height parameter. Example: 0.
  * @property {boolean} [compress] - Flag of optimization (compression) for images. Example: true.
  * @description Represents a query for uploading files, including type, entity, and optional parameters like width, height, and compression.
  */
@@ -104,12 +95,10 @@ interface IUploadingQuery {
 }
 /**
  * Represents the return value of an uploading operation, including the filename, download link, and file size.
- *
  * @interface IUploadingReturn
- *
- * @property {string} filename - Filename with relative path. Example: "uploads/file.png".
+ * @property {string} filename     - Filename with relative path. Example: "uploads/file.png".
  * @property {string} downloadLink - Link for downloading the file. Example: "https://example.com/uploads/file.png".
- * @property {number} size - Size of the file in bytes. Example: 1024.
+ * @property {number} size         - Size of the file in bytes. Example: 1024.
  * @description Represents the return value of an uploading operation, including the filename, download link, and file size.
  */
 interface IUploadingReturn {

package/dist/forms/formsApi.d.ts

@@ -4,38 +4,39 @@ import type { IError } from '../base/utils';
 import type { IForms, IFormsEntity } from './formsInterfaces';
 /**
  * Controllers for forms objects
- *
  * @class FormsApi
- * @extends AsyncModules
+ * @augments AsyncModules
  * @implements {IForms}
- *
  * @description This class provides methods to interact with forms, including retrieving all forms and getting a form by its marker.
  */
 export default class FormsApi extends AsyncModules implements IForms {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * Initializes the FormsApi with the provided state module.
+     * @class
+     * @class FormsApi
+     * @param {StateModule} state - The state module containing configuration data.
+     * @description Constructor initializes the FormsApi with a given state.
+     */
     constructor(state: StateModule);
     /**
      * Get all forms.
-     *
      * @handleName getAllForms
-     *
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Parameter for pagination. Default: 0.
-     * @param {number} [limit] - Parameter for pagination. Default: 30.
-     * @return {IFormsEntity[]} Returns array for all objects of type FormEntity.
+     * @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 {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>;
     /**
      * Get one form by form marker.
-     *
      * @handleName getFormByMarker
-     *
-     * @param {string} marker - Marker of form. Example: "contact_form".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IFormsEntity} Returns object of type FormEntity.
+     * @param   {string}       marker     - Marker of form. Example: "contact_form".
+     * @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.
      */

package/dist/forms/formsApi.js

@@ -6,27 +6,30 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for forms objects
- *
  * @class FormsApi
- * @extends AsyncModules
+ * @augments AsyncModules
  * @implements {IForms}
- *
  * @description This class provides methods to interact with forms, including retrieving all forms and getting a form by its marker.
  */
 class FormsApi extends asyncModules_1.default {
+    /**
+     * Initializes the FormsApi with the provided state module.
+     * @class
+     * @class FormsApi
+     * @param {StateModule} state - The state module containing configuration data.
+     * @description Constructor initializes the FormsApi with a given state.
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/forms';
     }
     /**
      * Get all forms.
-     *
      * @handleName getAllForms
-     *
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Parameter for pagination. Default: 0.
-     * @param {number} [limit] - Parameter for pagination. Default: 30.
-     * @return {IFormsEntity[]} Returns array for all objects of type FormEntity.
+     * @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 {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.
      */
@@ -36,12 +39,10 @@ class FormsApi extends asyncModules_1.default {
     }
     /**
      * Get one form by form marker.
-     *
      * @handleName getFormByMarker
-     *
-     * @param {string} marker - Marker of form. Example: "contact_form".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IFormsEntity} Returns object of type FormEntity.
+     * @param   {string}       marker     - Marker of form. Example: "contact_form".
+     * @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.
      */