oneentry 1.0.122 → 1.0.124

package/dist/templates/templatesApi.js

@@ -7,7 +7,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with template objects
+ *
+ * @module TemplateController
  * @handle /api/content/templates
+ *
+ * @description This module provides a set of controllers for handling operations related to template objects.
  */
 class TemplatesPreviewApi extends asyncModules_1.default {
     constructor(state) {
@@ -17,9 +21,14 @@ class TemplatesPreviewApi extends asyncModules_1.default {
     /**
      * Get all template objects grouped by types.
      *
-     * @param {string} [langCode] - Optional parameter language code
+     * @handleName getAllTemplates
      *
-     * @returns Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {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 function is designed to fetch organized template objects in groups based on their types.
      */
     async getAllTemplates(langCode = this.state.lang) {
         const response = await this._fetchGet(`/all?langCode=${langCode}`);
@@ -33,34 +42,32 @@ class TemplatesPreviewApi extends asyncModules_1.default {
     /**
      * Get template objects by type.
      *
-     * @param {Types} [type] - type
-     * @param {string} [langCode] - Optional parameter language code
+     * @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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns a TemplateEntity object
+     * @description Fetch template objects that belong to a specific type, with an optional filter by language.
      */
     async getTemplateByType(type, langCode = this.state.lang) {
         const result = await this._fetchGet(`?type=${type}&langCode=${langCode}`);
         return this._normalizeData(result);
     }
     /**
-     * Get one template object by id.
+     * Get one template object by marker.
      *
-     * @param {number} [id] - Template id
-     * @param {string} [langCode] - Optional parameter language code
+     * @handleName getTemplateByMarker
      *
-     * @returns Returns a TemplateEntity object
-     */
-    async getTemplateById(id, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/${id}?langCode=${langCode}`);
-        return this._normalizeData(result);
-    }
-    /**
-     * Get one template object by id.
+     * @param {number} marker - The unique marker of the template to retrieve. Example: 'template_12345'.
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @param {number} [marker] - Template marker
-     * @param {string} [langCode] - Optional parameter language code
+     * @return {ITemplateEntity} Returns a TemplateEntity object
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns a TemplateEntity object
+     * @description Fetch a specific template object based on its unique marker.
      */
     async getTemplateByMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);

package/dist/templates/templatesInterfaces.d.ts

@@ -1,32 +1,58 @@
 import type { AttributeType, IError, Types } from '../base/utils';
 /**
- * Represents an interface object of Templates Api.
+ * @interface ITemplatesApi
  *
  * @property {function} getAllTemplates - Get all template objects grouped by types.
  * @property {function} getTemplateByType - Get template objects by type.
- * @property {function} getTemplateById - Get one template object by id.
  * @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.
+     *
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {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.
+     */
     getAllTemplates(langCode?: string): Promise<Record<Types, ITemplateEntity> | IError>;
+    /**
+     * Get template objects by type.
+     *
+     * @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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getTemplateByType(type: Types, langCode: string): Promise<Array<ITemplateEntity> | IError>;
-    getTemplateById(id: number): Promise<ITemplateEntity | IError>;
+    /**
+     * Get one template object by id.
+     *
+     * @param {number} 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
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getTemplateByMarker(marker: string, langCode?: string): Promise<ITemplateEntity | IError>;
 }
 /**
- * Represents a template entity object.
+ * @interface ITemplateEntity
  *
- * @interface
- * @property {number} id - The unique identifier of the position.
- * @property {number} version - The version number of the object.
- * @property {string} identifier - The textual identifier for the record field.
- * @property {number} generalTypeId - General type Entity id.
- * @property {string} title - The name of the template.
- * @property {number} position - The position of the object.
- * @property {Types} generalTypeName - General type name.
- * @property {string} attributeSetIdentifier - Set of attributes id.
- * @property {AttributeType} attributeValues - Attribute values from the index (represented as a pair of user attribute id: attribute value).
+ * @property {number} id - The unique identifier of the position. Example: 12345.
+ * @property {number} version - The version number of the object. Example: 1.
+ * @property {string} identifier - The textual identifier for the record field. Example: 'template_12345'.
+ * @property {number} generalTypeId - General type Entity id. Example: 67890.
+ * @property {string} title - The name of the template. Example: 'Product Template'.
+ * @property {number} position - The position of the object. Example: 1.
+ * @property {Types} generalTypeName - General type name. Example: 'product'.
+ * @property {string} attributeSetIdentifier - Set of attributes id. Example: 'attribute_set_1'.
+ * @property {AttributeType} attributeValues - Attribute values from the index (represented as a pair of user attribute id: attribute value). Example: .
  *
+ * @description This interface defines the structure of a template entity, including its identifiers, attributes, and general type information.
  */
 interface ITemplateEntity {
     id: number;

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

@@ -3,8 +3,11 @@ import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
 import type { ITemplatesPreview, ITemplatesPreviewEntity } from './templatesPreviewInterfaces';
 /**
- * Controllers for working with template objects for preview
+ * 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;
@@ -13,27 +16,28 @@ export default class TemplatePreviewsApi extends AsyncModules implements ITempla
     /**
      * Get all template objects.
      *
-     * @param {string} [langCode] - Optional parameter language code
+     * @handleName getTemplatePreviews
      *
-     * @returns Returns all TemplatePreviewsEntity template objects
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {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<Array<ITemplatesPreviewEntity> | IError>;
     /**
-     * Get one template object by id.
+     * Retrieves a template object by its marker.
      *
-     * @param {number} [id] - Product marker
-     * @param {string} [langCode] - Optional parameter language code
+     * @handleName getTemplatePreviewByMarker
      *
-     * @returns Returns a TemplatePreviewsEntity object
-     */
-    getTemplatePreviewById(id: number, langCode?: string): Promise<ITemplatesPreviewEntity | IError>;
-    /**
-     * Get one template object by marker.
+     * @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".
      *
-     * @param {string} [marker] - Product marker
-     * @param {string} [langCode] - Optional parameter language code
+     * @return {TemplatePreviewsEntity} - 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.
      *
-     * @returns Returns a TemplatePreviewsEntity object
+     * @description This method is used to fetch a specific template object based on the provided marker.
      */
     getTemplatePreviewByMarker(marker: string, langCode?: string): Promise<ITemplatesPreviewEntity | IError>;
 }

package/dist/templates-preview/templatesPreviewApi.js

@@ -5,8 +5,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
- * Controllers for working with template objects for preview
+ * 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(state) {
@@ -16,33 +19,31 @@ class TemplatePreviewsApi extends asyncModules_1.default {
     /**
      * Get all template objects.
      *
-     * @param {string} [langCode] - Optional parameter language code
+     * @handleName getTemplatePreviews
      *
-     * @returns Returns all TemplatePreviewsEntity template objects
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {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.
      */
     async getTemplatePreviews(langCode = this.state.lang) {
         const result = await this._fetchGet(`?langCode=${langCode}`);
         return this._normalizeData(result, langCode);
     }
     /**
-     * Get one template object by id.
+     * Retrieves a template object by its marker.
      *
-     * @param {number} [id] - Product marker
-     * @param {string} [langCode] - Optional parameter language code
+     * @handleName getTemplatePreviewByMarker
      *
-     * @returns Returns a TemplatePreviewsEntity object
-     */
-    async getTemplatePreviewById(id, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/${id}?langCode=${langCode}`);
-        return this._normalizeData(result, langCode);
-    }
-    /**
-     * Get one template object by marker.
+     * @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".
      *
-     * @param {string} [marker] - Product marker
-     * @param {string} [langCode] - Optional parameter language code
+     * @return {TemplatePreviewsEntity} - 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.
      *
-     * @returns Returns a TemplatePreviewsEntity object
+     * @description This method is used to fetch a specific template object based on the provided marker.
      */
     async getTemplatePreviewByMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);

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

@@ -1,28 +1,50 @@
 import type { AttributeType, IError } from '../base/utils';
 /**
- * Represents an interface object of Templates Preview Api.
+ * @interface ITemplatesPreview
  *
- * @interface
  * @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.
  */
 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.
+     */
     getTemplatePreviews(langCode: string): Promise<Array<ITemplatesPreviewEntity> | IError>;
-    getTemplatePreviewById(id: number, 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'.
+     * @param {string} [langCode] - Language code for localization. Default: "en_US".
+     *
+     * @returns {ITemplatesPreviewEntity} 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.
+     */
     getTemplatePreviewByMarker(marker: string, langCode: string): Promise<ITemplatesPreviewEntity | IError>;
 }
 /**
- * Represents a template preview entity object.
+ * @interface ITemplatesPreviewEntity
+ *
+ * @property {number} id - The unique identifier of the position. Example: 12345.
+ * @property {number} version - The version number of the object. Example: 1.
+ * @property {string} identifier - The textual identifier for the record field. Example: 'template_12345'.
+ * @property {AttributeType} attributeValues - Attribute values from index. Example: .
+ * @property {string} attributeSetIdentifier - Text identifier used for a set of attributes. Example: 'attribute_set_1'.
+ * @property {string} title - The name of the template preview. Example: 'Product Template'.
+ * @property {number} position - The position of the object. Example: 1.
+ * @property {object} proportions - Object contains info by proportions template preview. Example: .
+ * @property {IProportion | null} proportions.horizontal - Horizontal proportion of the template preview. Example: .
+ * @property {IProportion | null} proportions.vertical - Vertical proportion of the template preview. Example: .
+ * @property {ISquare} proportions.square - Square proportion of the template preview. Example: .
  *
- * @interface
- * @property {number} id - The unique identifier of the position.
- * @property {string} identifier - The textual identifier for the record field.
- * @property {object} proportion - Object contains info by proportion template preview.
- * @property {Record<string, any>} localizeInfos - The name of the template, taking into account localization.
- * @property {number} position - The position of the object.
- * @property {AttributeType} attributeValues - Attribute values from index.
- * @property {string} attributeSetIdentifier - Text identifier used for a set of attributes
+ * @description This interface defines the structure of a template preview entity, including its identifiers, attributes, proportions, and title.
  */
 interface ITemplatesPreviewEntity {
     id: number;
@@ -30,36 +52,42 @@ interface ITemplatesPreviewEntity {
     identifier: string;
     attributeValues: AttributeType;
     attributeSetIdentifier?: string | null;
-    proportion: {
-        horizontal: IProportion | null;
-        vertical: IProportion | null;
-        square: ISquare;
+    proportions: {
+        default: {
+            horizontal: IProportion | null;
+            vertical: IProportion | null;
+            square: ISquare;
+        };
     };
     title: string;
     position: number;
+    isUsed: boolean;
 }
 /**
- * IProportion
+ * @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} marker - marker of the template preview. Example: 'template_12345'.
+ * @property {string} alignmentType - alignment type of the template preview. Example: 'center'.
  *
- * @property {string | number | null} width -
- * @property {string | number | null} height -
- * @property {string} marker -
- * @property {string} alignmentType -
+ * @description Represents a proportion object used in template previews.
  */
 interface IProportion {
-    width: string | number | null;
-    height: string | number | null;
-    marker: string;
+    width: number | null;
+    height: number | null;
     alignmentType: string;
 }
 /**
- * ISquare
- * @property {string} marker -
- * @property {number | string} side -
- * @property {string} alignmentType -
+ * @interface ISquare
+ *
+ * @property {string} marker - Marker of the square template preview. Example: 'square_template_12345'.
+ * @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.
  */
 interface ISquare {
-    marker: string;
     side: number | string;
     alignmentType: string;
 }

package/dist/users/usersApi.d.ts

@@ -5,6 +5,7 @@ import type { IUserBody, IUserEntity, IUsers } from './usersInterfaces';
 /**
  * Controllers for working with users
  * @handle /api/content/users
+ * @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.
  */
 export default class UsersApi extends AsyncModules implements IUsers {
     protected state: StateModule;
@@ -13,63 +14,66 @@ export default class UsersApi extends AsyncModules implements IUsers {
     /**
      * Getting the data of an authorized user.
      *
-     * @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.
+     * @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.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      *
-     * @param {string} [langCode] - lang code.
+     * @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.
      */
     getUser(langCode?: string): Promise<IUserEntity | IError>;
     /**
      * Updating a single user object.
      *
+     * @handleName updateUser
+     *
+     * @param {object} body - Request body. Example: {"formIdentifier": "reg", "authData": [{"marker": "password", "value": "12345"}], "formData": {"marker": "last_name", "type": "string", "value": "Username"}, "notificationData": {"email": "example@oneentry.cloud", "phonePush": ["+99999999999"], "phoneSMS": "+99999999999"}, "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.
+     * @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.
      *
-     * @param {object} [body] - Request body.
-     * @param {string} [langCode] - Optional language field
-     *
-     * @example
-     * {
-     *   "formIdentifier": "reg",
-     *   "authData": [
-     *     {
-     *       "marker": "password",
-     *       "value": "12345"
-     *     }
-     *   ],
-     *   "formData": {
-     *         "marker": "last_name",
-     *         "type": "string",
-     *         "value": "Username"
-     *   },
-     *   "notificationData": {
-     *     "email": "example@oneentry.cloud",
-     *     "phonePush": ["+99999999999"],
-     *     "phoneSMS": "+99999999999"
-     *   },
-     *   "state": {}
-     * }
      */
     updateUser(body: IUserBody, langCode?: string): Promise<boolean | IError>;
     /**
      * Delete a single user 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.
+     * @handleName deleteUser
+     *
+     * @return {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 FCM token for sending Push notification.
+     * Adds an FCM (Firebase Cloud Messaging) token for sending push notifications.
      *
-     * @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.
+     * @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".
      *
-     * @param {string} [token] - Cloud messaging token.
+     * @return {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>;
     /**
-     * Delete FCM token.
+     * Deletes an FCM (Firebase Cloud Messaging) token.
      *
-     * @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.
+     * @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".
      *
-     * @param {string} [token] - Cloud messaging token.
+     * @return {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.
      */
     deleteFCMToken(token: string): Promise<boolean | IError>;
 }

package/dist/users/usersApi.js

@@ -7,6 +7,7 @@ const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with users
  * @handle /api/content/users
+ * @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(state) {
@@ -16,9 +17,14 @@ class UsersApi extends asyncModules_1.default {
     /**
      * Getting the data of an authorized user.
      *
-     * @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.
+     * @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.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      *
-     * @param {string} [langCode] - lang code.
+     * @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 getUser(langCode = this.state.lang) {
         const result = await this._fetchGet(`/me?langCode=${langCode}`);
@@ -27,32 +33,16 @@ class UsersApi extends asyncModules_1.default {
     /**
      * Updating a single user object.
      *
+     * @handleName updateUser
+     *
+     * @param {object} body - Request body. Example: {"formIdentifier": "reg", "authData": [{"marker": "password", "value": "12345"}], "formData": {"marker": "last_name", "type": "string", "value": "Username"}, "notificationData": {"email": "example@oneentry.cloud", "phonePush": ["+99999999999"], "phoneSMS": "+99999999999"}, "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.
+     * @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.
      *
-     * @param {object} [body] - Request body.
-     * @param {string} [langCode] - Optional language field
-     *
-     * @example
-     * {
-     *   "formIdentifier": "reg",
-     *   "authData": [
-     *     {
-     *       "marker": "password",
-     *       "value": "12345"
-     *     }
-     *   ],
-     *   "formData": {
-     *         "marker": "last_name",
-     *         "type": "string",
-     *         "value": "Username"
-     *   },
-     *   "notificationData": {
-     *     "email": "example@oneentry.cloud",
-     *     "phonePush": ["+99999999999"],
-     *     "phoneSMS": "+99999999999"
-     *   },
-     *   "state": {}
-     * }
      */
     async updateUser(body, langCode = this.state.lang) {
         if (!('langCode' in body))
@@ -67,30 +57,44 @@ class UsersApi extends asyncModules_1.default {
     /**
      * Delete a single user 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.
+     * @handleName deleteUser
+     *
+     * @return {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.
      */
     async deleteUser() {
         const result = await this._fetchDelete('/me');
         return result;
     }
     /**
-     * Adds FCM token for sending Push notification.
+     * Adds an FCM (Firebase Cloud Messaging) token for sending push notifications.
      *
-     * @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.
+     * @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".
      *
-     * @param {string} [token] - Cloud messaging token.
+     * @return {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.
      */
     async addFCMToken(token) {
         const result = await this._fetchPost(`/me/fcm-token/${token}`);
         return result;
     }
     /**
-     * Delete FCM token.
+     * Deletes an FCM (Firebase Cloud Messaging) token.
      *
-     * @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.
+     * @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".
      *
-     * @param {string} [token] - Cloud messaging token.
+     * @return {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.
      */
     async deleteFCMToken(token) {
         const result = await this._fetchDelete(`/me/fcm-token/${token}`);