oneentry 1.0.130 → 1.0.131

package/dist/products/productsInterfaces.d.ts

@@ -21,7 +21,8 @@ interface IProductApi {
     /**
      * Search for all products with pagination and filter.
      * @handleName getProducts
-     * @param {IFilterParams[]} [body] - Request body. Default []. Example:
+     * @param {IFilterParams[]} [body] - Request body. Default [].
+     * @example
         [
           {
             "attributeMarker": "price",
@@ -46,7 +47,8 @@ interface IProductApi {
           }
         ]
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -60,14 +62,14 @@ interface IProductApi {
         }
      * @returns {IProductsResponse} Array with ProductEntity objects
      * @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.
      */
     getProducts(body?: IFilterParams[], langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
     /**
      * Search for all product page objects with pagination that do not have a category.
      * @handleName getProductsEmptyPage
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -90,7 +92,8 @@ interface IProductApi {
      * @param {number} id - Page id. Example: 12345.
      * @param {IFilterParams[]} [body] - Request body. Default: [].
      * @param {string} [langCode] - Language code. Default "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -112,7 +115,8 @@ interface IProductApi {
      * @handleName getProductsPriceByPageUrl
      * @param {string} [url] - Page url. Example: "23-laminat-floorwood-maxima".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -135,7 +139,8 @@ interface IProductApi {
      * @param {string} url - Page url. Example: "23-laminat-floorwood-maxima".
      * @param {IFilterParams[]} [body] - Request body. Default: [].
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -157,7 +162,8 @@ interface IProductApi {
      * @handleName getRelatedProductsById
      * @param {number} [id] - Product page identifier for which to find relationship. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -177,9 +183,10 @@ interface IProductApi {
     /**
      * Find products by its ids.
      * @handleName getProductsByIds
-     * @param {string} [ids] - Product page identifiers for which to find relationships. Example: "12345,67890".
+     * @param {string} ids - Product page identifiers for which to find relationships. Example: "12345,67890".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @example
         {
           "limit": 30,
           "offset": 0,
@@ -228,7 +235,8 @@ interface IProductApi {
     /**
      * Getting the number of products for the entire catalog.
      * @handleName getProductsCount
-     * @param {string} [body] - Body parameters for filter. Deault: []. Example:
+     * @param {string} [body] - Body parameters for filter. Deault: [].
+     * @example
         [
           {
             "attributeMarker": "price",
@@ -260,7 +268,8 @@ interface IProductApi {
      * Getting the number of products on a catalog page by page ID.
      * @handleName getProductsCountByPageId
      * @param {string} id - Page id. Example: 12345.
-     * @param {string} body - Body parameters for filter. Deault: []. Example:
+     * @param {string} body - Body parameters for filter. Deault: [].
+     * @example
         [
           {
             "attributeMarker": "price",
@@ -292,7 +301,8 @@ interface IProductApi {
      * Getting the number of products on a catalog page by page URL.
      * @handleName getProductsCountByPageUrl
      * @param {string} url - Page url. Example: "catalog".
-     * @param {string} body - Body parameters for filter. Deault: []. Example:
+     * @param {string} body - Body parameters for filter. Deault: [].
+     * @example
         [
           {
             "attributeMarker": "price",
@@ -377,7 +387,8 @@ interface IFilterParams {
  * @property {string | null} [templateIdentifier] - User id of the linked template. Example: "template_12345".
  * @property {string | null} [shortDescTemplateIdentifier] - User id of the linked template for a short description. Example: "short_desc_template_12345".
  * @property {number} price - The value of the product page price taken from the index. Example: 150.00.
- * @property {object} additional - Additional value from the index. Example:
+ * @property {object} additional - Additional value from the index.
+ * @example
     {
       "en": "In Stock",
       "de": "Auf Lager"
@@ -433,7 +444,8 @@ interface IProductsEntity {
 /**
  * @interface IProductsResponse
  * @property {number} total - The total number of products found. Example: 100.
- * @property {IProductsEntity[]} items - An array of product entities. Example:
+ * @property {IProductsEntity[]} items - An array of product entities.
+ * @example
     [
       {
         "id": 12345,
@@ -465,7 +477,8 @@ interface IProductsCount {
 /**
  * @interface IProductsInfo
  * @property {number} total - The total number of products found. Example: 100.
- * @property {IProductInfo[]} items - An array of product information objects. Example:
+ * @property {IProductInfo[]} items - An array of product information objects.
+ * @example
     [
       {
         "id": 12345,
@@ -496,7 +509,8 @@ interface IProductInfo {
  * @interface IProductBlock
  * @property {number} id - Unique identifier of the product block. Example: 3289.
  * @property {number | null} attributeSetIdentifier - Identifier of the attribute set used in the product block, or null if not applicable. Example: 67890.
- * @property {ILocalizeInfo} localizeInfos - Localization information for the product block. Example:
+ * @property {ILocalizeInfo} localizeInfos - Localization information for the product block.
+ * @example
     {
       "title": "Box"
     }
@@ -508,7 +522,8 @@ interface IProductInfo {
  * @property {string | null} templateIdentifier - Identifier for the template used by the product block, or null if not applicable. Example: "template_12345".
  * @property {boolean} isVisible - Indicates whether the product block is visible. Example: true.
  * @property {boolean} isSync - Indicates whether the product block is synchronized. Example: false.
- * @property {AttributeType} attributeValues - Array of attribute values from the index, represented as a pair of user attribute id and attribute value. Example:
+ * @property {AttributeType} attributeValues - Array of attribute values from the index, represented as a pair of user attribute id and attribute value.
+ * @example
     [
       {
         "id": "color",

package/dist/system/systemApi.d.ts

@@ -35,7 +35,8 @@ 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:
+     * @param {object} event - The event object containing CAPTCHA data.
+     * @example
         {
           "token": "03AGdBq24...",
           "expectedAction": "login",

package/dist/system/systemApi.js

@@ -46,7 +46,8 @@ 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:
+     * @param {object} event - The event object containing CAPTCHA data.
+     * @example
         {
           "token": "03AGdBq24...",
           "expectedAction": "login",

package/dist/templates/templatesInterfaces.d.ts

@@ -47,12 +47,13 @@ interface ITemplatesApi {
  * @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 {AttributeType} attributeValues - Attribute values from the index (represented as a pair of user attribute id: attribute value).
+ * @example
     {
       "id": 1,
       "value": "some"
     }
+ * @property {number} position - The position of the object. Example: 1.
  * @description This interface defines the structure of a template entity, including its identifiers, attributes, and general type information.
  */
 interface ITemplateEntity {

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

@@ -29,7 +29,8 @@ interface ITemplatesPreview {
  * @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:
+ * @property {object} proportions - Object contains info by proportions template preview.
+ * @example
     {
       "default": {
         "horizontal": {
@@ -48,19 +49,22 @@ interface ITemplatesPreview {
         }
       }
     }
- * @property {IProportion | null} proportions.horizontal - Horizontal proportion of the template preview. Example:
+ * @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:
+ * @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:
+ * @property {ISquare} proportions.square - Square proportion of the template preview.
+ * @example
     {
       "side": 3,
       "alignmentType": "leftTop"

package/dist/users/usersApi.d.ts

@@ -22,13 +22,15 @@ export default class UsersApi extends AsyncModules implements IUsers {
      * @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.
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider 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:
+     * @param {IUserBody} body - Request body.
+     * @example
         {
           "formIdentifier": "reg",
           "authData": [
@@ -52,7 +54,8 @@ export default class UsersApi extends AsyncModules implements IUsers {
      * @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.
+     * @description This method updates the user's data. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     updateUser(body: IUserBody, langCode?: string): Promise<boolean | IError>;
     /**
@@ -60,7 +63,8 @@ export default class UsersApi extends AsyncModules implements IUsers {
      * @handleName archiveUser
      * @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.
+     * @description This method archives a user object (marks it for deletion). This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     archiveUser(): Promise<boolean | IError>;
     /**
@@ -68,7 +72,8 @@ export default class UsersApi extends AsyncModules implements IUsers {
      * @handleName deleteUser
      * @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.
+     * @description This method deletes the user from the system. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     deleteUser(): Promise<boolean | IError>;
     /**
@@ -77,7 +82,8 @@ export default class UsersApi extends AsyncModules implements IUsers {
      * @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.
+     * @description This method adds an FCM token for sending push notifications. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     addFCMToken(token: string): Promise<boolean | IError>;
     /**
@@ -86,7 +92,8 @@ export default class UsersApi extends AsyncModules implements IUsers {
      * @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.
+     * @description This method deletes an existing FCM token. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     deleteFCMToken(token: string): Promise<boolean | IError>;
 }

package/dist/users/usersApi.js

@@ -25,7 +25,8 @@ class UsersApi extends asyncModules_1.default {
      * @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.
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     async getUser(langCode = this.state.lang) {
         const result = await this._fetchGet(`/me?langCode=${langCode}`);
@@ -34,7 +35,8 @@ class UsersApi extends asyncModules_1.default {
     /**
      * Updating a single user object.
      * @handleName updateUser
-     * @param {IUserBody} body - Request body. Example:
+     * @param {IUserBody} body - Request body.
+     * @example
         {
           "formIdentifier": "reg",
           "authData": [
@@ -58,7 +60,8 @@ class UsersApi extends asyncModules_1.default {
      * @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.
+     * @description This method updates the user's data. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     async updateUser(body, langCode = this.state.lang) {
         if (!('langCode' in body))
@@ -75,7 +78,8 @@ class UsersApi extends asyncModules_1.default {
      * @handleName archiveUser
      * @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.
+     * @description This method archives a user object (marks it for deletion). This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     async archiveUser() {
         const result = await this._fetchDelete('/me');
@@ -86,7 +90,8 @@ class UsersApi extends asyncModules_1.default {
      * @handleName deleteUser
      * @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.
+     * @description This method deletes the user from the system. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     async deleteUser() {
         const result = await this._fetchDelete('/me/account');
@@ -98,7 +103,8 @@ class UsersApi extends asyncModules_1.default {
      * @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.
+     * @description This method adds an FCM token for sending push notifications. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     async addFCMToken(token) {
         const result = await this._fetchPost(`/me/fcm-token/${token}`);
@@ -110,7 +116,8 @@ class UsersApi extends asyncModules_1.default {
      * @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.
+     * @description This method deletes an existing FCM token. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     async deleteFCMToken(token) {
         const result = await this._fetchDelete(`/me/fcm-token/${token}`);

package/dist/users/usersInterfaces.d.ts

@@ -20,13 +20,15 @@ interface IUsers {
      * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
      * @returns {IUserEntity} A promise resolving to the user entity or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method retrieves the data of an authorized user.
+     * @description This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     getUser(langCode?: string): Promise<IUserEntity | IError>;
     /**
      * Updates the user's data.
      * @handleName updateUser
-     * @param {IUserBody} data - The new data for the user. Example:
+     * @param {IUserBody} data - The new data for the user.
+     * @example
         {
           "formIdentifier": "reg",
           "authData": [
@@ -50,7 +52,8 @@ interface IUsers {
      * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
      * @returns {boolean} A promise resolving to true if successful, or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method updates the user's data.
+     * @description This method updates the user's data. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     updateUser(data: IUserBody, langCode?: string): Promise<boolean | IError>;
     /**
@@ -58,7 +61,8 @@ interface IUsers {
      * @handleName archiveUser
      * @returns {boolean} A promise resolving to true if successful, or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method archives a user object (marks it for deletion).
+     * @description This method archives a user object (marks it for deletion). This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     archiveUser(): Promise<boolean | IError>;
     /**
@@ -66,7 +70,8 @@ interface IUsers {
      * @handleName deleteUser
      * @returns {boolean} A promise resolving to true if successful, or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method deletes the user from the system.
+     * @description This method deletes the user from the system. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     deleteUser(): Promise<boolean | IError>;
     /**
@@ -75,7 +80,8 @@ interface IUsers {
      * @param {string} token - The FCM token to be added. Example: "fcm_token_1234567890abcdefg".
      * @returns {boolean} A promise resolving to true if successful, or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method adds an FCM token for sending push notifications.
+     * @description This method adds an FCM token for sending push notifications. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     addFCMToken(token: string): Promise<boolean | IError>;
     /**
@@ -84,7 +90,8 @@ interface IUsers {
      * @param {string} token - The FCM token to be deleted. Example: "fcm_token_1234567890abcdefg".
      * @returns {boolean} A promise resolving to true if successful, or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method deletes an existing FCM token.
+     * @description This method deletes an existing FCM token. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     deleteFCMToken(token: string): Promise<boolean | IError>;
 }
@@ -93,7 +100,8 @@ interface IUsers {
  * @property {number} id - Object identifier. Example: 12345.
  * @property {string} identifier - Text identifier for record field. Example: "user_12345".
  * @property {string} authProviderIdentifier - Text identifier of the authentication provider. Example: "auth_provider_12345".
- * @property {FormDataType[]} formData - Array of data form objects with the following values. Example:
+ * @property {FormDataType[]} formData - Array of data form objects with the following values.
+ * @example
     [
       {
         "marker": "last_name",
@@ -112,6 +120,7 @@ interface IUserEntity {
     authProviderIdentifier: string;
     formData: FormDataType[];
     formIdentifier: string;
+    total: string;
     groups: Array<string | number>;
     state: Record<string, any>;
     moduleFormConfigs: IFormConfig;
@@ -120,14 +129,16 @@ interface IUserEntity {
  * @interface IUserBody
  * @property {string} formIdentifier - Text identifier of the form. Example: "form_12345".
  * @property {string} [langCode] - Language code for localization. Default: "en_US".
- * @property {{ marker: string; value: string }[]} [authData] - Array of authentication data objects with markers and values. Example:
+ * @property {{ marker: string; value: string }[]} [authData] - Array of authentication data objects with markers and values.
+ * @example
     [
       {
         "marker": "password",
         "value": "12345"
       }
     ]
- * @property {IAuthFormData | IAuthFormData[]} [formData] - Form data object or array of form data objects. Example:
+ * @property {IAuthFormData | IAuthFormData[]} [formData] - Form data object or array of form data objects.
+ * @example
     [
       {
         "marker": "first_name",
@@ -140,7 +151,8 @@ interface IUserEntity {
         "value": "Doe"
       }
     ]
- * @property {object} [notificationData] - Object containing notification data, including email and phone information. Example:
+ * @property {object} [notificationData] - Object containing notification data, including email and phone information.
+ * @example
     {
       "email": "example@oneentry.cloud",
       "phonePush": ["+99999999999"],

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

@@ -15,10 +15,11 @@ export default class WsApi extends AsyncModules implements IWS {
      */
     constructor(state: StateModule);
     /**
-     * Creates an instance of an object Socket.io with a connection. This method requires user authorization.
+     * Creates an instance of an object Socket.io with a connection.
      * @handleName connect
      * @returns {Socket} Returns a Socket instance.
      * @description Creates an instance of an object Socket.io with a connection. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     connect(): Socket;
 }

package/dist/web-socket/wsApi.js

@@ -19,10 +19,11 @@ class WsApi extends asyncModules_1.default {
         this._url = state.url + '/api/content/ws';
     }
     /**
-     * Creates an instance of an object Socket.io with a connection. This method requires user authorization.
+     * Creates an instance of an object Socket.io with a connection.
      * @handleName connect
      * @returns {Socket} Returns a Socket instance.
      * @description Creates an instance of an object Socket.io with a connection. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     connect() {
         if (!this.state.accessToken) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.130",
+  "version": "1.0.131",
   "description": "OneEntry NPM package",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",