oneentry 1.0.126 → 1.0.128

package/dist/templates/templatesInterfaces.d.ts

@@ -1,44 +1,45 @@
 import type { AttributeType, IError, Types } from '../base/utils';
 /**
  * @interface ITemplatesApi
- *
- * @property {function} getAllTemplates - Get all template objects grouped by types.
- * @property {function} getTemplateByType - Get template objects by type.
- * @property {function} getTemplateByMarker - Getting a single template object.
- *
+ * @property {Function} getAllTemplates - Get all template objects grouped by types.
+ * @property {Function} getTemplateByType - Get template objects by type.
+ * @property {Function} getTemplateByMarker - Getting a single template object.
  * @description This interface defines methods for retrieving templates in the system, including fetching all templates, specific templates by type or ID, and by marker.
  */
 interface ITemplatesApi {
     /**
      * Get all template objects grouped by types.
-     *
+     * @handleName getAllTemplates
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {Record<Types, ITemplateEntity[]>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @returns {Record<Types, ITemplateEntity[]>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets all template objects grouped by types.
      */
     getAllTemplates(langCode?: string): Promise<Record<Types, ITemplateEntity[]> | IError>;
     /**
      * Get template objects by type.
-     *
+     * @handleName getTemplateByType
      * @param {Types} type - The type of templates to retrieve. This parameter specifies the category or classification of templates being requested. Example: "product".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {TemplateEntity[]} Returns a TemplateEntity object.
+     * @returns {ITemplateEntity[]} Returns a TemplateEntity object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets template objects by type.
      */
     getTemplateByType(type: Types, langCode: string): Promise<ITemplateEntity[] | IError>;
     /**
      * Get one template object by id.
-     *
+     * @handleName getTemplateByMarker
      * @param {string} marker - The unique marker of the template to retrieve. Example: "template_12345".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ITemplateEntity} Returns a TemplateEntity object
+     * @returns {ITemplateEntity} Returns a TemplateEntity object
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets one template object by id.
      */
     getTemplateByMarker(marker: string, langCode?: string): Promise<ITemplateEntity | IError>;
 }
 /**
+ * The template entity interface
  * @interface ITemplateEntity
- *
  * @property {number} id - The unique identifier of the position. Example: 12345.
  * @property {string | null} attributeSetIdentifier - Set of attributes id. Example: "attribute_set_1".
  * @property {string} title - The name of the template. Example: "Product Template".

package/dist/templates-preview/templatesPreviewApi.d.ts

@@ -4,34 +4,33 @@ import type { IError } from '../base/utils';
 import type { ITemplatesPreview, ITemplatesPreviewEntity } from './templatesPreviewInterfaces';
 /**
  * Controllers for working with template objects for preview.
- *
  * @handle /api/content/template-previews
- *
  * @description This module provides a set of controllers for managing and retrieving template objects designed for preview purposes.
  */
 export default class TemplatePreviewsApi extends AsyncModules implements ITemplatesPreview {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * Constructor for the TemplatePreviewsApi class.
+     * @param {StateModule} state - The state module instance.
+     * @description Initializes the TemplatePreviewsApi class with the provided state module instance.
+     */
     constructor(state: StateModule);
     /**
      * Get all template objects.
-     *
      * @handleName getTemplatePreviews
-     *
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ITemplatesPreviewEntity[]} - Returns all TemplatePreviewsEntity template objects.
+     * @returns {ITemplatesPreviewEntity[]} - Returns all TemplatePreviewsEntity template objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method is used to fetch all available template objects.
      */
     getTemplatePreviews(langCode?: string): Promise<ITemplatesPreviewEntity[] | IError>;
     /**
      * Retrieves a template object by its marker.
-     *
      * @handleName getTemplatePreviewByMarker
-     *
      * @param {string} marker - The unique product marker used to identify the template. If not provided, a default behavior or error may occur. Example: "template_12345".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {TemplatePreviewsEntity} - A promise that resolves to a TemplatePreviewsEntity object representing the template.
+     * @returns {Promise<ITemplatesPreviewEntity | IError>} - A promise that resolves to a TemplatePreviewsEntity object representing the template.
      * @throws {IError} - Throws an error object if there is an issue during the fetch operation.
      * @description This method is used to fetch a specific template object based on the provided marker.
      */

package/dist/templates-preview/templatesPreviewApi.js

@@ -6,23 +6,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with template objects for preview.
- *
  * @handle /api/content/template-previews
- *
  * @description This module provides a set of controllers for managing and retrieving template objects designed for preview purposes.
  */
 class TemplatePreviewsApi extends asyncModules_1.default {
+    /**
+     * Constructor for the TemplatePreviewsApi class.
+     * @param {StateModule} state - The state module instance.
+     * @description Initializes the TemplatePreviewsApi class with the provided state module instance.
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/template-previews';
     }
     /**
      * Get all template objects.
-     *
      * @handleName getTemplatePreviews
-     *
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ITemplatesPreviewEntity[]} - Returns all TemplatePreviewsEntity template objects.
+     * @returns {ITemplatesPreviewEntity[]} - Returns all TemplatePreviewsEntity template objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method is used to fetch all available template objects.
      */
@@ -32,12 +33,10 @@ class TemplatePreviewsApi extends asyncModules_1.default {
     }
     /**
      * Retrieves a template object by its marker.
-     *
      * @handleName getTemplatePreviewByMarker
-     *
      * @param {string} marker - The unique product marker used to identify the template. If not provided, a default behavior or error may occur. Example: "template_12345".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {TemplatePreviewsEntity} - A promise that resolves to a TemplatePreviewsEntity object representing the template.
+     * @returns {Promise<ITemplatesPreviewEntity | IError>} - A promise that resolves to a TemplatePreviewsEntity object representing the template.
      * @throws {IError} - Throws an error object if there is an issue during the fetch operation.
      * @description This method is used to fetch a specific template object based on the provided marker.
      */

package/dist/templates-preview/templatesPreviewInterfaces.d.ts

@@ -1,17 +1,13 @@
 import type { AttributeType, IError } from '../base/utils';
 /**
  * @interface ITemplatesPreview
- *
- * @property {function} getTemplatesPreview - Get all template objects.
- * @property {function} getTemplatesPreviewById - Get one template object by id.
- * @property {function} getTemplatesPreviewByMarker - Get one template object by marker.
- *
- * @description This interface defines methods for retrieving template previews in the system, including fetching all previews, specific previews by ID, and by marker.
+ * @property {Function} getTemplatePreviews - Get all template preview objects.
+ * @property {Function} getTemplatePreviewByMarker - Get one template preview object by marker.
+ * @description This interface defines methods for retrieving template previews in the system, including fetching all previews, specific previews by marker.
  */
 interface ITemplatesPreview {
     /**
      * Retrieves all template preview objects.
-     *
      * @param {string} langCode - Language code for localization. Default: "en_US".
      * @returns {ITemplatesPreviewEntity[]} A promise resolving to an array of template preview entities or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -19,17 +15,18 @@ interface ITemplatesPreview {
     getTemplatePreviews(langCode: string): Promise<ITemplatesPreviewEntity[] | IError>;
     /**
      * Retrieves a specific template preview object by its marker.
-     *
-     * @param {string} marker - The marker of the template preview. Example: "template_12345".
+     * @handleName getTemplatePreviewByMarker
+     * @param {string} marker     - The marker of the template preview. Example: "template_12345".
      * @param {string} [langCode] - Language code for localization. Default: "en_US".
-     * @returns {ITemplatesPreviewEntity} A promise resolving to the template preview entity or an error.
+     * @returns {ITemplatesPreviewEntity | IError} A promise resolving to the template preview entity or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method retrieves a specific template preview object by its marker.
      */
     getTemplatePreviewByMarker(marker: string, langCode: string): Promise<ITemplatesPreviewEntity | IError>;
 }
 /**
+ * The `ITemplatesPreview` interface defines the structure of template preview entities.
  * @interface ITemplatesPreviewEntity
- *
  * @property {number} id - The unique identifier of the position. Example: 3.
  * @property {string} title - The name of the template preview. Example: "Product Template"..
  * @property {object} proportions - Object contains info by proportions template preview. Example:
@@ -51,11 +48,6 @@ interface ITemplatesPreview {
         }
       }
     }
- * @property {string} identifier - The textual identifier for the record field. Example: "preview-templates"
- * @property {number} version - The version number of the object. Example: 1.
- * @property {AttributeType} attributeValues - Attribute values from index. Example: {}
- * @property {number} position - The position of the object. Example: 1.
- * @property {string | null} [attributeSetIdentifier] - Text identifier used for a set of attributes. Example: "attribute_set_1".
  * @property {IProportion | null} proportions.horizontal - Horizontal proportion of the template preview. Example:
     {
       "width": 234,
@@ -73,6 +65,11 @@ interface ITemplatesPreview {
       "side": 3,
       "alignmentType": "leftTop"
     }
+ * @property {string} identifier - The textual identifier for the record field. Example: "preview-templates"
+ * @property {number} version - The version number of the object. Example: 1.
+ * @property {AttributeType} attributeValues - Attribute values from index. Example: {}
+ * @property {number} position - The position of the object. Example: 1.
+ * @property {string | null} [attributeSetIdentifier] - Text identifier used for a set of attributes. Example: "attribute_set_1".
  * @description This interface defines the structure of a template preview entity, including its identifiers, attributes, proportions, and title.
  */
 interface ITemplatesPreviewEntity {
@@ -93,8 +90,8 @@ interface ITemplatesPreviewEntity {
     attributeSetIdentifier?: string | null;
 }
 /**
+ * The `IProportion` interface defines the structure of a proportion object used in template previews.
  * @interface IProportion
- *
  * @property {string | number | null} width - width of the template preview. Example: 100.
  * @property {string | number | null} height - height of the template preview. Example: 200.
  * @property {string} alignmentType - alignment type of the template preview. Example: "center".
@@ -106,8 +103,8 @@ interface IProportion {
     alignmentType: string;
 }
 /**
+ * The `ISquare` interface defines the structure of a square proportion object used in template previews.
  * @interface ISquare
- *
  * @property {number | string} side - Side length of the square template preview, can be a number or string. Example: 100.
  * @property {string} alignmentType - Alignment type of the square template preview. Example: "center".
  * @description Represents a square proportion object used in template previews.

package/dist/users/usersApi.d.ts

@@ -10,30 +10,31 @@ import type { IUserBody, IUserEntity, IUsers } from './usersInterfaces';
 export default class UsersApi extends AsyncModules implements IUsers {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * Constructor for UsersApi class.
+     * @param {StateModule} state - The state module containing necessary information for API calls.
+     * @description Initializes the UsersApi class with the provided state module.
+     */
     constructor(state: StateModule);
     /**
      * Getting the data of an authorized user.
-     *
      * @handleName getUser
-     *
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IUserEntity} Returns a promise that resolves to the user entity object if successful; otherwise, returns an error object.
+     * @returns {IUserEntity} Returns a promise that resolves to the user entity object if successful; otherwise, returns an error object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Getting the data of an authorized user. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     getUser(langCode?: string): Promise<IUserEntity | IError>;
     /**
      * Updating a single user object.
-     *
      * @handleName updateUser
-     *
      * @param {IUserBody} body - Request body. Example:
         {
           "formIdentifier": "reg",
           "authData": [
             {
-              "marker": "password",
-              "value": "12345"
+            "marker": "password",
+            "value": "12345"
             }
           ],
           "formData": {
@@ -49,49 +50,41 @@ export default class UsersApi extends AsyncModules implements IUsers {
           "state": {}
         }
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {boolean} Returns `true` if the user object was successfully updated; otherwise, returns an error object.
+     * @returns {boolean} Returns `true` if the user object was successfully updated; otherwise, returns an error object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Updating a single user object. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     updateUser(body: IUserBody, langCode?: string): Promise<boolean | IError>;
     /**
      * Archiving one user object (marked for deletion).
-     *
      * @handleName archiveUser
-     *
-     * @return {boolean} Returns `true` if the user was successfully deleted; otherwise, returns an error object.
+     * @returns {boolean} Returns `true` if the user was successfully deleted; otherwise, returns an error object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Archiving one user object (marked for deletion). This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     archiveUser(): Promise<boolean | IError>;
     /**
      * Delete a single user.
-     *
      * @handleName deleteUser
-     *
-     * @return {boolean} Returns `true` if the user was successfully deleted; otherwise, returns an error object.
+     * @returns {boolean} Returns `true` if the user was successfully deleted; otherwise, returns an error object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     deleteUser(): Promise<boolean | IError>;
     /**
      * Adds an FCM (Firebase Cloud Messaging) token for sending push notifications.
-     *
      * @handleName addFCMToken
-     *
      * @param {string} token - The cloud messaging token to be added. This token is used to identify the user's device for push notifications. Example: "fcm_token_1234567890abcdefg".
-     * @return {boolean} Returns `true` if the token was successfully added; otherwise, returns an error object.
+     * @returns {boolean} Returns `true` if the token was successfully added; otherwise, returns an error object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     addFCMToken(token: string): Promise<boolean | IError>;
     /**
      * Deletes an FCM (Firebase Cloud Messaging) token.
-     *
      * @handleName deleteFCMToken
-     *
      * @param {string} token - The cloud messaging token to be deleted. This token is used to identify the user's device for push notifications and will be removed. Example: "fcm_token_1234567890abcdefg".
-     * @return {boolean} Returns `true` if the token was successfully deleted; otherwise, returns an error object.
+     * @returns {boolean} Returns `true` if the token was successfully deleted; otherwise, returns an error object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */

package/dist/users/usersApi.js

@@ -10,17 +10,20 @@ const asyncModules_1 = __importDefault(require("../base/asyncModules"));
  * @description This module provides various methods to manage users, including creating, retrieving, updating, and deleting user data. It requires proper authorization to access these endpoints.
  */
 class UsersApi extends asyncModules_1.default {
+    /**
+     * Constructor for UsersApi class.
+     * @param {StateModule} state - The state module containing necessary information for API calls.
+     * @description Initializes the UsersApi class with the provided state module.
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/users';
     }
     /**
      * Getting the data of an authorized user.
-     *
      * @handleName getUser
-     *
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IUserEntity} Returns a promise that resolves to the user entity object if successful; otherwise, returns an error object.
+     * @returns {IUserEntity} Returns a promise that resolves to the user entity object if successful; otherwise, returns an error object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Getting the data of an authorized user. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
@@ -30,16 +33,14 @@ class UsersApi extends asyncModules_1.default {
     }
     /**
      * Updating a single user object.
-     *
      * @handleName updateUser
-     *
      * @param {IUserBody} body - Request body. Example:
         {
           "formIdentifier": "reg",
           "authData": [
             {
-              "marker": "password",
-              "value": "12345"
+            "marker": "password",
+            "value": "12345"
             }
           ],
           "formData": {
@@ -55,7 +56,7 @@ class UsersApi extends asyncModules_1.default {
           "state": {}
         }
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {boolean} Returns `true` if the user object was successfully updated; otherwise, returns an error object.
+     * @returns {boolean} Returns `true` if the user object was successfully updated; otherwise, returns an error object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Updating a single user object. This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
@@ -71,10 +72,8 @@ class UsersApi extends asyncModules_1.default {
     }
     /**
      * Archiving one user object (marked for deletion).
-     *
      * @handleName archiveUser
-     *
-     * @return {boolean} Returns `true` if the user was successfully deleted; otherwise, returns an error object.
+     * @returns {boolean} Returns `true` if the user was successfully deleted; otherwise, returns an error object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Archiving one user object (marked for deletion). This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
@@ -84,10 +83,8 @@ class UsersApi extends asyncModules_1.default {
     }
     /**
      * Delete a single user.
-     *
      * @handleName deleteUser
-     *
-     * @return {boolean} Returns `true` if the user was successfully deleted; otherwise, returns an error object.
+     * @returns {boolean} Returns `true` if the user was successfully deleted; otherwise, returns an error object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
@@ -97,11 +94,9 @@ class UsersApi extends asyncModules_1.default {
     }
     /**
      * Adds an FCM (Firebase Cloud Messaging) token for sending push notifications.
-     *
      * @handleName addFCMToken
-     *
      * @param {string} token - The cloud messaging token to be added. This token is used to identify the user's device for push notifications. Example: "fcm_token_1234567890abcdefg".
-     * @return {boolean} Returns `true` if the token was successfully added; otherwise, returns an error object.
+     * @returns {boolean} Returns `true` if the token was successfully added; otherwise, returns an error object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
@@ -111,11 +106,9 @@ class UsersApi extends asyncModules_1.default {
     }
     /**
      * Deletes an FCM (Firebase Cloud Messaging) token.
-     *
      * @handleName deleteFCMToken
-     *
      * @param {string} token - The cloud messaging token to be deleted. This token is used to identify the user's device for push notifications and will be removed. Example: "fcm_token_1234567890abcdefg".
-     * @return {boolean} Returns `true` if the token was successfully deleted; otherwise, returns an error object.
+     * @returns {boolean} Returns `true` if the token was successfully deleted; otherwise, returns an error object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */

package/dist/users/usersInterfaces.d.ts

@@ -4,37 +4,35 @@ import type { IError } from '../base/utils';
 import type { FormDataType } from '../forms-data/formsDataInterfaces';
 /**
  * Interface representing user-related operations.
- *
  * @interface IUsers
- *
- * @property {function} getUser - Retrieves the data of an authorized user, optionally based on a language code.
- * @property {function} updateUser - Updates the user's data with the provided information.
- * @property {function} archiveUser - Archiving one user object (marked for deletion).
- * @property {function} deleteUser - Deletes the user from the system.
- * @property {function} addFCMToken - Adds an FCM (Firebase Cloud Messaging) token for sending push notifications.
- * @property {function} deleteFCMToken - Deletes an existing FCM token.
+ * @property {Function} getUser - Retrieves the data of an authorized user, optionally based on a language code.
+ * @property {Function} updateUser - Updates the user's data with the provided information.
+ * @property {Function} archiveUser - Archiving one user object (marked for deletion).
+ * @property {Function} deleteUser - Deletes the user from the system.
+ * @property {Function} addFCMToken - Adds an FCM (Firebase Cloud Messaging) token for sending push notifications.
+ * @property {Function} deleteFCMToken - Deletes an existing FCM token.
  * @description This interface defines methods for managing user data and handling Firebase Cloud Messaging tokens.
  */
 interface IUsers {
     /**
      * Retrieves the data of an authorized user.
-     *
+     * @handleName getUser
      * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
-     * @return {IUserEntity} A promise resolving to the user entity or an error.
+     * @returns {IUserEntity} A promise resolving to the user entity or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description Retrieves the data of an authorized user.
+     * @description This method retrieves the data of an authorized user.
      */
     getUser(langCode?: string): Promise<IUserEntity | IError>;
     /**
      * Updates the user's data.
-     *
+     * @handleName updateUser
      * @param {IUserBody} data - The new data for the user. Example:
         {
           "formIdentifier": "reg",
           "authData": [
             {
-              "marker": "password",
-              "value": "12345"
+            "marker": "password",
+            "value": "12345"
             }
           ],
           "formData": {
@@ -50,49 +48,48 @@ interface IUsers {
           "state": {}
         }
      * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
-     * @return {boolean} A promise resolving to true if successful, or an error.
+     * @returns {boolean} A promise resolving to true if successful, or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description Updates the user's data.
+     * @description This method updates the user's data.
      */
     updateUser(data: IUserBody, langCode?: string): Promise<boolean | IError>;
     /**
      * Archiving one user object (marked for deletion).
-     *
-     * @return {boolean} A promise resolving to true if successful, or an error.
+     * @handleName archiveUser
+     * @returns {boolean} A promise resolving to true if successful, or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description Deletes the user from the system.
+     * @description This method archives a user object (marks it for deletion).
      */
     archiveUser(): Promise<boolean | IError>;
     /**
      * Deletes the user from the system.
-     *
-     * @return {boolean} A promise resolving to true if successful, or an error.
+     * @handleName deleteUser
+     * @returns {boolean} A promise resolving to true if successful, or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description Deletes the user from the system.
+     * @description This method deletes the user from the system.
      */
     deleteUser(): Promise<boolean | IError>;
     /**
      * Adds an FCM token for sending push notifications.
-     *
+     * @handleName addFCMToken
      * @param {string} token - The FCM token to be added. Example: "fcm_token_1234567890abcdefg".
-     * @return {boolean} A promise resolving to true if successful, or an error.
+     * @returns {boolean} A promise resolving to true if successful, or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description Adds an FCM token for sending push notifications.
+     * @description This method adds an FCM token for sending push notifications.
      */
     addFCMToken(token: string): Promise<boolean | IError>;
     /**
      * Deletes an existing FCM token.
-     *
+     * @handleName deleteFCMToken
      * @param {string} token - The FCM token to be deleted. Example: "fcm_token_1234567890abcdefg".
-     * @return {boolean} A promise resolving to true if successful, or an error.
+     * @returns {boolean} A promise resolving to true if successful, or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description Deletes an existing FCM token.
+     * @description This method deletes an existing FCM token.
      */
     deleteFCMToken(token: string): Promise<boolean | IError>;
 }
 /**
  * @interface IUserEntity
- *
  * @property {number} id - Object identifier. Example: 12345.
  * @property {string} identifier - Text identifier for record field. Example: "user_12345".
  * @property {string} authProviderIdentifier - Text identifier of the authentication provider. Example: "auth_provider_12345".
@@ -121,7 +118,6 @@ interface IUserEntity {
 }
 /**
  * @interface IUserBody
- *
  * @property {string} formIdentifier - Text identifier of the form. Example: "form_12345".
  * @property {string} [langCode] - Language code for localization. Default: "en_US".
  * @property {{ marker: string; value: string }[]} [authData] - Array of authentication data objects with markers and values. Example:

package/dist/web-socket/wsApi.d.ts

@@ -9,13 +9,15 @@ import type { IWS } from './wsInterfaces';
 export default class WsApi extends AsyncModules implements IWS {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * Constructor
+     * @param {StateModule} state - StateModule
+     */
     constructor(state: StateModule);
     /**
      * Creates an instance of an object Socket.io with a connection. This method requires user authorization.
-     *
      * @handleName connect
-     *
-     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @returns {Socket} Returns a Socket instance.
      * @description Creates an instance of an object Socket.io with a connection. This method requires user authorization.
      */
     connect(): Socket;

package/dist/web-socket/wsApi.js

@@ -10,20 +10,23 @@ const asyncModules_1 = __importDefault(require("../base/asyncModules"));
  * @handle /api/content/ws
  */
 class WsApi extends asyncModules_1.default {
+    /**
+     * Constructor
+     * @param {StateModule} state - StateModule
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/ws';
     }
     /**
      * Creates an instance of an object Socket.io with a connection. This method requires user authorization.
-     *
      * @handleName connect
-     *
-     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @returns {Socket} Returns a Socket instance.
      * @description Creates an instance of an object Socket.io with a connection. This method requires user authorization.
      */
     connect() {
         if (!this.state.accessToken) {
+            // eslint-disable-next-line no-undef, no-console
             console.error('User is unauthorized');
         }
         const socket = (0, socket_io_client_1.io)(this.state.url, {

package/dist/web-socket/wsInterfaces.d.ts

@@ -1,11 +1,16 @@
 import type { Socket } from 'socket.io-client';
 /**
  * @interface IWS
- *
- * @property {function} connect - WebSocket Connection.
+ * @property {Function} connect - WebSocket Connection.
  * @description This interface defines a method for establishing a WebSocket connection.
  */
 interface IWS {
+    /**
+     * WebSocket Connection.
+     * @handleName connect
+     * @returns {Socket} Returns a Socket instance.
+     * @description This method establishes a WebSocket connection.
+     */
     connect(): Socket;
 }
 export type { IWS };