oneentry 1.0.126 → 1.0.127

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

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

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

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