oneentry 1.0.127 → 1.0.128

package/dist/system/systemApi.d.ts

@@ -35,16 +35,16 @@ export default class SystemApi extends AsyncModules implements ISystem {
     /**
      * Validates a CAPTCHA token by sending it to the server for verification.
      * @handleName validateCapcha
-     * @param   {object} event                - The event object containing CAPTCHA data. Example:
-                                              {
-                                              "token": "03AGdBq24...",
-                                              "expectedAction": "login",
-                                              "siteKey": "6Lc_aCMTAAAAAB..."
-                                              }
-     * @param   {string} event.token          - The CAPTCHA token to be validated. Example: "03AGdBq24...".
-     * @param   {string} event.expectedAction - The expected action associated with the CAPTCHA. Example: "login".
-     * @param   {string} event.siteKey        - The site key used for the CAPTCHA. Example: "6Lc_aCMTAAAAAB...".
-     * @returns {any}                         The response from the server after validating the CAPTCHA, or an error object if validation fails.
+     * @param {object} event - The event object containing CAPTCHA data. Example:
+        {
+          "token": "03AGdBq24...",
+          "expectedAction": "login",
+          "siteKey": "6Lc_aCMTAAAAAB..."
+        }
+     * @param {string} event.token - The CAPTCHA token to be validated. Example: "03AGdBq24...".
+     * @param {string} event.expectedAction - The expected action associated with the CAPTCHA. Example: "login".
+     * @param {string} event.siteKey - The site key used for the CAPTCHA. Example: "6Lc_aCMTAAAAAB...".
+     * @returns {any} The response from the server after validating the CAPTCHA, or an error object if validation fails.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method sends the CAPTCHA token and related information to the server endpoint '/captcha/validate' to verify its validity.
      */

package/dist/system/systemApi.js

@@ -46,16 +46,16 @@ class SystemApi extends asyncModules_1.default {
     /**
      * Validates a CAPTCHA token by sending it to the server for verification.
      * @handleName validateCapcha
-     * @param   {object} event                - The event object containing CAPTCHA data. Example:
-                                              {
-                                              "token": "03AGdBq24...",
-                                              "expectedAction": "login",
-                                              "siteKey": "6Lc_aCMTAAAAAB..."
-                                              }
-     * @param   {string} event.token          - The CAPTCHA token to be validated. Example: "03AGdBq24...".
-     * @param   {string} event.expectedAction - The expected action associated with the CAPTCHA. Example: "login".
-     * @param   {string} event.siteKey        - The site key used for the CAPTCHA. Example: "6Lc_aCMTAAAAAB...".
-     * @returns {any}                         The response from the server after validating the CAPTCHA, or an error object if validation fails.
+     * @param {object} event - The event object containing CAPTCHA data. Example:
+        {
+          "token": "03AGdBq24...",
+          "expectedAction": "login",
+          "siteKey": "6Lc_aCMTAAAAAB..."
+        }
+     * @param {string} event.token - The CAPTCHA token to be validated. Example: "03AGdBq24...".
+     * @param {string} event.expectedAction - The expected action associated with the CAPTCHA. Example: "login".
+     * @param {string} event.siteKey - The site key used for the CAPTCHA. Example: "6Lc_aCMTAAAAAB...".
+     * @returns {any} The response from the server after validating the CAPTCHA, or an error object if validation fails.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method sends the CAPTCHA token and related information to the server endpoint '/captcha/validate' to verify its validity.
      */

package/dist/templates/templatesApi.d.ts

@@ -20,8 +20,8 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
     /**
      * Get all template objects grouped by types.
      * @handleName getAllTemplates
-     * @param   {string}                           [langCode] - Language code. Default: "en_US".
-     * @returns {Record<Types, ITemplateEntity[]>}            Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @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 function is designed to fetch organized template objects in groups based on their types.
      */
@@ -29,9 +29,9 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
     /**
      * 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".
-     * @returns {ITemplateEntity[]}            Returns a TemplateEntity object.
+     * @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".
+     * @returns {ITemplateEntity[]} Returns a TemplateEntity object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Fetch template objects that belong to a specific type, with an optional filter by language.
      */
@@ -39,9 +39,9 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
     /**
      * Get one template object by marker.
      * @handleName getTemplateByMarker
-     * @param   {string}          marker     - The unique marker of the template to retrieve. Example: "template_12345".
-     * @param   {string}          [langCode] - Language code. Default: "en_US".
-     * @returns {ITemplateEntity}            Returns a TemplateEntity object
+     * @param {string} marker - The unique marker of the template to retrieve. Example: "template_12345".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {ITemplateEntity} Returns a TemplateEntity object
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Fetch a specific template object based on its unique marker.
      */

package/dist/templates/templatesApi.js

@@ -24,8 +24,8 @@ class TemplatesPreviewApi extends asyncModules_1.default {
     /**
      * Get all template objects grouped by types.
      * @handleName getAllTemplates
-     * @param   {string}                           [langCode] - Language code. Default: "en_US".
-     * @returns {Record<Types, ITemplateEntity[]>}            Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @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 function is designed to fetch organized template objects in groups based on their types.
      */
@@ -41,9 +41,9 @@ class TemplatesPreviewApi extends asyncModules_1.default {
     /**
      * 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".
-     * @returns {ITemplateEntity[]}            Returns a TemplateEntity object.
+     * @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".
+     * @returns {ITemplateEntity[]} Returns a TemplateEntity object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Fetch template objects that belong to a specific type, with an optional filter by language.
      */
@@ -54,9 +54,9 @@ class TemplatesPreviewApi extends asyncModules_1.default {
     /**
      * Get one template object by marker.
      * @handleName getTemplateByMarker
-     * @param   {string}          marker     - The unique marker of the template to retrieve. Example: "template_12345".
-     * @param   {string}          [langCode] - Language code. Default: "en_US".
-     * @returns {ITemplateEntity}            Returns a TemplateEntity object
+     * @param {string} marker - The unique marker of the template to retrieve. Example: "template_12345".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {ITemplateEntity} Returns a TemplateEntity object
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Fetch a specific template object based on its unique marker.
      */

package/dist/templates/templatesInterfaces.d.ts

@@ -1,8 +1,8 @@
 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} 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.
  */
@@ -10,8 +10,8 @@ interface ITemplatesApi {
     /**
      * Get all template objects grouped by types.
      * @handleName getAllTemplates
-     * @param   {string}                           [langCode] - Language code. Default: "en_US".
-     * @returns {Record<Types, ITemplateEntity[]>}            Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @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.
      */
@@ -19,9 +19,9 @@ interface ITemplatesApi {
     /**
      * 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".
-     * @returns {ITemplateEntity[]}            Returns a TemplateEntity object.
+     * @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".
+     * @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.
      */
@@ -29,9 +29,9 @@ interface ITemplatesApi {
     /**
      * 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".
-     * @returns {ITemplateEntity}            Returns a TemplateEntity object
+     * @param {string} marker - The unique marker of the template to retrieve. Example: "template_12345".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @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.
      */
@@ -40,19 +40,19 @@ interface ITemplatesApi {
 /**
  * The template entity interface
  * @interface ITemplateEntity
- * @property {number}        id                     - The unique identifier of the position. Example: 12345.
+ * @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".
- * @property {number}        generalTypeId          - General type Entity id. Example: 67890.
- * @property {string}        identifier             - The textual identifier for the record field. Example: "template_12345".
- * @property {number}        version                - The version number of the object. Example: 1.
- * @property {Types}         generalTypeName        - General type name. Example: "product".
- * @property {AttributeType} attributeValues        - Attribute values from the index (represented as a pair of user attribute id: attribute value). Example:
- * @property {number}        position               - The position of the object. Example: 1.
-                                                    {
-                                                    "id": 1,
-                                                    "value": "some"
-                                                    }
+ * @property {string} title - The name of the template. Example: "Product Template".
+ * @property {number} generalTypeId - General type Entity id. Example: 67890.
+ * @property {string} identifier - The textual identifier for the record field. Example: "template_12345".
+ * @property {number} version - The version number of the object. Example: 1.
+ * @property {Types} generalTypeName - General type name. Example: "product".
+ * @property {AttributeType} attributeValues - Attribute values from the index (represented as a pair of user attribute id: attribute value). Example:
+ * @property {number} position - The position of the object. Example: 1.
+    {
+      "id": 1,
+      "value": "some"
+    }
  * @description This interface defines the structure of a template entity, including its identifiers, attributes, and general type information.
  */
 interface ITemplateEntity {

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

@@ -19,8 +19,8 @@ export default class TemplatePreviewsApi extends AsyncModules implements ITempla
     /**
      * Get all template objects.
      * @handleName getTemplatePreviews
-     * @param   {string}                    [langCode] - Language code. Default: "en_US".
-     * @returns {ITemplatesPreviewEntity[]}            - Returns all TemplatePreviewsEntity template objects.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @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.
      */
@@ -28,9 +28,9 @@ export default class TemplatePreviewsApi extends AsyncModules implements ITempla
     /**
      * 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".
-     * @returns {Promise<ITemplatesPreviewEntity | IError>}            - A promise that resolves to a TemplatePreviewsEntity object representing the template.
+     * @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".
+     * @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

@@ -22,8 +22,8 @@ class TemplatePreviewsApi extends asyncModules_1.default {
     /**
      * Get all template objects.
      * @handleName getTemplatePreviews
-     * @param   {string}                    [langCode] - Language code. Default: "en_US".
-     * @returns {ITemplatesPreviewEntity[]}            - Returns all TemplatePreviewsEntity template objects.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @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.
      */
@@ -34,9 +34,9 @@ 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".
-     * @returns {Promise<ITemplatesPreviewEntity | IError>}            - A promise that resolves to a TemplatePreviewsEntity object representing the template.
+     * @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".
+     * @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,24 +1,24 @@
 import type { AttributeType, IError } from '../base/utils';
 /**
  * @interface ITemplatesPreview
- * @property {Function} getTemplatePreviews        - Get all template preview objects.
+ * @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.
+     * @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<ITemplatesPreviewEntity[] | IError>;
     /**
      * Retrieves a specific template preview object by its marker.
      * @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 | IError}            A promise resolving to the template preview entity or an error.
+     * @param {string} marker     - The marker of the template preview. Example: "template_12345".
+     * @param {string} [langCode] - Language code for localization. Default: "en_US".
+     * @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.
      */
@@ -27,49 +27,49 @@ interface ITemplatesPreview {
 /**
  * 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:
-                                                           {
-                                                           "default": {
-                                                           "horizontal": {
-                                                           "width": 234,
-                                                           "height": 324,
-                                                           "alignmentType": "middleBottom"
-                                                           },
-                                                           "vertical": {
-                                                           "width": 2,
-                                                           "height": 3,
-                                                           "alignmentType": "leftTop"
-                                                           },
-                                                           "square": {
-                                                           "side": 3,
-                                                           "alignmentType": "leftTop"
-                                                           }
-                                                           }
-                                                           }
- * @property {IProportion | null} proportions.horizontal   - Horizontal proportion of the template preview. Example:
-                                                           {
-                                                           "width": 234,
-                                                           "height": 324,
-                                                           "alignmentType": "middleBottom"
-                                                           }
- * @property {IProportion | null} proportions.vertical     - Vertical proportion of the template preview. Example:
-                                                           {
-                                                           "width": 2,
-                                                           "height": 3,
-                                                           "alignmentType": "leftTop"
-                                                           }
- * @property {ISquare}            proportions.square       - Square proportion of the template preview. Example:
-                                                           {
-                                                           "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".
+ * @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:
+    {
+      "default": {
+        "horizontal": {
+          "width": 234,
+          "height": 324,
+          "alignmentType": "middleBottom"
+        },
+        "vertical": {
+          "width": 2,
+          "height": 3,
+          "alignmentType": "leftTop"
+        },
+        "square": {
+          "side": 3,
+          "alignmentType": "leftTop"
+        }
+      }
+    }
+ * @property {IProportion | null} proportions.horizontal - Horizontal proportion of the template preview. Example:
+    {
+      "width": 234,
+      "height": 324,
+      "alignmentType": "middleBottom"
+    }
+ * @property {IProportion | null} proportions.vertical - Vertical proportion of the template preview. Example:
+    {
+      "width": 2,
+      "height": 3,
+      "alignmentType": "leftTop"
+    }
+ * @property {ISquare} proportions.square - Square proportion of the template preview. Example:
+    {
+      "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 {
@@ -92,9 +92,9 @@ interface ITemplatesPreviewEntity {
 /**
  * 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".
+ * @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".
  * @description Represents a proportion object used in template previews.
  */
 interface IProportion {
@@ -105,8 +105,8 @@ interface IProportion {
 /**
  * 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".
+ * @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 {

package/dist/users/usersApi.d.ts

@@ -19,8 +19,8 @@ export default class UsersApi extends AsyncModules implements IUsers {
     /**
      * Getting the data of an authorized user.
      * @handleName getUser
-     * @param   {string}      [langCode] - Language code. Default: "en_US".
-     * @returns {IUserEntity}            Returns a promise that resolves to the user entity object if successful; otherwise, returns an error object.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @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.
      */
@@ -28,29 +28,29 @@ export default class UsersApi extends AsyncModules implements IUsers {
     /**
      * Updating a single user object.
      * @handleName updateUser
-     * @param   {IUserBody} 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".
-     * @returns {boolean}              Returns `true` if the user object was successfully updated; otherwise, returns an error object.
+     * @param {IUserBody} 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".
+     * @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.
      */
@@ -74,8 +74,8 @@ export default class UsersApi extends AsyncModules implements IUsers {
     /**
      * 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".
-     * @returns {boolean}       Returns `true` if the token was successfully added; otherwise, returns an error object.
+     * @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".
+     * @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.
      */
@@ -83,8 +83,8 @@ export default class UsersApi extends AsyncModules implements IUsers {
     /**
      * 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".
-     * @returns {boolean}       Returns `true` if the token was successfully deleted; otherwise, returns an error object.
+     * @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".
+     * @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

@@ -22,8 +22,8 @@ class UsersApi extends asyncModules_1.default {
     /**
      * Getting the data of an authorized user.
      * @handleName getUser
-     * @param   {string}      [langCode] - Language code. Default: "en_US".
-     * @returns {IUserEntity}            Returns a promise that resolves to the user entity object if successful; otherwise, returns an error object.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @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.
      */
@@ -34,29 +34,29 @@ 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"
-                                       }
-                                       ],
-                                       "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".
-     * @returns {boolean}              Returns `true` if the user object was successfully updated; otherwise, returns an error object.
+     * @param {IUserBody} 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".
+     * @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.
      */
@@ -95,8 +95,8 @@ 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".
-     * @returns {boolean}       Returns `true` if the token was successfully added; otherwise, returns an error object.
+     * @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".
+     * @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.
      */
@@ -107,8 +107,8 @@ 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".
-     * @returns {boolean}       Returns `true` if the token was successfully deleted; otherwise, returns an error object.
+     * @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".
+     * @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.
      */