oneentry 1.0.123 → 1.0.125

package/dist/formsData/formsDataApi.d.ts

@@ -4,7 +4,12 @@ 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 +18,60 @@ 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
      *
-     * @example
-     *  const body = {
+     * @param {object} body - Request body. Example:
+        {
           "formIdentifier": "file",
           "formData": [
             {
               "marker": "name",
               "type": "string",
-              "value": "filesArray",
+              "value": "filesArray"
             },
             {
               "marker": "file",
               "type": "file",
               "value": filesArray,
-              fileQuery: {
-                type: 'page',
-                entity: 'editor',
-                id: 3492,
-              },
+              "fileQuery": {
+                "type": "page",
+                "entity": "editor",
+                "id": 3492,
+              }
             }
           ]
         }
-     *
-     * @returns - Returns a created FormDataEntity object.
+     * @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.
      */
     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
      *
-     * @returns Returns array of object FormDataEntity
+     * @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.
+     * @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,12 @@ 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 +23,14 @@ 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 +39,33 @@ 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 = {
+     * @param {object} body - Request body. Example:
+        {
           "formIdentifier": "file",
           "formData": [
             {
               "marker": "name",
               "type": "string",
-              "value": "filesArray",
+              "value": "filesArray"
             },
             {
               "marker": "file",
               "type": "file",
               "value": filesArray,
-              fileQuery: {
-                type: 'page',
-                entity: 'editor',
-                id: 3492,
-              },
+              "fileQuery": {
+                "type": "page",
+                "entity": "editor",
+                "id": 3492,
+              }
             }
           ]
         }
-     *
-     * @returns - Returns a created FormDataEntity object.
+     * @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.
      */
     async postFormsData(body, langCode = this.state.lang) {
         const formData = {};
@@ -114,12 +123,15 @@ 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
      *
-     * @returns Returns array of object FormDataEntity
+     * @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.
+     * @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}`);

package/dist/formsData/formsDataInterfaces.d.ts

@@ -1,26 +1,83 @@
 import type { IUploadingQuery } from 'file-uploading/fileUploadingInterfaces';
 import type { IError } from '../base/utils';
 /**
- * Represents a interface object of Forms Api.
+ * Interface for retrieving and posting form data in the system.
+ *
+ * @interface IFormsData
  *
  * @property {function} getFormsData - Get all forms data.
  * @property {function} postFormsData - Find all product page objects with pagination and multiple filtering.
  * @property {function} getFormsDataByMarker - Get one object of form data by marker.
+ * @description This interface defines methods for retrieving and posting form data in the system.
  */
 interface IFormsData {
+    /**
+     * Retrieves all forms data.
+     *
+     * @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 {IFormsDataEntity} A promise that resolves to a collection of form data entities or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getFormsData(langCode: string, offset?: number, limit?: number): Promise<IFormsDataEntity | IError>;
+    /**
+     * Posts form data to the system.
+     *
+     * @param {IFormsPost} data - The form data to be posted. Example:
+        {
+          "id": 1,
+          "formIdentifier": "string",
+          "time": "string",
+          "formData": [],
+          "fileQuery": {
+            "type": null;
+            "entity": null;
+            "id": null;
+            "key": null;
+          }
+        }
+     * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
+     * @return {IFormDataEntity} A promise that resolves to a form data entity or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     postFormsData(data: IFormsPost, langCode?: string): Promise<IFormDataEntity | IError>;
+    /**
+     * Retrieves form data by its marker.
+     *
+     * @param {string} marker - The marker identifying the form data. Example: "contact_form_data".
+     * @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.
+     * @returns {IFormsDataEntity} A promise that resolves to a form data entity or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getFormsDataByMarker(marker: string, langCode: string, offset?: number, limit?: number): Promise<IFormsDataEntity | IError>;
 }
 /**
- * Represents a form data.
- *
- * @interface
- * @property {number} id - The unique identifier of the form page.
- * @property {string} formIdentifier - The identifier of the page.
- * @property {Date | string} time - The identifier of the form.
- * @property {IFormsPost} formData - The identifier of the position.
- * @property {string} attributeSetIdentifier - Text identifier (marker) of the used attribute set.
+ * Represents the structure of a form data entity.
+ *
+ * @interface IFormDataEntity
+ *
+ * @property {number} id - The unique identifier of the form page. Example: 12345.
+ * @property {string} formIdentifier - The identifier of the page. Example: "contact_form".
+ * @property {Date | string} time - The identifier of the form. Example: "2023-10-01T12:00:00Z".
+ * @property {IFormsPost} formData - The identifier of the position. Example:
+    {
+      "id": 1,
+      "formIdentifier": "string",
+      "time": "string",
+      "formData": [],
+      "fileQuery": {
+        "type": null;
+        "entity": null;
+        "id": null;
+        "key": null;
+      }
+    }
+ * @property {string} [attributeSetIdentifier] - Text identifier (marker) of the used attribute set. Example: "product_attributes".
+ * @property {string} [actionMessage] - Action message for the form data. Example: "Form submitted successfully".
+ * @description This interface defines the structure of a form data entity, including its identifiers, form data, and optional attributes.
  */
 interface IFormDataEntity {
     id: number;
@@ -31,39 +88,73 @@ interface IFormDataEntity {
     actionMessage?: string;
 }
 /**
- * Represents a form data.
+ * Represents a collection of form data entities.
  *
- * @interface
- * @property {number} total - Total number of found records.
- * @property {Array<IFormDataEntity>} items
+ * @interface IFormsDataEntity
+ *
+ * @property {number} total - Total number of found records. Example: 100.
+ * @property {IFormDataEntity[]} items - Array of form data objects. Example:
+    [
+      {
+        "id": 1,
+        "formIdentifier": "string",
+        "time": "string",
+        "formData": "IFormsPost",
+        "attributeSetIdentifier": "string",
+        "actionMessage": "string"
+      }
+    ]
+ * @description This interface defines the structure of a collection of form data entities, including a total count and an array of items.
  */
 interface IFormsDataEntity {
     total: number;
-    items: Array<IFormDataEntity>;
+    items: IFormDataEntity[];
 }
 /**
  * Contains an array of data form objects with the following values
  */
 type FormDataType = IBodyTypeStringNumberFloat | IBodyTypeTimeDate | IBodyTypeText | IBodyTypeTextWithHeader | IBodyTypeImageGroupOfImages | IBodyTypeFile | IBodyTypeRadioButtonList | Record<string, any>;
 /**
- * interface to create an object of information about saving data using the form
+ * Represents the structure of a form post object.
+ *
+ * @interface IFormsPost
  *
- * @property {number} id
- * @property {string} formIdentifier - The identifier of the page.
- * @property {Date | string} time - Date and time of form modification
- * @property {Array<FormDataType>} formData - The identifier of the page.
+ * @property {number} [id] - Optional identifier of the form post. Example: 1.
+ * @property {string} formIdentifier - The identifier of the page. Example: "string".
+ * @property {Date | string} [time] - Date and time of form modification. Example: "string".
+ * @property {FormDataType[]} formData - The form data object. Example:
+    [
+      {
+        "marker": "string",
+        "type": "string",
+        "value": "string"
+      }
+    ]
+ * @property {IUploadingQuery} [fileQuery] - Optional file query for uploading files. Example:
+    {
+      "type": null,
+      "entity": null,
+      "id": null,
+      "key": null,
+    }
+ * @description This interface defines the structure of a form post object, including its identifiers, time, form data, and optional file query.
  */
 interface IFormsPost {
     id?: number;
     formIdentifier: string;
     time?: Date | string;
-    formData: Array<FormDataType>;
+    formData: FormDataType[];
     fileQuery?: IUploadingQuery;
 }
 /**
- * @property {string} marker - marker name
- * @property {'string' | 'number' | 'float'} type - Type value
- * @property {string} value
+ * Represents a form data entity with a simple value.
+ *
+ * @interface IBodyTypeStringNumberFloat
+ *
+ * @property {string} marker - marker name. Example: "some_marker".
+ * @property {string} type - Type value. "string" | "number" | "float". Example: "string".
+ * @property {string} value - Value of the form data entity, which can be a "string", "number", or "float". Example: "string".
+ * @description Represents a form data entity with a marker, type, and value.
  */
 interface IBodyTypeStringNumberFloat {
     marker: string;
@@ -71,9 +162,19 @@ interface IBodyTypeStringNumberFloat {
     value: string;
 }
 /**
- * @property {string} marker - marker name
- * @property {'date' | 'dateTime' | 'time'} type - Type value
- * @property {object} value - Date object. Contains fullDate, formattedValue, formatString
+ * Represents a date/time form data entity.
+ *
+ * @interface IBodyTypeTimeDate
+ *
+ * @property {string} marker - marker name. Example: "ome_marker".
+ * @property {string} type - Type value. 'date' | 'dateTime' | 'time' Example: "date".
+ * @property {object} value - Date object. Contains fullDate, formattedValue, formatString. Example:
+    {
+      "fullDate": "2024-05-07T21:02:00.000Z",
+      "formattedValue": "08-05-2024 00:02",
+      "formatString": "DD-MM-YYYY HH:mm"
+    }
+ * @description Represents a date, dateTime, or time value in a structured format.
  */
 interface IBodyTypeTimeDate {
     marker: string;
@@ -85,9 +186,22 @@ interface IBodyTypeTimeDate {
     };
 }
 /**
- * @property {string} marker - marker name
- * @property {'text'} type - Type value
- * @property {object} value - Text Object. Contains html as string and params
+ * Represents a text form data entity.
+ *
+ * @interface IBodyTypeText
+ *
+ * @property {string} marker - marker name. Example: "some_marker".
+ * @property {string} type - Type value. Example: "text".
+ * @property {object} value - Text Object. Contains html as string, plain text and params. Example:
+    {
+      "htmlValue": "<p>Hello world</p>",
+      "plainValue": "",
+      "params": {
+        "isEditorDisabled": false,
+        "isImageCompressed": true
+      }
+    }
+ * @description Represents a text value with HTML and plain text representations, along with parameters for editor and image compression settings.
  */
 interface IBodyTypeText {
     marker: string;
@@ -102,9 +216,23 @@ interface IBodyTypeText {
     };
 }
 /**
- * @property {string} marker - marker name
- * @property {'textWithHeader'} type - Type value
- * @property {object} value - Text Object. Contains html as string, header and params
+ * Represents a text with header form data entity.
+ *
+ * @interface IBodyTypeTextWithHeader
+ *
+ * @property {string} marker - marker name. Example: "about".
+ * @property {string} type - Type value. Example: "textWithHeader".
+ * @property {object} value - Text Object. Contains html as string, header and params. Example:
+    {
+      "header": "Headline",
+      "htmlValue": "<p>Hello World</p>",
+      "plainValue": "",
+      "params": {
+        "isEditorDisabled": false,
+        "isImageCompressed": true
+      }
+    }
+ * @description Represents a text value with a header, HTML and plain text representations, along with parameters for editor and image compression settings.
  */
 interface IBodyTypeTextWithHeader {
     marker: string;
@@ -120,9 +248,25 @@ interface IBodyTypeTextWithHeader {
     };
 }
 /**
- * @property {string} marker - marker name
- * @property {'image' | 'groupOfImage'} type - Type value
- * @property {object} value - Image Object. Contains image information
+ * Represents an image or group of images form data entity.
+ *
+ * @interface IBodyTypeImageGroupOfImages
+ *
+ * @property {string} marker - marker name. Example: "avatar".
+ * @property {'image' | 'groupOfImage'} type - Type value. Example: "image".
+ * @property {object} value - Image Object. Contains image information. Example:
+    [
+      {
+        "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
+        "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
+        "size": 392585,
+        "previewLink": "",
+        "params": {
+          "isImageCompressed": true
+        }
+      }
+    ]
+ * @description Represents an image or a group of images with their details, including filename, download link, size, preview link, and parameters for image compression.
  */
 interface IBodyTypeImageGroupOfImages {
     marker: string;
@@ -146,9 +290,21 @@ interface IBodyTypeImageGroupOfImages {
     }>;
 }
 /**
- * @property {string} marker - marker name
- * @property {'file'} type - Type value
- * @property {object} value - File Object. Contains file information
+ * Represents a file form data entity.
+ *
+ * @interface IBodyTypeFile
+ *
+ * @property {string} marker - marker name. Example: "picture".
+ * @property {'file'} type - Type value. Example: "file".
+ * @property {object} value - File Object. Contains file information. Example:
+    [
+      {
+        "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
+        "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
+        "size": 392585
+      }
+    ]
+ * @description Represents a file with its details, including filename, download link, and size.
  */
 interface IBodyTypeFile {
     marker: string;
@@ -160,9 +316,24 @@ interface IBodyTypeFile {
     };
 }
 /**
- * @property {string} marker - marker name
- * @property {'file'} type - Type value
- * @property {array} value - Array of list or radioButton bojects.
+ * Represents a radio button or list selection form data entity.
+ *
+ * @interface IBodyTypeRadioButtonList
+ *
+ * @property {string} marker - marker name. Example: "selector".
+ * @property {string} type - Type value. Example: 'list'.
+ * @property {array} value - Array of list or radioButton bojects. Example:
+    [
+      {
+        "title": "red",
+        "value": "1",
+        "extended": {
+          "value": "red",
+          "type": "string"
+        }
+      }
+    ]
+ * @description Represents a list or radio button selection with multiple options, each containing a title, value, and extended information.
  */
 interface IBodyTypeRadioButtonList {
     marker: string;

package/dist/general-types/generalTypesApi.d.ts

@@ -4,7 +4,12 @@ import type { IError } from '../base/utils';
 import type { IGeneralTypes, IGeneralTypesEntity } from './generalTypesInterfaces';
 /**
  * Controllers for working with types
+ *
  * @handle /api/content/general-types
+ * @class GeneralTypesApi
+ * @extends AsyncModules
+ * @implements {IGeneralTypes}
+ * @description This class provides methods to interact with general types, including retrieving all types.
  */
 export default class GeneralTypesApi extends AsyncModules implements IGeneralTypes {
     protected state: StateModule;
@@ -13,7 +18,11 @@ export default class GeneralTypesApi extends AsyncModules implements IGeneralTyp
     /**
      * Get all types.
      *
-     * @returns Returns all objects of type GeneralTypeEntity
+     * @handleName getAllTypes
+     *
+     * @return {IGeneralTypesEntity[]} Returns an array of general types 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 retrieves all general types available in the system.
      */
-    getAllTypes(): Promise<Array<IGeneralTypesEntity> | IError>;
+    getAllTypes(): Promise<IGeneralTypesEntity[] | IError>;
 }

package/dist/general-types/generalTypesApi.js

@@ -6,7 +6,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with types
+ *
  * @handle /api/content/general-types
+ * @class GeneralTypesApi
+ * @extends AsyncModules
+ * @implements {IGeneralTypes}
+ * @description This class provides methods to interact with general types, including retrieving all types.
  */
 class GeneralTypesApi extends asyncModules_1.default {
     constructor(state) {
@@ -16,7 +21,11 @@ class GeneralTypesApi extends asyncModules_1.default {
     /**
      * Get all types.
      *
-     * @returns Returns all objects of type GeneralTypeEntity
+     * @handleName getAllTypes
+     *
+     * @return {IGeneralTypesEntity[]} Returns an array of general types 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 retrieves all general types available in the system.
      */
     async getAllTypes() {
         const result = await this._fetchGet('');

package/dist/general-types/generalTypesInterfaces.d.ts

@@ -1,19 +1,30 @@
 import type { BlockType } from 'blocks/blocksInterfaces';
 import type { IError } from '../base/utils';
 /**
- * Represents an interface object of General Type Api.
+ * Interface for retrieving all general types in the system.
+ *
+ * @interface IGeneralTypes
  *
  * @property {function} getAllTypes - Get all types.
+ * @description This interface defines a method for retrieving all general types in the system.
  */
 interface IGeneralTypes {
-    getAllTypes(): Promise<Array<IGeneralTypesEntity> | IError>;
+    /**
+     * Get all types.
+     *
+     * @return {IGeneralTypesEntity[]} Returns an array of general types 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.
+     */
+    getAllTypes(): Promise<IGeneralTypesEntity[] | IError>;
 }
 /**
- * Represents a general types object.
+ * Represents a general type entity.
+ *
+ * @interface IGeneralTypesEntity
  *
- * @interface
- * @property {number} id - Type id.
- * @property {Types} type - Types enum.
+ * @property {number} id - Type id. Example: 1.
+ * @property {Types} type - Types enum. Example: "product", "category", "etc".
+ * @description Represents a general type entity with an identifier and a type.
  */
 interface IGeneralTypesEntity {
     id: number;

package/dist/index.d.ts

@@ -9,7 +9,7 @@ import BlocksApi from './blocks/blocksApi';
 import EventsApi from './events/eventsApi';
 import FileUploadingApi from './file-uploading/fileUploadingApi';
 import FormsApi from './forms/formsApi';
-import FormsDataApi from './formsData/formsDataApi';
+import FormsDataApi from './forms-data/formsDataApi';
 import GeneralTypesApi from './general-types/generalTypesApi';
 import IntegrationCollectionsApi from './integration-collections/integrationCollectionsApi';
 import LocalesApi from './locales/localesApi';
@@ -66,7 +66,7 @@ interface IDefineApi {
  * @param {string} [config.auth.refreshToken] - Transfer the refresh token here, for example from the local storage, to resume the user's session. Otherwise, the user will need to log in every time a new session is created.
  * @param {string} [config.auth.saveFunction] - If you want to store the token between sessions, for example in local storage, create a custom function that takes refreshToken as a parameter and executes the necessary instructions. This function will be called every time the tokens are updated.
  *
- * @returns {IDefineApi} - List of methods set.
+ * @return List of methods set.
  */
 export declare function defineOneEntry(url: string, config: IConfig): IDefineApi;
 export {};

package/dist/index.js

@@ -15,7 +15,7 @@ const blocksApi_1 = __importDefault(require("./blocks/blocksApi"));
 const eventsApi_1 = __importDefault(require("./events/eventsApi"));
 const fileUploadingApi_1 = __importDefault(require("./file-uploading/fileUploadingApi"));
 const formsApi_1 = __importDefault(require("./forms/formsApi"));
-const formsDataApi_1 = __importDefault(require("./formsData/formsDataApi"));
+const formsDataApi_1 = __importDefault(require("./forms-data/formsDataApi"));
 const generalTypesApi_1 = __importDefault(require("./general-types/generalTypesApi"));
 const integrationCollectionsApi_1 = __importDefault(require("./integration-collections/integrationCollectionsApi"));
 const localesApi_1 = __importDefault(require("./locales/localesApi"));
@@ -44,7 +44,7 @@ const wsApi_1 = __importDefault(require("./web-socket/wsApi"));
  * @param {string} [config.auth.refreshToken] - Transfer the refresh token here, for example from the local storage, to resume the user's session. Otherwise, the user will need to log in every time a new session is created.
  * @param {string} [config.auth.saveFunction] - If you want to store the token between sessions, for example in local storage, create a custom function that takes refreshToken as a parameter and executes the necessary instructions. This function will be called every time the tokens are updated.
  *
- * @returns {IDefineApi} - List of methods set.
+ * @return List of methods set.
  */
 function defineOneEntry(url, config) {
     const stateModule = new stateModule_1.default(url.endsWith('/') ? url.slice(0, -1) : url, config);