oneentry 1.0.122 → 1.0.124

package/dist/file-uploading/fileUploadingApi.js

@@ -3,11 +3,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable @typescript-eslint/no-explicit-any */
 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
+ * @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) {
@@ -25,18 +31,23 @@ class FileUploadingApi extends asyncModules_1.default {
     /**
      * Upload file function.
      *
-     * @param {File} [data] File objects. Get data as File from your unput as e.target.files[0]
+     * @handleName upload
      *
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
-     * @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 {boolean} [fileQuery.template] - preview template identifier. Example: 1
+     * @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 }.
      *
-     * @returns Uploads a file to an Amazon S3-compatible cloud file storage
+     * @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 {boolean} [fileQuery.template] - preview template identifier. Example: 1.
+     *
+     * @return {IUploadingReturns} 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 };
@@ -48,42 +59,50 @@ class FileUploadingApi extends asyncModules_1.default {
     /**
      * Deletes a file from the cloud file storage.
      *
-     * @param {string} [filename] File name. Example "file.png"
+     * @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.
      *
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
-     * @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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Deletes a file from the cloud file storage
+     * @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.json();
+        return result;
     }
     /**
      * Get file by parameters.
      *
-     * @param {number} [id] - Object identifier, from which the file is uploaded, determines the folder name in the storage
+     * @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.
      *
-     * @param {string} [type] - Type, determines the folder name in the storage
-     * @param {string} [entity] - entity name, from which the file is uploaded, determines the folder name in the storage
-     * @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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Return file as File 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) {
-        const response = await fetch(this._getFullPath(`?id=${id}&type=${type}&entity=${entity}${filename ? `&filename=${filename}` : ''}${template ? `&template=${template}` : ''}`), {
+        const response = await fetch(this._getFullPath(`?id=${id}&type=${type}&entity=${entity}${`&filename=${filename}`}${template ? `&template=${template}` : ''}`), {
             method: 'GET',
             headers: {
                 'Content-Type': 'application/json',
                 'x-app-token': this.state.token,
             },
         });
-        return response.blob();
+        return response;
     }
 }
 exports.default = FileUploadingApi;

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

@@ -1,30 +1,74 @@
 import type { IError } from '../base/utils';
 /**
- * Represents a interface object of File Uploading Api.
+ * 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.
+ *
+ * @description This interface defines methods for uploading, deleting, and retrieving files in the CMS.
  */
 interface IFileUploading {
+    /**
+     * Uploads a file to the CMS.
+     *
+     * @param {File | Blob} data - The file or blob data to be uploaded. Example: new File(["content"], "file.png", { type: "image/png" }).
+     * @param {IUploadingQuery} [fileQuery] - Optional query parameters for the upload. Example: { type: 'page', entity: 'editor', id: 3787, width: 0, height: 0, compress: true, template: 1 }.
+     *
+     * @return {IUploadingReturns} A promise that resolves to an array of upload return values or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     upload(data: File | Blob, fileQuery?: IUploadingQuery): Promise<IUploadingReturns | IError>;
+    /**
+     * Deletes a file from the CMS.
+     *
+     * @param {string} filename - The name of the file to be deleted. Example: "file.png".
+     * @param {IUploadingQuery} [fileQuery] - Optional query parameters for the deletion. Example: { type: 'page', entity: 'editor', id: 3787, template: 1 }.
+     *
+     * @returns {any} A promise that resolves to any type or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     delete(filename: string, fileQuery?: IUploadingQuery): Promise<any | IError>;
-    getFile(id: number, type: string, entity: string, filename?: string): Promise<Blob | 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".
+     *
+     * @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.
+     */
+    getFile(id: number, type: string, entity: string, filename?: string): Promise<any | IError>;
 }
 /**
- * IFileEntity
+ * 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.
  */
 interface IFileEntity {
     file: File | string | null;
 }
 /**
- * @interface
- * @property {string} type - Type, determines the folder name in the storage.
- * @property {string} entity - Entity name from which the file is uploaded, determines the folder name in the storage.
- * @property {number} id - Identifier of the object from which the file is uploaded, determines the folder name in the storage.
- * @property {number} [width] - Width parameter.
- * @property {number} [height] - Height parameter.
- * @property {boolean} [compress] - Flag of optimization (compression) for images.
+ * 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 {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.
  */
 interface IUploadingQuery {
     type: string | null;
@@ -33,10 +77,15 @@ interface IUploadingQuery {
     [key: string]: string | number | boolean | null;
 }
 /**
- * @interface
- * @property {string} filename - Filename with relative path.
- * @property {string} downloadLink - Link for downloading the file.
- * @property {number} size - Size of the file in bytes.
+ * 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} downloadLink - Link for downloading the file. Example: "https://example.com/uploads/file.png".
+ * @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 {
     filename: string;

package/dist/forms/formsApi.d.ts

@@ -4,7 +4,12 @@ import type { IError } from '../base/utils';
 import type { IForms, IFormsEntity } from './formsInterfaces';
 /**
  * Controllers for forms objects
- * @handle /api/content/forms
+ *
+ * @class FormsApi
+ * @extends 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;
@@ -13,20 +18,30 @@ export default class FormsApi extends AsyncModules implements IForms {
     /**
      * Get all forms.
      *
-     * @param {string} [langCode] - Language code. Default "en_US"
-     * @param {number} [offset] - Parameter for pagination. Default 0
-     * @param {number} [limit] - Parameter for pagination. Default 30
+     * @handleName getAllForms
      *
-     * @returns 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.
+     *
+     * @return {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<Array<IFormsEntity> | IError>;
     /**
      * Get one form by form marker.
      *
-     * @param {string} [marker] - Marker of form.
-     * @param {string} [langCode] - Language code. Default "en_US"
+     * @handleName getFormByMarker
+     *
+     * @param {string} marker - Marker of form. Example: "contact_form".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return - Returns object of type FormEntity.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns object of type FormEntity
+     * @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

@@ -6,7 +6,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for forms objects
- * @handle /api/content/forms
+ *
+ * @class FormsApi
+ * @extends 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 {
     constructor(state) {
@@ -16,11 +21,16 @@ class FormsApi extends asyncModules_1.default {
     /**
      * Get all forms.
      *
-     * @param {string} [langCode] - Language code. Default "en_US"
-     * @param {number} [offset] - Parameter for pagination. Default 0
-     * @param {number} [limit] - Parameter for pagination. Default 30
+     * @handleName getAllForms
      *
-     * @returns 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.
+     *
+     * @return {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}`);
@@ -29,10 +39,15 @@ class FormsApi extends asyncModules_1.default {
     /**
      * Get one form by form marker.
      *
-     * @param {string} [marker] - Marker of form.
-     * @param {string} [langCode] - Language code. Default "en_US"
+     * @handleName getFormByMarker
+     *
+     * @param {string} marker - Marker of form. Example: "contact_form".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return - Returns object of type FormEntity.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns object of type FormEntity
+     * @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

@@ -1,28 +1,75 @@
+import type { IPosition } from '../admins/adminsInterfaces';
 import type { IAttributes, IError } from '../base/utils';
 /**
- * Represents an interface object of Forms Api.
+ * Interface for retrieving forms in the system.
+ *
+ * @interface IForms
  *
  * @property {function} getAllForms - Get all forms in array.
  * @property {function} getFormByMarker - Get one form by form marker.
+ *
+ * @description This interface defines methods for retrieving forms in the system.
  */
 interface IForms {
+    /**
+     * Retrieves all forms in the system.
+     *
+     * @param {string} [langCode] - The language code for localization. Default: "en_US".
+     * @param {number} [offset] - Optional offset for pagination. Default: 0.
+     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     *
+     * @return {IFormsEntity} A promise that resolves to an array of form entities or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getAllForms(langCode: string, offset?: number, limit?: number): Promise<Array<IFormsEntity> | IError>;
+    /**
+     * Retrieves a form by its marker.
+     *
+     * @param {string} marker - The marker identifying the form. Example: "contact_form".
+     * @param {string} [langCode] - The language code for localization. Default: "en_US".
+     *
+     * @return {IFormsEntity} A promise that resolves to a form entity or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getFormByMarker(marker: string, langCode: string): Promise<IFormsEntity | IError>;
 }
 /**
- * Represents an object with various properties.
- *
- * @interface
- * @property {number} id - The identifier of the object.
- * @property {number} attributeSetId - The identifier of the attribute set being used.
- * @property {string} processingType - Type of form processing.
- * @property {Record<string, any>} localizeInfos - The name of the form, taking into account localization.
- * @property {object} processingData - Form data.
- * @property {Array<IAttributes>} attribute - Array of attribute values from the used attribute set for displaying the form (taking into account the specified language)
- * @property {number} version - The version number of the object.
- * @property {string} type - Form type.
- * @property {string} identifier - The textual identifier for the record field.
- * @property {number} position - The position of the object.
+ * Represents the structure of a form page.
+ *
+ * @interface IFromPages
+ *
+ * @property {number} id - The unique identifier of the form page. Example: .
+ * @property {number} pageId - The identifier of the page. Example: .
+ * @property {number} formId - The identifier of the form. Example: .
+ * @property {number} positionId - The identifier of the position. Example: .
+ * @property {IPosition} position - The position object. Example: .
+ *
+ * @description This interface defines the structure of a form page.
+ */
+interface IFromPages {
+    id: number;
+    pageId: number;
+    formId: number;
+    positionId: number;
+    position: IPosition;
+}
+/**
+ * Represents the structure of a form entity.
+ *
+ * @interface IFormsEntity
+ *
+ * @property {number | null} attributeSetId - The identifier of the attribute set being used, or null if not applicable. Example: 1234.
+ * @property {Array<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: .
+ * @property {number} id - The identifier of the object. Example: 12345.
+ * @property {string} identifier - The textual identifier for the record field. Example: "form_contact_us".
+ * @property {Record<string, any>} localizeInfos - The name of the form, taking into account localization. Example: .
+ * @property {number | null} templateId - The identifier of the template used by the form, or null if no template is used. Example: 6789.
+ * @property {number} position - The position of the object. Example: 1.
+ * @property {string} type - Form type. Example: "contact".
+ * @property {string} processingType - Type of form processing. Example: "async".
+ * @property {number} version - The version number of the object. Example: 1.
+ *
+ * @description This interface defines the structure of a form entity, including its identifiers, attributes, and processing data.
  */
 interface IFormsEntity {
     attributeSetId: number | null;
@@ -36,4 +83,4 @@ interface IFormsEntity {
     processingType: string;
     version: number;
 }
-export type { IForms, IFormsEntity };
+export type { IForms, IFormsEntity, IFromPages };

package/dist/formsData/formsDataApi.d.ts

@@ -4,7 +4,13 @@ import type { IError } from '../base/utils';
 import type { IFormDataEntity, IFormsData, IFormsDataEntity, IFormsPost } from './formsDataInterfaces';
 /**
  * Controllers for working with form data
+ *
  * @handle /api/content/form-data
+ * @class FormsDataApi
+ * @extends AsyncModules
+ * @implements {IFormsData}
+ *
+ * @description This class provides methods to interact with form data, including retrieving all forms data, creating new form data entries, and fetching form data by marker.
  */
 export default class FormsDataApi extends AsyncModules implements IFormsData {
     protected state: StateModule;
@@ -13,53 +19,47 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
     /**
      * Get all forms data.
      *
-     * @param {string} [langCode] - Language code. Default "en_US"
-     * @param {number} [offset] - Parameter for pagination. Default 0
-     * @param {number} [limit] - Parameter for pagination. Default 30
+     * @handleName getFormsData
      *
-     * @returns Returns array for all objects of FormData
+     * @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 {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
      *
-     * @param {object} [body] - Request body.
-     * @param {string} [langCode] - Optional language field
+     * @handleName postFormsData
+     *
+     * @param {object} body - Request body. { "formIdentifier": "file", "formData": [ {"marker": "name", "type": "string", "value": "filesArray" }, { "marker": "file", "type": "file", "value": filesArray, fileQuery: { type: 'page', entity: 'editor', id: 3492, }, } ] }
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @example
-     *  const body = {
-          "formIdentifier": "file",
-          "formData": [
-            {
-              "marker": "name",
-              "type": "string",
-              "value": "filesArray",
-            },
-            {
-              "marker": "file",
-              "type": "file",
-              "value": filesArray,
-              fileQuery: {
-                type: 'page',
-                entity: 'editor',
-                id: 3492,
-              },
-            }
-          ]
-        }
+     * @return {IFormDataEntity} Returns an object containing the created form data entry 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.
      *
-     * @returns - Returns a created FormDataEntity object.
      */
     postFormsData(body: IFormsPost, langCode?: string): Promise<IFormDataEntity | IError>;
     /**
      * Get one object of form data by marker.
      *
-     * @param {string} [marker] - Marker of the form data
-     * @param {string} [langCode] - Language code. Default "en_US"
-     * @param {number} [offset] - Parameter for pagination. Default 0
-     * @param {number} [limit] - Parameter for pagination. Default 30
+     * @handleName getFormsDataByMarker
+     *
+     * @param {string} marker - Marker of the form data. Example: "contact_form_data".
+     * @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 {IFormsDataEntity} 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.
      *
-     * @returns Returns array of object FormDataEntity
+     * @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, langCode?: string, offset?: number, limit?: number): Promise<IFormsDataEntity | IError>;
 }

package/dist/formsData/formsDataApi.js

@@ -8,7 +8,13 @@ const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 const fileUploadingApi_1 = __importDefault(require("../file-uploading/fileUploadingApi"));
 /**
  * Controllers for working with form data
+ *
  * @handle /api/content/form-data
+ * @class FormsDataApi
+ * @extends AsyncModules
+ * @implements {IFormsData}
+ *
+ * @description This class provides methods to interact with form data, including retrieving all forms data, creating new form data entries, and fetching form data by marker.
  */
 class FormsDataApi extends asyncModules_1.default {
     constructor(state) {
@@ -18,11 +24,16 @@ class FormsDataApi extends asyncModules_1.default {
     /**
      * Get all forms data.
      *
-     * @param {string} [langCode] - Language code. Default "en_US"
-     * @param {number} [offset] - Parameter for pagination. Default 0
-     * @param {number} [limit] - Parameter for pagination. Default 30
+     * @handleName getFormsData
      *
-     * @returns Returns array for all objects of FormData
+     * @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 {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.
      */
     async getFormsData(langCode = this.state.lang, offset = 0, limit = 30) {
         const result = await this._fetchGet(`?langCode=${langCode}&offset=${offset}&limit=${limit}`);
@@ -31,32 +42,16 @@ class FormsDataApi extends asyncModules_1.default {
     /**
      * Creating an object of data save information by form
      *
-     * @param {object} [body] - Request body.
-     * @param {string} [langCode] - Optional language field
+     * @handleName postFormsData
      *
-     * @example
-     *  const body = {
-          "formIdentifier": "file",
-          "formData": [
-            {
-              "marker": "name",
-              "type": "string",
-              "value": "filesArray",
-            },
-            {
-              "marker": "file",
-              "type": "file",
-              "value": filesArray,
-              fileQuery: {
-                type: 'page',
-                entity: 'editor',
-                id: 3492,
-              },
-            }
-          ]
-        }
+     * @param {object} body - Request body. { "formIdentifier": "file", "formData": [ {"marker": "name", "type": "string", "value": "filesArray" }, { "marker": "file", "type": "file", "value": filesArray, fileQuery: { type: 'page', entity: 'editor', id: 3492, }, } ] }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IFormDataEntity} Returns an object containing the created form data entry 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.
      *
-     * @returns - Returns a created FormDataEntity object.
      */
     async postFormsData(body, langCode = this.state.lang) {
         const formData = {};
@@ -114,12 +109,17 @@ class FormsDataApi extends asyncModules_1.default {
     /**
      * Get one object of form data by marker.
      *
-     * @param {string} [marker] - Marker of the form data
-     * @param {string} [langCode] - Language code. Default "en_US"
-     * @param {number} [offset] - Parameter for pagination. Default 0
-     * @param {number} [limit] - Parameter for pagination. Default 30
+     * @handleName getFormsDataByMarker
+     *
+     * @param {string} marker - Marker of the form data. Example: "contact_form_data".
+     * @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 {IFormsDataEntity} 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.
      *
-     * @returns Returns array of object FormDataEntity
+     * @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 getFormsDataByMarker(marker, langCode = this.state.lang, offset = 0, limit = 30) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}&offset=${offset}&limit=${limit}`);