oneentry 1.0.124 → 1.0.126

package/dist/system/systemApi.d.ts

@@ -17,10 +17,9 @@ export default class SystemApi extends AsyncModules implements ISystem {
      *
      * @return {any} The response from the server after fetching data from the '/test404' endpoint.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
-     *
      * @description This method is used to test the 404 error handling by sending a GET request to a specific endpoint.
      */
-    test404(): Promise<any>;
+    test404(): Promise<any | IError>;
     /**
      * Sends a GET request to the '/test500' endpoint and returns the result.
      *
@@ -28,23 +27,25 @@ export default class SystemApi extends AsyncModules implements ISystem {
      *
      * @return {any} The response from the server after fetching data from the '/test500' endpoint.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
-     *
      * @description This method is used to test the 500 error handling by sending a GET request to a specific endpoint.
      */
-    test500(): Promise<any>;
+    test500(): Promise<any | IError>;
     /**
      * Validates a CAPTCHA token by sending it to the server for verification.
      *
      * @handleName validateCapcha
      *
-     * @param {Object} event - The event object containing CAPTCHA data.
-     * @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...'.
-     *
+     * @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...".
      * @return {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.
      */
     validateCapcha(event: {
@@ -52,4 +53,14 @@ export default class SystemApi extends AsyncModules implements ISystem {
         expectedAction: string;
         siteKey: string;
     }): Promise<any | IError>;
+    /**
+     * Getting the number of requests to API.
+     *
+     * @handleName getApiStat
+     *
+     * @return {any} Return object with date and count.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description Getting the number of requests to API.
+     */
+    getApiStat(): Promise<any | IError>;
 }

package/dist/system/systemApi.js

@@ -21,7 +21,6 @@ class SystemApi extends asyncModules_1.default {
      *
      * @return {any} The response from the server after fetching data from the '/test404' endpoint.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
-     *
      * @description This method is used to test the 404 error handling by sending a GET request to a specific endpoint.
      */
     async test404() {
@@ -35,7 +34,6 @@ class SystemApi extends asyncModules_1.default {
      *
      * @return {any} The response from the server after fetching data from the '/test500' endpoint.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
-     *
      * @description This method is used to test the 500 error handling by sending a GET request to a specific endpoint.
      */
     async test500() {
@@ -47,14 +45,17 @@ class SystemApi extends asyncModules_1.default {
      *
      * @handleName validateCapcha
      *
-     * @param {Object} event - The event object containing CAPTCHA data.
-     * @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...'.
-     *
+     * @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...".
      * @return {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.
      */
     async validateCapcha(event) {
@@ -64,5 +65,18 @@ class SystemApi extends asyncModules_1.default {
         const result = await this._fetchPost('/captcha/validate', data);
         return result;
     }
+    /**
+     * Getting the number of requests to API.
+     *
+     * @handleName getApiStat
+     *
+     * @return {any} Return object with date and count.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description Getting the number of requests to API.
+     */
+    async getApiStat() {
+        const result = await this._fetchGet('/api-stat');
+        return result;
+    }
 }
 exports.default = SystemApi;

package/dist/system/systemInterfaces.d.ts

@@ -3,7 +3,6 @@
  *
  * @property {function} test404 - Test 404 error.
  * @property {function} test500 - Test 500 error.
- *
  * @description Represents a interface object of System Api.
  */
 interface ISystem {

package/dist/templates/templatesApi.d.ts

@@ -20,38 +20,32 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
      * @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
+     * @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.
      */
-    getAllTemplates(langCode?: string): Promise<Record<Types, ITemplateEntity> | IError>;
+    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 {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.
+     * @return {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.
      */
-    getTemplateByType(type: Types, langCode?: string): Promise<Array<ITemplateEntity> | IError>;
+    getTemplateByType(type: Types, langCode?: string): Promise<ITemplateEntity[] | IError>;
     /**
      * Get one template object by marker.
      *
      * @handleName getTemplateByMarker
      *
-     * @param {number} marker - The unique marker of the template to retrieve. Example: 'template_12345'.
+     * @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
      * @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.
      */
     getTemplateByMarker(marker: string, langCode?: string): Promise<ITemplateEntity | IError>;

package/dist/templates/templatesApi.js

@@ -24,10 +24,8 @@ class TemplatesPreviewApi extends asyncModules_1.default {
      * @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
+     * @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) {
@@ -44,12 +42,10 @@ class TemplatesPreviewApi extends asyncModules_1.default {
      *
      * @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 {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.
+     * @return {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.
      */
     async getTemplateByType(type, langCode = this.state.lang) {
@@ -61,12 +57,10 @@ class TemplatesPreviewApi extends asyncModules_1.default {
      *
      * @handleName getTemplateByMarker
      *
-     * @param {number} marker - The unique marker of the template to retrieve. Example: 'template_12345'.
+     * @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
      * @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.
      */
     async getTemplateByMarker(marker, langCode = this.state.lang) {

package/dist/templates/templatesInterfaces.d.ts

@@ -13,27 +13,24 @@ 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
+     * @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>;
+    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 {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>;
+    getTemplateByType(type: Types, langCode: string): 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} 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.
      */
@@ -43,26 +40,29 @@ interface ITemplatesApi {
  * @interface ITemplateEntity
  *
  * @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 {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} title - The name of the template. Example: 'Product Template'.
+ * @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.
- * @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: .
- *
+    {
+      "id": 1,
+      "value": "some"
+    }
  * @description This interface defines the structure of a template entity, including its identifiers, attributes, and general type information.
  */
 interface ITemplateEntity {
     id: number;
-    version: number;
-    identifier: string;
-    generalTypeId: number;
+    attributeSetIdentifier: string | null;
     title: string;
-    position: number;
+    generalTypeId: number;
+    identifier: string;
+    version: number;
     generalTypeName: Types;
     attributeValues: AttributeType;
-    attributeSetIdentifier: string | null;
+    position: number;
 }
 export type { ITemplateEntity, ITemplatesApi };

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

@@ -19,24 +19,20 @@ export default class TemplatePreviewsApi extends AsyncModules implements ITempla
      * @handleName getTemplatePreviews
      *
      * @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>;
+    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} 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.
      * @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.
      */
     getTemplatePreviewByMarker(marker: string, langCode?: string): Promise<ITemplatesPreviewEntity | IError>;

package/dist/templates-preview/templatesPreviewApi.js

@@ -22,10 +22,8 @@ class TemplatePreviewsApi extends asyncModules_1.default {
      * @handleName getTemplatePreviews
      *
      * @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) {
@@ -37,12 +35,10 @@ class TemplatePreviewsApi extends asyncModules_1.default {
      *
      * @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} 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.
      * @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.
      */
     async getTemplatePreviewByMarker(marker, langCode = this.state.lang) {

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

@@ -13,17 +13,15 @@ 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>;
+    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'.
+     * @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.
      */
@@ -32,26 +30,54 @@ interface ITemplatesPreview {
 /**
  * @interface ITemplatesPreviewEntity
  *
- * @property {number} id - The unique identifier of the position. Example: 12345.
+ * @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 {string} identifier - The textual identifier for the record field. Example: "preview-templates"
  * @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 {AttributeType} attributeValues - Attribute values from index. Example: {}
  * @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: .
- *
+ * @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,
+      "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"
+    }
  * @description This interface defines the structure of a template preview entity, including its identifiers, attributes, proportions, and title.
  */
 interface ITemplatesPreviewEntity {
     id: number;
-    version: number;
-    identifier: string;
-    attributeValues: AttributeType;
-    attributeSetIdentifier?: string | null;
+    title: string;
     proportions: {
         default: {
             horizontal: IProportion | null;
@@ -59,18 +85,19 @@ interface ITemplatesPreviewEntity {
             square: ISquare;
         };
     };
-    title: string;
+    identifier: string;
+    version: number;
+    attributeValues: AttributeType;
     position: number;
     isUsed: boolean;
+    attributeSetIdentifier?: string | null;
 }
 /**
  * @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} alignmentType - alignment type of the template preview. Example: "center".
  * @description Represents a proportion object used in template previews.
  */
 interface IProportion {
@@ -81,10 +108,8 @@ interface IProportion {
 /**
  * @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'.
- *
+ * @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

@@ -17,11 +17,9 @@ export default class UsersApi extends AsyncModules implements IUsers {
      * @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.
-     *
-     * @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.
+     * @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>;
     /**
@@ -29,24 +27,50 @@ export default class UsersApi extends AsyncModules implements IUsers {
      *
      * @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 {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".
-     *
      * @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 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).
      *
-     * @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 archiveUser
      *
+     * @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 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.
      */
-    updateUser(body: IUserBody, langCode?: string): Promise<boolean | IError>;
+    archiveUser(): Promise<boolean | IError>;
     /**
-     * Delete a single user object.
+     * Delete a single user.
      *
      * @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>;
@@ -56,10 +80,8 @@ export default class UsersApi extends AsyncModules implements IUsers {
      * @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.
      * @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>;
@@ -69,10 +91,8 @@ export default class UsersApi extends AsyncModules implements IUsers {
      * @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.
      * @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>;