oneentry 1.0.128 → 1.0.131

package/README.md

@@ -97,6 +97,7 @@ const api = defineOneEntry('https://my-project.oneentry.cloud', {
     auth: {
         refreshToken: localStorage.getItem('refreshToken'),
         saveFunction: tokenFunction,
+        providerMarker: 'email',
     },
 })
 ```
@@ -110,6 +111,7 @@ const api = defineOneEntry('https://my-project.oneentry.cloud', {
     auth: {
         customAuth: true,
         refreshToken: localStorage.getItem('refreshToken'),
+        providerMarker: 'email',
     },
 })
 ```
@@ -147,6 +149,7 @@ const api = defineOneEntry('your-url', {
     auth: {
         customAuth: false,
         userToken: 'rerfesh.token',
+        providerMarker: 'email',
         saveFunction: saveTokenFromLocalStorage,
     },
 })

package/dist/admins/adminsApi.d.ts

@@ -23,7 +23,8 @@ export default class AdminsApi extends AsyncModules implements IAdmins {
     /**
      * Get all admins objects with filters.
      * @handleName getAdminsInfo
-     * @param {AttributeType[]} body - Array of filter objects with search conditions. Default: []. Example:
+     * @param {AttributeType[]} [body] - Array of filter objects with search conditions. Default: [].
+     * @example
         [
           {
             "attributeMarker": "num",
@@ -36,15 +37,14 @@ export default class AdminsApi extends AsyncModules implements IAdmins {
             "conditionValue": 3
           }
         ]
-     * @param {string} body.attributeMarker - Text identifier (marker) of the attribute in the set. Example: "num".
-     * @param {string} body.conditionMarker - Text identifier (marker) of the condition in the set. Example: "mth".
-     * @param {string} body.conditionValue - Value of the condition. Example: 1.
-     * @param {string} langCode - Language code. Default: "en_US".
-     * @param {number} offset - Parameter for pagination. Default: 0.
-     * @param {number} limit - Parameter for pagination. Default: 30.
+     * @param {string} [body.attributeMarker] - Text identifier (marker) of the attribute in the set. Example: "num".
+     * @param {string} [body.conditionMarker] - Text identifier (marker) of the condition in the set. Example: "mth".
+     * @param {string} [body.conditionValue] - Value of the condition. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {IAdminEntity[]} Returns an array of admin 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.
      */
     getAdminsInfo(body?: AttributeType[], langCode?: string, offset?: number, limit?: number): Promise<IAdminEntity[] | IError>;
 }

package/dist/admins/adminsApi.js

