oneentry 1.0.137 → 1.0.138

package/dist/forms/formsApi.d.ts

@@ -26,8 +26,8 @@ export default class FormsApi extends AsyncModules implements IForms {
      * @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.
+     * @returns {Promise<IFormsEntity[] | IError>} Returns array for all objects of type FormEntity.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      */
     getAllForms(langCode?: string, offset?: number, limit?: number): Promise<IFormsEntity[] | IError>;
     /**
@@ -35,8 +35,8 @@ export default class FormsApi extends AsyncModules implements IForms {
      * @handleName getFormByMarker
      * @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.
+     * @returns {Promise<IFormsEntity | IError>} Returns object of type FormEntity.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      */
     getFormByMarker(marker: string, langCode?: string): Promise<IFormsEntity | IError>;
 }

package/dist/forms/formsApi.js

@@ -30,8 +30,8 @@ class FormsApi extends asyncModules_1.default {
      * @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.
+     * @returns {Promise<IFormsEntity[] | IError>} Returns array for all objects of type FormEntity.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      */
     async getAllForms(langCode = this.state.lang, offset = 0, limit = 30) {
         const result = await this._fetchGet(`?langCode=${langCode}&offset=${offset}&limit=${limit}`);
@@ -44,8 +44,8 @@ class FormsApi extends asyncModules_1.default {
      * @handleName getFormByMarker
      * @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.
+     * @returns {Promise<IFormsEntity | IError>} Returns object of type FormEntity.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      */
     async getFormByMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);

package/dist/forms/formsInterfaces.d.ts

@@ -77,6 +77,7 @@ interface IFromPages {
     {
       "key": "value"
     }
+ * @property {Array<IFormConfig>} [moduleFormConfigs] - Module form configurations linked to the form.
  * @description This interface defines the structure of a form entity, including its identifiers, attributes, and processing data.
  */
 interface IFormsEntity {

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

@@ -54,8 +54,8 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      * @param {string} body.formData[].type - The type of the form field. Example: "string".
      * @param {string} body.formData[].value - The value of the form field. Example: "Jack".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IPostFormResponse} Returns an object containing the created form data entry and message.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IPostFormResponse | IError>} Returns an object containing the created form data entry and message.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      */
     postFormsData(body: IBodyPostFormData, langCode?: string): Promise<IPostFormResponse | IError>;
     /**
@@ -77,30 +77,30 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      * @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 {IFormsByMarkerDataEntity} Returns an object containing the form data or an error object if there was an issue.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IFormsByMarkerDataEntity | IError>} Returns an object containing the form data or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      */
     getFormsDataByMarker(marker: string, formModuleConfigId: number, body?: object, isExtended?: number, langCode?: string, offset?: number, limit?: number): Promise<IFormsByMarkerDataEntity | IError>;
     /**
-     * Update one object of form data by id.
+     * Update one object of form data by id. Requires user authentication.
      * @handleName updateFormsDataByid
      * @param {number} id - ID of the form data. Example: 1.
-     * @returns {IUpdateFormsData | IError} Returns an object containing the updated form data or an error object if there was an issue.
+     * @returns {Promise<IUpdateFormsData | IError>} Returns an object containing the updated form data or an error object if there was an issue.
      */
     updateFormsDataByid(id: number, body?: object): Promise<IUpdateFormsData | IError>;
     /**
-     * Update form data status by id.
+     * Update form data status by id. Requires user authentication.
      * @handleName updateFormsDataStatusByid
      * @param {number} id - ID of the form data. Example: 1.
      * @param {object} body - Request body.
-     * @returns {boolean | IError} Returns an object containing the updated form data or an error object if there was an issue.
+     * @returns {Promise<boolean | IError>} Returns an object containing the updated form data or an error object if there was an issue.
      */
     updateFormsDataStatusByid(id: number, body?: object): Promise<boolean | IError>;
     /**
-     * Delete one object of form data by id.
+     * Delete one object of form data by id. Requires user authentication.
      * @handleName deleteFormsDataByid
      * @param {number} id - ID of the form data. Example: 1.
-     * @returns {boolean | IError} Returns an object containing the deleted form data or an error object if there was an issue.
+     * @returns {Promise<boolean | IError>} Returns an object containing the deleted form data or an error object if there was an issue.
      */
     deleteFormsDataByid(id: number): Promise<boolean | IError>;
 }

package/dist/forms-data/formsDataApi.js

@@ -60,8 +60,8 @@ class FormsDataApi extends asyncModules_1.default {
      * @param {string} body.formData[].type - The type of the form field. Example: "string".
      * @param {string} body.formData[].value - The value of the form field. Example: "Jack".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IPostFormResponse} Returns an object containing the created form data entry and message.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IPostFormResponse | IError>} Returns an object containing the created form data entry and message.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      */
     async postFormsData(body, langCode = this.state.lang) {
         const formData = {};
@@ -143,8 +143,8 @@ class FormsDataApi extends asyncModules_1.default {
      * @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 {IFormsByMarkerDataEntity} Returns an object containing the form data or an error object if there was an issue.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IFormsByMarkerDataEntity | IError>} Returns an object containing the form data or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      */
     async getFormsDataByMarker(marker, formModuleConfigId, body = {}, isExtended = 0, langCode = this.state.lang, offset = 0, limit = 30) {
         const result = await this._fetchPost(`/marker/${marker}?formModuleConfigId=${formModuleConfigId}&isExtended=${isExtended}&langCode=${langCode}&offset=${offset}&limit=${limit}`, body);
@@ -153,10 +153,10 @@ class FormsDataApi extends asyncModules_1.default {
         return this._dataPostProcess(validated, langCode);
     }
     /**
-     * Update one object of form data by id.
+     * Update one object of form data by id. Requires user authentication.
      * @handleName updateFormsDataByid
      * @param {number} id - ID of the form data. Example: 1.
-     * @returns {IUpdateFormsData | IError} Returns an object containing the updated form data or an error object if there was an issue.
+     * @returns {Promise<IUpdateFormsData | IError>} Returns an object containing the updated form data or an error object if there was an issue.
      */
     async updateFormsDataByid(id, body = {}) {
         const result = await this._fetchPut(`/${id}`, body);
@@ -165,21 +165,21 @@ class FormsDataApi extends asyncModules_1.default {
         return validated;
     }
     /**
-     * Update form data status by id.
+     * Update form data status by id. Requires user authentication.
      * @handleName updateFormsDataStatusByid
      * @param {number} id - ID of the form data. Example: 1.
      * @param {object} body - Request body.
-     * @returns {boolean | IError} Returns an object containing the updated form data or an error object if there was an issue.
+     * @returns {Promise<boolean | IError>} Returns an object containing the updated form data or an error object if there was an issue.
      */
     async updateFormsDataStatusByid(id, body = {}) {
         const result = await this._fetchPut(`/${id}/update-status`, body);
         return result;
     }
     /**
-     * Delete one object of form data by id.
+     * Delete one object of form data by id. Requires user authentication.
      * @handleName deleteFormsDataByid
      * @param {number} id - ID of the form data. Example: 1.
-     * @returns {boolean | IError} Returns an object containing the deleted form data or an error object if there was an issue.
+     * @returns {Promise<boolean | IError>} Returns an object containing the deleted form data or an error object if there was an issue.
      */
     async deleteFormsDataByid(id) {
         const result = await this._fetchDelete(`/${id}`);

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

@@ -64,7 +64,7 @@ interface IFormsData {
           "dateFrom": "2025-08-11",
           "dateTo": ""
         }
-     * @param {any} [isNested] - Flag for getting hierarchical data. Example: 1.
+     * @param {number} [isNested] - Flag for getting hierarchical data. Example: 1.
      * @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.
@@ -90,7 +90,7 @@ interface IFormsData {
       }
     ]
  * @property {string | null} [attributeSetIdentifier] - Text identifier (marker) of the used attribute set. Example: "product_attributes".
- * @property {string | null} [actionMessage] - Action message for the form data. Example: "Form submitted successfully".
+ * @property {string} [moduleIdentifier] - Module identifier. Example: "blog".
  * @description This interface defines the structure of a form data entity, including its identifiers, form data, and optional attributes.
  */
 interface IFormDataEntity {
@@ -148,27 +148,27 @@ interface IFormsDataEntity {
  * @property {string} entityIdentifier - Text identifier (marker) of the entity. Example: "test".
  * @property {boolean} isUserAdmin - Is user admin. Example: true.
  * @property {number} formModuleConfigId - Form module config Id. Example: 2.
- * @property {number} moduleIdentifier - Form module config Id. Example: 2.
+ * @property {string} [moduleIdentifier] - Module identifier. Example: "blog".
  * @property {number} entityId - Form module config Id. Example: 2.
  * @description This interface defines the structure of a form data entity, including its identifiers, form data, and optional attributes.
  */
 interface IFormByMarkerDataEntity {
     id: number;
-    parentId: null | number;
+    parentId?: null | number;
     formIdentifier: string;
-    depth: number;
-    ip: string | null;
-    fingerprint: string | null;
-    status: string | null;
-    userIdentifier: string | null;
+    depth?: number;
+    ip?: string | null;
+    fingerprint?: string | null;
+    status?: string | null;
+    userIdentifier?: string | null;
     formData: FormDataType[];
-    attributeSetIdentifier: string | null;
+    attributeSetIdentifier?: string | null;
     time: Date | string;
-    entityIdentifier: string;
-    isUserAdmin: boolean;
-    formModuleConfigId: number;
-    moduleIdentifier: string;
-    entityId: number;
+    entityIdentifier?: string;
+    isUserAdmin?: boolean;
+    formModuleConfigId?: number;
+    moduleIdentifier?: string;
+    entityId?: number;
 }
 /**
  * Represents a collection of form data entities.
@@ -233,8 +233,8 @@ interface IFormsByMarkerDataEntity {
  * @property {string} formData.entityIdentifier - The entity identifier. Example: "blog".
  * @property {boolean} formData.isUserAdmin - Is user admin. Example: false.
  * @property {number} formData.formModuleId - The form module identifier. Example: 2.
- * @property {any} formData.parentId - The parent identifier. Example: null.
- * @property {any} formData.userIdentifier - The user identifier. Example: null.
+ * @property {string | null} formData.userIdentifier - The user identifier. Example: null.
+ * @property {number | null} formData.parentId - The parent identifier. Example: null.
  * @property {FormDataType[]} formData.formData - Form fields data.
  * @example
     [
@@ -256,8 +256,8 @@ interface IPostFormResponse {
         fingerprint: string;
         isUserAdmin: boolean;
         formModuleId: number;
-        userIdentifier: any;
-        parentId: any;
+        userIdentifier: string | null;
+        parentId: number | null;
         formData: FormDataType[];
     };
 }
@@ -270,8 +270,8 @@ interface IPostFormResponse {
  * @property {FormDataType[]} formData - Form fields data.
  * @property {string} userIdentifier - The user identifier. Example: null.
  * @property {string} entityIdentifier - The entity identifier. Example: "blog".
- * @property {any} parentId - The parent identifier. Example: null.
- * @property {string} fingerprint - The fingerprint of the form. Example: null.
+ * @property {null | number} parentId - The parent identifier. Example: null.
+ * @property {null | string} fingerprint - The fingerprint of the form. Example: null.
  * @property {boolean} isUserAdmin - Is user admin. Example: false.
  * @property {number} formModuleId - The form module identifier. Example: 2.
  */
@@ -308,9 +308,9 @@ type FormDataType = IBodyTypeStringNumberFloat | IBodyTypeTimeDate | IBodyTypeTe
         "value": "Jack"
       }
     ]
- * @property {string} formData[index].marker - The marker identifying the form field. Example: "name".
- * @property {string} formData[index].type - The type of the form field. Example: "string".
- * @property {string} formData[index].value - The value of the form field. Example: "name".
+ * @property {string} formData[].marker - The marker identifying the form field. Example: "name".
+ * @property {string} formData[].type - The type of the form field. Example: "string".
+ * @property {string} formData[].value - The value of the form field. Example: "name".
  * @property {IUploadingQuery} [fileQuery] - Optional file query for uploading files.
  * @example
     {

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

@@ -16,25 +16,29 @@ export declare const FormDataTypeSchema: z.ZodUnion<readonly [z.ZodObject<{
  */
 export declare const FormByMarkerDataEntitySchema: z.ZodObject<{
     id: z.ZodNumber;
-    parentId: z.ZodNullable<z.ZodNumber>;
+    parentId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     formIdentifier: z.ZodString;
-    depth: z.ZodNumber;
-    ip: z.ZodNullable<z.ZodString>;
-    fingerprint: z.ZodNullable<z.ZodString>;
-    status: z.ZodNullable<z.ZodString>;
-    userIdentifier: z.ZodNullable<z.ZodString>;
-    formData: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+    depth: z.ZodOptional<z.ZodNumber>;
+    ip: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    fingerprint: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    userIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    formData: z.ZodUnion<readonly [z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
         marker: z.ZodString;
         type: z.ZodString;
         value: z.ZodAny;
-    }, z.core.$strip>, z.ZodRecord<z.ZodString, z.ZodAny>]>>;
-    attributeSetIdentifier: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>, z.ZodRecord<z.ZodString, z.ZodAny>]>>, z.ZodRecord<z.ZodString, z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+        marker: z.ZodString;
+        type: z.ZodString;
+        value: z.ZodAny;
+    }, z.core.$strip>, z.ZodRecord<z.ZodString, z.ZodAny>]>>>]>;
+    attributeSetIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     time: z.ZodUnion<readonly [z.ZodDate, z.ZodString]>;
-    entityIdentifier: z.ZodString;
-    isUserAdmin: z.ZodBoolean;
-    formModuleConfigId: z.ZodNumber;
-    moduleIdentifier: z.ZodString;
-    entityId: z.ZodNumber;
+    entityIdentifier: z.ZodOptional<z.ZodString>;
+    isUserAdmin: z.ZodOptional<z.ZodBoolean>;
+    formModuleConfigId: z.ZodOptional<z.ZodNumber>;
+    moduleIdentifier: z.ZodOptional<z.ZodString>;
+    entityId: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 /**
  * Forms by marker data response schema
@@ -42,25 +46,29 @@ export declare const FormByMarkerDataEntitySchema: z.ZodObject<{
 export declare const FormsByMarkerDataResponseSchema: z.ZodObject<{
     items: z.ZodArray<z.ZodObject<{
         id: z.ZodNumber;
-        parentId: z.ZodNullable<z.ZodNumber>;
+        parentId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
         formIdentifier: z.ZodString;
-        depth: z.ZodNumber;
-        ip: z.ZodNullable<z.ZodString>;
-        fingerprint: z.ZodNullable<z.ZodString>;
-        status: z.ZodNullable<z.ZodString>;
-        userIdentifier: z.ZodNullable<z.ZodString>;
-        formData: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+        depth: z.ZodOptional<z.ZodNumber>;
+        ip: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fingerprint: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        userIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        formData: z.ZodUnion<readonly [z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
             marker: z.ZodString;
             type: z.ZodString;
             value: z.ZodAny;
-        }, z.core.$strip>, z.ZodRecord<z.ZodString, z.ZodAny>]>>;
-        attributeSetIdentifier: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>, z.ZodRecord<z.ZodString, z.ZodAny>]>>, z.ZodRecord<z.ZodString, z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+            marker: z.ZodString;
+            type: z.ZodString;
+            value: z.ZodAny;
+        }, z.core.$strip>, z.ZodRecord<z.ZodString, z.ZodAny>]>>>]>;
+        attributeSetIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         time: z.ZodUnion<readonly [z.ZodDate, z.ZodString]>;
-        entityIdentifier: z.ZodString;
-        isUserAdmin: z.ZodBoolean;
-        formModuleConfigId: z.ZodNumber;
-        moduleIdentifier: z.ZodString;
-        entityId: z.ZodNumber;
+        entityIdentifier: z.ZodOptional<z.ZodString>;
+        isUserAdmin: z.ZodOptional<z.ZodBoolean>;
+        formModuleConfigId: z.ZodOptional<z.ZodNumber>;
+        moduleIdentifier: z.ZodOptional<z.ZodString>;
+        entityId: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strip>>;
     total: z.ZodNumber;
 }, z.core.$strip>;

package/dist/forms-data/formsDataSchemas.js

@@ -22,21 +22,24 @@ exports.FormDataTypeSchema = zod_1.z.union([
  */
 exports.FormByMarkerDataEntitySchema = zod_1.z.object({
     id: zod_1.z.number(),
-    parentId: zod_1.z.number().nullable(),
+    parentId: zod_1.z.number().nullish(),
     formIdentifier: zod_1.z.string(),
-    depth: zod_1.z.number(),
-    ip: zod_1.z.string().nullable(),
-    fingerprint: zod_1.z.string().nullable(),
-    status: zod_1.z.string().nullable(),
-    userIdentifier: zod_1.z.string().nullable(),
-    formData: zod_1.z.array(exports.FormDataTypeSchema),
-    attributeSetIdentifier: zod_1.z.string().nullable(),
+    depth: zod_1.z.number().optional(),
+    ip: zod_1.z.string().nullish(),
+    fingerprint: zod_1.z.string().nullish(),
+    status: zod_1.z.string().nullish(),
+    userIdentifier: zod_1.z.string().nullish(),
+    formData: zod_1.z.union([
+        zod_1.z.array(exports.FormDataTypeSchema),
+        zod_1.z.record(zod_1.z.string(), zod_1.z.array(exports.FormDataTypeSchema)),
+    ]),
+    attributeSetIdentifier: zod_1.z.string().nullish(),
     time: zod_1.z.union([zod_1.z.date(), zod_1.z.string()]),
-    entityIdentifier: zod_1.z.string(),
-    isUserAdmin: zod_1.z.boolean(),
-    formModuleConfigId: zod_1.z.number(),
-    moduleIdentifier: zod_1.z.string(),
-    entityId: zod_1.z.number(),
+    entityIdentifier: zod_1.z.string().optional(),
+    isUserAdmin: zod_1.z.boolean().optional(),
+    formModuleConfigId: zod_1.z.number().optional(),
+    moduleIdentifier: zod_1.z.string().optional(),
+    entityId: zod_1.z.number().optional(),
 });
 /**
  * Forms by marker data response schema

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

@@ -20,8 +20,8 @@ export default class GeneralTypesApi extends AsyncModules implements IGeneralTyp
     /**
      * Get all types.
      * @handleName getAllTypes
-     * @returns {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.
+     * @returns {Promise<IGeneralTypesEntity[] | IError>} Returns an array of general types or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method retrieves all general types available in the system.
      */
     getAllTypes(): Promise<IGeneralTypesEntity[] | IError>;

package/dist/general-types/generalTypesApi.js

@@ -24,8 +24,8 @@ class GeneralTypesApi extends asyncModules_1.default {
     /**
      * Get all types.
      * @handleName getAllTypes
-     * @returns {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.
+     * @returns {Promise<IGeneralTypesEntity[] | IError>} Returns an array of general types or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method retrieves all general types available in the system.
      */
     async getAllTypes() {

package/dist/index.d.ts

@@ -26,7 +26,29 @@ import UsersApi from './users/usersApi';
 import WsApi from './web-socket/wsApi';
 /**
  * IDefineApi interface
- * @interface
+ * @interface IDefineApi
+ * @property {AdminsApi} Admins - Admins API module.
+ * @property {AttributesSetsApi} AttributesSets - Attribute sets API module.
+ * @property {AuthProviderApi} AuthProvider - Auth provider API module.
+ * @property {BlocksApi} Blocks - Blocks API module.
+ * @property {EventsApi} Events - Events API module.
+ * @property {FileUploadingApi} FileUploading - File uploading API module.
+ * @property {FormsApi} Forms - Forms API module.
+ * @property {FormsDataApi} FormData - Form data API module.
+ * @property {GeneralTypesApi} GeneralTypes - General types API module.
+ * @property {IntegrationCollectionsApi} IntegrationCollections - Integration collections API module.
+ * @property {LocalesApi} Locales - Locales API module.
+ * @property {MenusApi} Menus - Menus API module.
+ * @property {OrdersApi} Orders - Orders API module.
+ * @property {PageApi} Pages - Pages API module.
+ * @property {PaymentsApi} Payments - Payments API module.
+ * @property {ProductApi} Products - Products API module.
+ * @property {ProductStatusesApi} ProductStatuses - Product statuses API module.
+ * @property {SystemApi} System - System API module.
+ * @property {TemplatesApi} Templates - Templates API module.
+ * @property {TemplatePreviewsApi} TemplatePreviews - Template previews API module.
+ * @property {UsersApi} Users - Users API module.
+ * @property {WsApi} WS - WebSocket API module.
  */
 interface IDefineApi {
     Admins: AdminsApi;

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

@@ -34,7 +34,7 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
      * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
      * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
-     * @returns {ICollectionEntity[]} Returns an array of ICollection objects or an error object if there was an issue.
+     * @returns {Promise<ICollectionEntity[] | IError>} Returns an array of ICollection objects or an error object if there was an issue.
      */
     getICollections(langCode?: string, userQuery?: {
         limit: number;
@@ -47,8 +47,8 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * @handleName getICollectionById
      * @param {number} id - Collection id. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {ICollectionEntity} Returns an ICollection object 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 {Promise<ICollectionEntity | IError>} Returns an ICollection object or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      */
     getICollectionById(id: number, langCode?: string): Promise<ICollectionEntity | IError>;
     /**
@@ -68,8 +68,8 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
      * @param {number} [userQuery.entityType] - Entity type. Example: "orders".
      * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
-     * @returns {ICollectionRowsResponce} Returns object ItemsWithTotal, where items is an array of requested objects.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<ICollectionRowsResponce | IError>} Returns object ItemsWithTotal, where items is an array of requested objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get all records belonging to the collection by collection id.
      */
     getICollectionRowsById(id: number, langCode?: string, userQuery?: {
@@ -82,12 +82,12 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * Check for the existence of a text identifier (marker).
      * @handleName validateICollectionMarker
      * @param {string} marker - Collection marker. Example: "collection1".
-     * @returns {ICollectionIsValid} Returns an object with a boolean property `valid` indicating whether the marker is valid or not.
+     * @returns {Promise<ICollectionIsValid | IError>} Returns an object with a boolean property `valid` indicating whether the marker is valid or not.
      * @example
         {
           "valid": true
         }
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Check for the existence of a text identifier (marker).
      */
     validateICollectionMarker(marker: string): Promise<ICollectionIsValid | IError>;
@@ -96,8 +96,8 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * @handleName getICollectionRowsByMarker
      * @param {string} marker - Collection text identifier. Example: "collection1".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {ICollectionRowsResponce} Returns CollectionRowEntity object.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<ICollectionRowsResponce | IError>} Returns CollectionRowEntity object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      */
     getICollectionRowsByMarker(marker: string, langCode?: string): Promise<ICollectionRowsResponce | IError>;
     /**
@@ -106,8 +106,8 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * @param {string} marker - Collection text identifier. Example: "collection1".
      * @param {number} id - Collection record identifier. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {ICollectionRow} Returns CollectionRowEntity object.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<ICollectionRow | IError>} Returns CollectionRowEntity object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      */
     getICollectionRowByMarkerAndId(marker: string, id: number, langCode?: string): Promise<ICollectionRow | IError>;
     /**
@@ -127,8 +127,8 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
           ]
         }
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {ICollectionRow} Returns object of type ICollectionRow.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<ICollectionRow | IError>} Returns object of type ICollectionRow.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Create a record in the collection.
      */
     createICollectionRow(marker: string, body: ICollectionFormObject, langCode?: string): Promise<ICollectionRow | IError>;
@@ -152,8 +152,8 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * @param {string} body.formIdentifier - Textual identifier of the form. Example: "collection-form".
      * @param {any} body.formData - Object with the form data.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {ICollectionRow} Returns object of type ICollectionRow.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<ICollectionRow | IError>} Returns object of type ICollectionRow.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Edit a record in the collection.
      */
     updateICollectionRow(marker: string, id: number, body: {
@@ -165,8 +165,8 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * @handleName deleteICollectionRowByMarkerAndId
      * @param {string} marker - text identifier of the collection Example: "collection1".
      * @param {number} id - record identifier in the collection Example: 12.
-     * @returns {boolean} Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<boolean | IError>} Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Deletion of collection record object
      */
     deleteICollectionRowByMarkerAndId(marker: string, id: number): Promise<boolean | IError>;