@@ -26,7 +26,8 @@ class AdminsApi extends asyncModules_1.default {
     /**
      * Get all admins objects with filters.
      * @handleName getAdminsInfo
-     * @param {AttributeType[]} body - Array of filter objects with search conditions. Default: []. Example:
+     * @param {AttributeType[]} [body] - Array of filter objects with search conditions. Default: [].
+     * @example
         [
           {
             "attributeMarker": "num",
@@ -39,15 +40,14 @@ class AdminsApi extends asyncModules_1.default {
             "conditionValue": 3
           }
         ]
-     * @param {string} body.attributeMarker - Text identifier (marker) of the attribute in the set. Example: "num".
-     * @param {string} body.conditionMarker - Text identifier (marker) of the condition in the set. Example: "mth".
-     * @param {string} body.conditionValue - Value of the condition. Example: 1.
-     * @param {string} langCode - Language code. Default: "en_US".
-     * @param {number} offset - Parameter for pagination. Default: 0.
-     * @param {number} limit - Parameter for pagination. Default: 30.
+     * @param {string} [body.attributeMarker] - Text identifier (marker) of the attribute in the set. Example: "num".
+     * @param {string} [body.conditionMarker] - Text identifier (marker) of the condition in the set. Example: "mth".
+     * @param {string} [body.conditionValue] - Value of the condition. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {IAdminEntity[]} Returns an array of admin 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.
      */
     async getAdminsInfo(body = [], langCode = this.state.lang, offset = 0, limit = 30) {
         const query = {

package/dist/admins/adminsInterfaces.d.ts

@@ -8,19 +8,20 @@ interface IAdmins {
     /**
      * Get all admins objects with filters.
      * @handleName getAdminsInfo
-     * @param {AttributeType[]} [body] - Array of filter objects with search conditions. Default: []. Example:
-       [
-       {
-       "attributeMarker": "num",
-       "conditionMarker": "mth",
-       "conditionValue": 1
-       },
-       {
-       "attributeMarker": "num",
-       "conditionMarker": "lth",
-       "conditionValue": 3
-       }
-       ]
+     * @param {AttributeType[]} [body] - Array of filter objects with search conditions. Default: [].
+     * @example
+        [
+          {
+            "attributeMarker": "num",
+            "conditionMarker": "mth",
+            "conditionValue": 1
+          },
+          {
+            "attributeMarker": "num",
+            "conditionMarker": "lth",
+            "conditionValue": 3
+          }
+        ]
      * @param {string} [body.attributeMarker] - Text identifier (marker) of the attribute in the set. Example: "num".
      * @param {string} [body.conditionMarker] - Text identifier (marker) of the condition in the set. Example: "mth".
      * @param {string} [body.conditionValue] - Value of the condition. Example: 1.
@@ -29,7 +30,6 @@ interface IAdmins {
      * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {IAdminEntity[]} Returns an array of admin 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.
      */
     getAdminsInfo(body: AttributeType[], langCode: string, offset: number, limit: number): Promise<IAdminEntity[] | IError>;
 }
@@ -61,7 +61,8 @@ interface IPosition {
  * @property {string | null} attributeSetIdentifier - The identifier of the attribute set. Example: "admins".
  * @property {number | null} position - Position number (for sorting). Example: 1.
  * @property {boolean} isSync - Page indexing flag (true or false). Example: true.
- * @property {IAttributeValues} attributeValues - Array of attribute values from the index (presented as a pair of user attribute identifier: attribute value). Example:
+ * @property {IAttributeValues} attributeValues - Array of attribute values from the index (presented as a pair of user attribute identifier: attribute value).
+ * @example
     [
       {
         "marker": {

package/dist/attribute-sets/attributeSetsApi.d.ts

@@ -30,7 +30,6 @@ export default class AttributesSetsApi extends AsyncModules implements IAttribut
      * @param {string} [sortBy] - identifier of the attribute set type. Default: "id".
      * @returns {IAttributesSetsResponse} Returns object with array of IAttributeSetsEntity and total items count.
      * @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.
      */
     getAttributes(langCode?: string, offset?: number, limit?: number, typeId?: any, sortBy?: string): Promise<IAttributesSetsResponse | IError>;
     /**
@@ -40,7 +39,6 @@ export default class AttributesSetsApi extends AsyncModules implements IAttribut
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IAttributeSetsEntity[]} Returns an array of Attributes 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.
      */
     getAttributesByMarker(marker: string, langCode?: string): Promise<IAttributeSetsEntity[] | IError>;
     /**
@@ -51,7 +49,6 @@ export default class AttributesSetsApi extends AsyncModules implements IAttribut
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IAttributesSetsEntity} Returns a single attribute object from the attribute set.
      * @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.
      */
     getSingleAttributeByMarkerSet(setMarker: string, attributeMarker: string, langCode?: string): Promise<IAttributesSetsEntity | IError>;
     /**
@@ -61,7 +58,6 @@ export default class AttributesSetsApi extends AsyncModules implements IAttribut
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IAttributeSetsEntity} Returns one object of the attribute set.
      * @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.
      */
     getAttributeSetByMarker(marker: string, langCode?: string): Promise<IAttributeSetsEntity | IError>;
 }

package/dist/attribute-sets/attributeSetsApi.js

@@ -33,7 +33,6 @@ class AttributesSetsApi extends asyncModules_1.default {
      * @param {string} [sortBy] - identifier of the attribute set type. Default: "id".
      * @returns {IAttributesSetsResponse} Returns object with array of IAttributeSetsEntity and total items count.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     async getAttributes(langCode = this.state.lang, offset = 0, limit = 30, 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -56,7 +55,6 @@ class AttributesSetsApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IAttributeSetsEntity[]} Returns an array of Attributes 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.
      */
     async getAttributesByMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/${marker}/attributes?langCode=${langCode}`);
@@ -70,7 +68,6 @@ class AttributesSetsApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IAttributesSetsEntity} Returns a single attribute object from the attribute set.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     async getSingleAttributeByMarkerSet(setMarker, attributeMarker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/${setMarker}/attributes/${attributeMarker}?langCode=${langCode}`);
@@ -83,7 +80,6 @@ class AttributesSetsApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IAttributeSetsEntity} Returns one object of the attribute set.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     async getAttributeSetByMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);

package/dist/attribute-sets/attributeSetsInterfaces.d.ts

@@ -62,33 +62,36 @@ type AttributeType = 'string' | 'text' | 'textWithHeader' | 'integer' | 'real' |
  * @property {any} [value] - Value of the attribute, which can be of any type.
  * @property {string} marker - Textual identifier of the attribute (marker). Example: "color", "size", "etc".
  * @property {number} position - Position number for sorting. Example: 1.
- * @property {IListTitle[] | Record<string, any>} [listTitles] - Array of values (with extended data) for list and radioButton attributes. Example:
-   [
-     {
-       "title": "red",
-       "value": 1,
-       "position": 1,
-       "extendedValue": null,
-       "extendedValueType": null
-     },
-     {
-       "title": "yellow",
-       "value": 2,
-       "position": 2,
-       "extendedValue": null,
-       "extendedValueType": null
-     }
-   ]
- * @property {Record<string, any>} [validators] - Set of validators for validation. Example:
-   {
-     "requiredValidator": {
-       "strict": true
-     },
-     "defaultValueValidator": {
-       "fieldDefaultValue": 11
-     }
-   }
- * @property {ILocalizeInfo} localizeInfos - The name of the template, taking into account localization. Example:
+ * @property {IListTitle[] | Record<string, any>} [listTitles] - Array of values (with extended data) for list and radioButton attributes.
+ * @example
+    [
+      {
+        "title": "red",
+        "value": 1,
+        "position": 1,
+        "extendedValue": null,
+        "extendedValueType": null
+      },
+      {
+        "title": "yellow",
+        "value": 2,
+        "position": 2,
+        "extendedValue": null,
+        "extendedValueType": null
+      }
+    ]
+ * @property {Record<string, any>} [validators] - Set of validators for validation.
+ * @example
+    {
+      "requiredValidator": {
+        "strict": true
+      },
+      "defaultValueValidator": {
+        "fieldDefaultValue": 11
+      }
+    }
+ * @property {ILocalizeInfo} localizeInfos - The name of the template, taking into account localization.
+ * @example
    {
      "title": "My attribute"
    }
@@ -116,7 +119,8 @@ interface IAttributesSetsEntity {
  * @property {string} identifier - A string that uniquely identifies the attribute set. Example: "attributeSet1".
  * @property {number} typeId - The numerical identifier representing the type of the attribute set. Example: 1.
  * @property {string} title - The title or name of the attribute set. Example: "Product Attributes".
- * @property {object} schema - The schema definition associated with the attribute set. This could represent the structure or rules for the data. Example:
+ * @property {object} schema - The schema definition associated with the attribute set. This could represent the structure or rules for the data.
+ * @example
    {
      "attribute1": {
        "id": 1,
@@ -130,7 +134,8 @@ interface IAttributesSetsEntity {
      }
    }
  * @property {boolean} isVisible - Indicates whether the attribute set is visible or not. Example: true.
- * @property {object} properties - Additional properties associated with the attribute set, which can be of any type. Example:
+ * @property {object} properties - Additional properties associated with the attribute set, which can be of any type.
+ * @example
    {
      "color": "red",
      "size": "M"
@@ -141,6 +146,7 @@ interface IAttributesSetsEntity {
  */
 interface IAttributeSetsEntity {
     id: number;
+    createdDate: string;
     updatedDate: string;
     version: number;
     identifier: string;
@@ -149,15 +155,19 @@ interface IAttributeSetsEntity {
     schema: object;
     isVisible: boolean;
     properties: object;
-    type: string;
+    type: {
+        id: number;
+        type: string;
+    };
     position: number;
 }
 /**
  * Represents the response structure for attribute sets.
  * @interface IAttributesSetsResponse
  * @property {number} total - Total items. Example: 100.
- * @property {IAttributeSetsEntity[]} items - IAttributeSetsEntity array containing attribute set entities. Example:
-   [
+ * @property {IAttributeSetsEntity[]} items - IAttributeSetsEntity array containing attribute set entities.
+ * @example
+    [
      {
        "id": 1,
        "identifier": "set1"

package/dist/auth-provider/authProviderApi.d.ts

@@ -21,7 +21,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
      * User registration.
      * @handleName signUp
      * @param {string} marker - The text identifier of the authorization provider. Example: "email".
-     * @param {ISignUpData} body - Request body. Example:
+     * @param {ISignUpData} body - Request body.
+     * @example
         {
           "formIdentifier": "reg",
           "authData": [
@@ -48,7 +49,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
           }
         }
      * @param {string} body.formIdentifier - The identifier for the registration form. Example: "reg".
-     * @param {{ marker: string; value: string }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value. Example:
+     * @param {{ marker: string; value: string }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value.
+     * @example
         [
           {
             "marker": "login",
@@ -59,13 +61,15 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
             "value": "12345"
           }
         ]
-     * @param {IAuthFormData} body.formData - The form data for the registration, which can be a single object or an array of objects. Example:
+     * @param {IAuthFormData} body.formData - The form data for the registration, which can be a single object or an array of objects.
+     * @example
         {
           "marker": "last_name",
           "type": "string",
           "value": "Name"
         }
-     * @param {object} body.notificationData - An object containing notification data, including email, phonePush, and phoneSMS. Example:
+     * @param {object} body.notificationData - An object containing notification data, including email, phonePush, and phoneSMS.
+     * @example
         {
           "email": "example@oneentry.cloud",
           "phonePush": ["+99999999999"],
@@ -115,7 +119,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
      * User authorization.
      * @handleName auth
      * @param {string} marker - The text identifier of the authorization provider. Example: "email".
-     * @param {IAuthPostBody} body - Objects contains auth information. Example:
+     * @param {IAuthPostBody} body - Objects contains auth information.
+     * @example
         {
           "authData": [
             {
@@ -128,7 +133,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
             }
           ]
         }
-     * @param {{ marker: string; value: string | number }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value. Example:
+     * @param {{ marker: string; value: string | number }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value.
+     * @example
         [
           {
             "marker": "login",
@@ -159,7 +165,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
      * @param {string} token - Refresh token. Example: "abcdef123456".
      * @returns {boolean} Returns true if the logout was successful, or an error object if there was an issue.
      * @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 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}.
      */
     logout(marker: string, token: string): Promise<boolean | IError>;
     /**
@@ -168,7 +175,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
      * @param {string} marker - The text identifier of the authorization provider. Example: "email".
      * @returns {boolean} Returns true if the logout was successful, or an error object if there was an issue.
      * @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 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}.
      */
     logoutAll(marker: string): Promise<boolean | IError>;
     /**
@@ -209,7 +217,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
     getAuthProviderByMarker(marker: string, langCode?: string): Promise<IAuthProvidersEntity | IError>;
     /**
      * Getting active user sessions data.
-     * @handleName getActiveSessions
+     * @handleName getActiveSessionsByMarker
      * @param {string} marker - The text identifier of the authorization provider. Example: "email".
      * @returns {IActiveSession[]} Returns an auth provider object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -220,7 +228,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
      * User registration (authorization) via OAUTH.
      * @handleName oauthSignUp
      * @param {string} marker - The text identifier of the authorization provider. Example: "email".
-     * @param {IOAuthSignUpData} body - Object contains OAuth information for registration. Example:
+     * @param {IOAuthSignUpData} body - Object contains OAuth information for registration.
+     * @example
         {
           "client_id": "34346983-luuct343473qdkqidjopdfp3eb3k4thp.apps.googleusercontent.com",
           "client_secret": "43434343434",

package/dist/auth-provider/authProviderApi.js

@@ -25,7 +25,8 @@ class AuthProviderApi extends asyncModules_1.default {
      * User registration.
      * @handleName signUp
      * @param {string} marker - The text identifier of the authorization provider. Example: "email".
-     * @param {ISignUpData} body - Request body. Example:
+     * @param {ISignUpData} body - Request body.
+     * @example
         {
           "formIdentifier": "reg",
           "authData": [
@@ -52,7 +53,8 @@ class AuthProviderApi extends asyncModules_1.default {
           }
         }
      * @param {string} body.formIdentifier - The identifier for the registration form. Example: "reg".
-     * @param {{ marker: string; value: string }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value. Example:
+     * @param {{ marker: string; value: string }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value.
+     * @example
         [
           {
             "marker": "login",
@@ -63,13 +65,15 @@ class AuthProviderApi extends asyncModules_1.default {
             "value": "12345"
           }
         ]
-     * @param {IAuthFormData} body.formData - The form data for the registration, which can be a single object or an array of objects. Example:
+     * @param {IAuthFormData} body.formData - The form data for the registration, which can be a single object or an array of objects.
+     * @example
         {
           "marker": "last_name",
           "type": "string",
           "value": "Name"
         }
-     * @param {object} body.notificationData - An object containing notification data, including email, phonePush, and phoneSMS. Example:
+     * @param {object} body.notificationData - An object containing notification data, including email, phonePush, and phoneSMS.
+     * @example
         {
           "email": "example@oneentry.cloud",
           "phonePush": ["+99999999999"],
@@ -145,7 +149,8 @@ class AuthProviderApi extends asyncModules_1.default {
      * User authorization.
      * @handleName auth
      * @param {string} marker - The text identifier of the authorization provider. Example: "email".
-     * @param {IAuthPostBody} body - Objects contains auth information. Example:
+     * @param {IAuthPostBody} body - Objects contains auth information.
+     * @example
         {
           "authData": [
             {
@@ -158,7 +163,8 @@ class AuthProviderApi extends asyncModules_1.default {
             }
           ]
         }
-     * @param {{ marker: string; value: string | number }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value. Example:
+     * @param {{ marker: string; value: string | number }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value.
+     * @example
         [
           {
             "marker": "login",
@@ -207,7 +213,8 @@ class AuthProviderApi extends asyncModules_1.default {
      * @param {string} token - Refresh token. Example: "abcdef123456".
      * @returns {boolean} Returns true if the logout was successful, or an error object if there was an issue.
      * @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 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 logout(marker, token) {
         const data = {
@@ -229,7 +236,8 @@ class AuthProviderApi extends asyncModules_1.default {
      * @param {string} marker - The text identifier of the authorization provider. Example: "email".
      * @returns {boolean} Returns true if the logout was successful, or an error object if there was an issue.
      * @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 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 logoutAll(marker) {
         const result = await this._fetchPost(`/marker/${marker}/users/logout-all`);
@@ -297,7 +305,7 @@ class AuthProviderApi extends asyncModules_1.default {
     }
     /**
      * Getting active user sessions data.
-     * @handleName getActiveSessions
+     * @handleName getActiveSessionsByMarker
      * @param {string} marker - The text identifier of the authorization provider. Example: "email".
      * @returns {IActiveSession[]} Returns an auth provider object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -311,7 +319,8 @@ class AuthProviderApi extends asyncModules_1.default {
      * User registration (authorization) via OAUTH.
      * @handleName oauthSignUp
      * @param {string} marker - The text identifier of the authorization provider. Example: "email".
-     * @param {IOAuthSignUpData} body - Object contains OAuth information for registration. Example:
+     * @param {IOAuthSignUpData} body - Object contains OAuth information for registration.
+     * @example
         {
           "client_id": "34346983-luuct343473qdkqidjopdfp3eb3k4thp.apps.googleusercontent.com",
           "client_secret": "43434343434",

package/dist/auth-provider/authProvidersInterfaces.d.ts

@@ -21,7 +21,8 @@ interface IAuthProvider {
      * Registers a new user.
      * @handleName signUp
      * @param {string} marker - The marker identifying the auth provider. Example: "email".
-     * @param {ISignUpData} data - The data required for user registration. Example:
+     * @param {ISignUpData} data - The data required for user registration.
+     * @example
         {
           "formIdentifier": "reg",
           "authData": [
@@ -175,7 +176,8 @@ interface IAuthProvider {
      * User registration (authorization) via OAUTH.
      * @handleName oauthSignUp
      * @param {string} marker - The text identifier of the authorization provider. Example: "email".
-     * @param {IOAuthSignUpData} body - Object contains OAuth information for registration. Example:
+     * @param {IOAuthSignUpData} body - Object contains OAuth information for registration.
+     * @example
         {
           "client_id": "34346983-luuct343473qdkqidjopdfp3eb3k4thp.apps.googleusercontent.com",
           "client_secret": "43434343434",
@@ -207,7 +209,8 @@ interface IAuthFormData {
  * Interface representing the data required for user registration.
  * @interface ISignUpData
  * @property {string} marker - The text identifier of the authorization provider. Example: "email".
- * @property {ISignUpData} body - Request body. Example:
+ * @property {ISignUpData} body - Request body.
+ * @example
     {
       "formIdentifier": "reg",
       "authData": [
@@ -234,7 +237,8 @@ interface IAuthFormData {
       }
     }
  * @property {string} body.formIdentifier - The identifier for the registration form. Example: "reg".
- * @property {{ marker: string; value: string }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value. Example:
+ * @property {{ marker: string; value: string }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value.
+ * @example
     [
       {
         "marker": "login",
@@ -245,13 +249,15 @@ interface IAuthFormData {
         "value": "12345"
       }
     ]
- * @property {IAuthFormData | IAuthFormData[]} body.formData - The form data for the registration, which can be a single object or an array of objects. Example:
+ * @property {IAuthFormData | IAuthFormData[]} body.formData - The form data for the registration, which can be a single object or an array of objects.
+ * @example
     {
       "marker": "last_name",
       "type": "string",
       "value": "Name"
     }
- * @property {object} body.notificationData - An object containing notification data, including email, phonePush, and phoneSMS. Example:
+ * @property {object} body.notificationData - An object containing notification data, including email, phonePush, and phoneSMS.
+ * @example
     {
       "email": "example@oneentry.cloud",
       "phonePush": ["+99999999999"],
@@ -299,7 +305,8 @@ interface IOAuthSignUpData {
  * @property {number} version - The version number of the sign-up entity. Example: 1.
  * @property {string} identifier - A unique string that identifies the sign-up entity. Example: "signup_12345".
  * @property {boolean} isActive - Indicates whether the sign-up entity is active. Example: true.
- * @property {{ marker: string; value: string }[]} formData - An array of objects representing the form data, each containing a marker and its corresponding value. Example:
+ * @property {{ marker: string; value: string }[]} formData - An array of objects representing the form data, each containing a marker and its corresponding value.
+ * @example
     [
       {
         "marker": "first_name",
@@ -310,7 +317,8 @@ interface IOAuthSignUpData {
         "value": "Doe"
       }
     ]
- * @property {object} notificationData - An object containing notification data, including email, phonePush, and phoneSMS. Example:
+ * @property {object} notificationData - An object containing notification data, including email, phonePush, and phoneSMS.
+ * @example
     {
       "email": "example@oneentry.cloud",
       "phonePush": ["+99999999999"],
@@ -410,7 +418,8 @@ interface IAuthProvidersEntityConfig {
 /**
  * Interface representing the body used in authentication requests.
  * @interface IAuthPostBody
- * @property {{ marker: string; value: string | number }[]} authData - An array of authentication data objects, each containing a marker and its corresponding value. Example:
+ * @property {{ marker: string; value: string | number }[]} authData - An array of authentication data objects, each containing a marker and its corresponding value.
+ * @example
     [
       {
         "marker": "login",
@@ -428,9 +437,16 @@ interface IAuthPostBody {
 /**
  * Interface representing the active session data.
  * @interface IActiveSession
- * @property {string} os - The operating system of the active session. Example: "Win32".
- * @property {string} browser - The browser used in the active session. Example: "Node.js/22".
- * @property {string} location - The location of the active session. Example: "ru-RU".
+ * @property {object} deviceInfo - Information about the device used in the active session.
+ * @example
+    {
+      "os": "Win32",
+      "browser": "Node.js/22",
+      "location": "ru-RU"
+    }
+ * @property {string} deviceInfo.os - The operating system of the active session. Example: "Win32".
+ * @property {string} deviceInfo.browser - The browser used in the active session. Example: "Node.js/22".
+ * @property {string} deviceInfo.location - The location of the active session. Example: "ru-RU".
  * @description This interface defines the structure of the body used in authentication requests, containing an array of authentication data.
  */
 interface IActiveSession {