oneentry 1.0.127 → 1.0.128

package/dist/auth-provider/authProviderApi.js

@@ -24,59 +24,59 @@ 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:
-                                                                            {
-                                                                            "formIdentifier": "reg",
-                                                                            "authData": [
-                                                                            {
-                                                                            "marker": "login",
-                                                                            "value": "example@oneentry.cloud"
-                                                                            },
-                                                                            {
-                                                                            "marker": "password",
-                                                                            "value": "12345"
-                                                                            }
-                                                                            ],
-                                                                            "formData": [
-                                                                            {
-                                                                            "marker": "last_name",
-                                                                            "type": "string",
-                                                                            "value": "Name"
-                                                                            }
-                                                                            ],
-                                                                            "notificationData": {
-                                                                            "email": "example@oneentry.cloud",
-                                                                            "phonePush": ["+99999999999"],
-                                                                            "phoneSMS": "+99999999999"
-                                                                            }
-                                                                            }
-     * @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:
-                                                                            [
-                                                                            {
-                                                                            "marker": "login",
-                                                                            "value": "example@oneentry.cloud"
-                                                                            },
-                                                                            {
-                                                                            "marker": "password",
-                                                                            "value": "12345"
-                                                                            }
-                                                                            ]
-     * @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:
-                                                                            {
-                                                                            "email": "example@oneentry.cloud",
-                                                                            "phonePush": ["+99999999999"],
-                                                                            "phoneSMS": "+99999999999"
-                                                                            }
-     * @param   {string}                              [langCode]            - Language code. Default: "en_US".
-     * @returns {ISignUpEntity}                                             Returns a user object.
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {ISignUpData} body - Request body. Example:
+        {
+          "formIdentifier": "reg",
+          "authData": [
+            {
+            "marker": "login",
+            "value": "example@oneentry.cloud"
+            },
+            {
+            "marker": "password",
+            "value": "12345"
+            }
+          ],
+          "formData": [
+            {
+            "marker": "last_name",
+            "type": "string",
+            "value": "Name"
+            }
+          ],
+          "notificationData": {
+            "email": "example@oneentry.cloud",
+            "phonePush": ["+99999999999"],
+            "phoneSMS": "+99999999999"
+          }
+        }
+     * @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:
+        [
+          {
+            "marker": "login",
+            "value": "example@oneentry.cloud"
+          },
+          {
+            "marker": "password",
+            "value": "12345"
+          }
+        ]
+     * @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:
+        {
+          "email": "example@oneentry.cloud",
+          "phonePush": ["+99999999999"],
+          "phoneSMS": "+99999999999"
+        }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {ISignUpEntity} Returns a user object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description User registration (❗️For a provider with user activation, the activation code is sent through the corresponding user notification method).
      */
@@ -88,10 +88,10 @@ class AuthProviderApi extends asyncModules_1.default {
     /**
      * Getting a user activation code. The code is returned via the appropriate user notification method.
      * @handleName generateCode
-     * @param   {string} marker          - The text identifier of the authorization provider. Example: "email".
-     * @param   {string} userIdentifier  - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
-     * @param   {string} eventIdentifier - Text identifier of the event object for which the code is generated. Example: "user_registration".
-     * @returns {void}                   Returns void if the code is successfully generated, or an error object if there was an issue.
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
+     * @param {string} eventIdentifier - Text identifier of the event object for which the code is generated. Example: "user_registration".
+     * @returns {void} Returns void if the code is successfully generated, 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 Obtaining a code to activate the user.
      */
@@ -106,11 +106,11 @@ class AuthProviderApi extends asyncModules_1.default {
     /**
      * User activation code verification. Returns true (if the code is correct) or false (if it is incorrect).
      * @handleName checkCode
-     * @param   {string}  marker          - The text identifier of the authorization provider. Example: "email".
-     * @param   {string}  userIdentifier  - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
-     * @param   {string}  eventIdentifier - Text identifier of the event object for which the code is generated. Example: "user_registration".
-     * @param   {string}  code            - Service code. Example: "123456".
-     * @returns {boolean}                 Returns true if the code is correct, or an error object if there was an issue.
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} userIdentifier  - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
+     * @param {string} eventIdentifier - Text identifier of the event object for which the code is generated. Example: "user_registration".
+     * @param {string} code - Service code. Example: "123456".
+     * @returns {boolean} Returns true if the code is correct, 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 Checking the user activation code
      */
@@ -126,10 +126,10 @@ class AuthProviderApi extends asyncModules_1.default {
     /**
      * User activate.
      * @handleName activateUser
-     * @param   {string}  marker         - The text identifier of the authorization provider. Example: "email".
-     * @param   {string}  userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
-     * @param   {string}  code           - Service code. Example: "123456".
-     * @returns {boolean}                Returns true if the user was successfully activated, or an error object if there was an issue.
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
+     * @param {string} code - Service code. Example: "123456".
+     * @returns {boolean} Returns true if the user was successfully activated, 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 User activation.
      */
@@ -144,30 +144,30 @@ 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:
-                                                                                           {
-                                                                                           "authData": [
-                                                                                           {
-                                                                                           "marker": "login",
-                                                                                           "value": "example@oneentry.cloud"
-                                                                                           },
-                                                                                           {
-                                                                                           "marker": "password",
-                                                                                           "value": "12345"
-                                                                                           }
-                                                                                           ]
-                                                                                           }
-     * @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",
-                                                                                           "value": "user@example.com"
-                                                                                           }
-                                                                                           ]
-     * @param   {string}                                       body.authData[index].marker - The marker for the authentication data. Example: "login".
-     * @param   {string}                                       body.authData[index].value  - The value for the authentication data. Example: "user@example.com".
-     * @returns {IAuthEntity}                                                              Returns an auth entity object.
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {IAuthPostBody} body - Objects contains auth information. Example:
+        {
+          "authData": [
+            {
+            "marker": "login",
+            "value": "example@oneentry.cloud"
+            },
+            {
+            "marker": "password",
+            "value": "12345"
+            }
+          ]
+        }
+     * @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",
+            "value": "user@example.com"
+          }
+        ]
+     * @param {string} body.authData[index].marker - The marker for the authentication data. Example: "login".
+     * @param {string} body.authData[index].value  - The value for the authentication data. Example: "user@example.com".
+     * @returns {IAuthEntity} Returns an auth entity object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description User authorization.
      */
@@ -184,9 +184,9 @@ class AuthProviderApi extends asyncModules_1.default {
     /**
      * Refresh token.
      * @handleName refresh
-     * @param   {string}      marker - The text identifier of the authorization provider. Example: "email".
-     * @param   {string}      token  - Refresh token. Example: "abcdef123456".
-     * @returns {IAuthEntity}        Returns an auth entity object with the following values: accessToken, refreshToken, user, and other auth-related data.
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} token - Refresh token. Example: "abcdef123456".
+     * @returns {IAuthEntity} Returns an auth entity object with the following values: accessToken, refreshToken, user, and other auth-related data.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description User token refresh.
      */
@@ -203,9 +203,9 @@ class AuthProviderApi extends asyncModules_1.default {
     /**
      * User account logout.
      * @handleName logout
-     * @param   {string}  marker - The text identifier of the authorization provider. Example: "email".
-     * @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.
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @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.
      */
@@ -226,8 +226,8 @@ class AuthProviderApi extends asyncModules_1.default {
     /**
      * Logout of user account on all devices.
      * @handleName logoutAll
-     * @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.
+     * @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.
      */
@@ -245,14 +245,14 @@ class AuthProviderApi extends asyncModules_1.default {
     /**
      * Change password.
      * @handleName changePassword
-     * @param   {string}  marker           - The text identifier of the authorization provider. Example: "email".
-     * @param   {string}  userIdentifier   - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
-     * @param   {string}  eventIdentifier  - The text identifier of the event. Example: "reg".
-     * @param   {string}  type             - Operation type (1 - for changing password, 2 - for recovery). Example: 1.
-     * @param   {string}  code             - Service code. Example: "123456".
-     * @param   {string}  newPassword      - New password. Example: "newPassword123".
-     * @param   {string}  [repeatPassword] - Optional variable contains repeat new password for validation. Example: "newPassword123".
-     * @returns {boolean}                  Returns true if the password was successfully changed, or an error object if there was an issue.
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
+     * @param {string} eventIdentifier - The text identifier of the event. Example: "reg".
+     * @param {string} type - Operation type (1 - for changing password, 2 - for recovery). Example: 1.
+     * @param {string} code - Service code. Example: "123456".
+     * @param {string} newPassword - New password. Example: "newPassword123".
+     * @param {string} [repeatPassword] - Optional variable contains repeat new password for validation. Example: "newPassword123".
+     * @returns {boolean} Returns true if the password was successfully changed, 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 User password change (only for tariffs with account activation and the Activation feature enabled).
      */
@@ -271,10 +271,10 @@ class AuthProviderApi extends asyncModules_1.default {
     /**
      * Get all auth providers objects.
      * @handleName getAuthProviders
-     * @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 {IAuthProvidersEntity[]}            Returns an array of auth provider objects.
+     * @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 {IAuthProvidersEntity[]} Returns an array of auth provider objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Getting all objects of authorization providers.
      */
@@ -285,9 +285,9 @@ class AuthProviderApi extends asyncModules_1.default {
     /**
      * Get one auth provider object by marker.
      * @handleName getAuthProviderByMarker
-     * @param   {string}               marker     - The text identifier of the authorization provider. Example: "email".
-     * @param   {string}               [langCode] - Language code. Default: "en_US".
-     * @returns {IAuthProvidersEntity}            Returns an auth provider object.
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IAuthProvidersEntity} Returns an auth provider object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Getting a single authorization provider object by marker.
      */
@@ -298,8 +298,8 @@ class AuthProviderApi extends asyncModules_1.default {
     /**
      * Getting active user sessions data.
      * @handleName getActiveSessions
-     * @param   {string}           marker - The text identifier of the authorization provider. Example: "email".
-     * @returns {IActiveSession[]}        Returns an auth provider object.
+     * @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.
      * @description Getting a single authorization provider object by marker.
      */
@@ -310,17 +310,17 @@ 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:
-                                              {
-                                              "client_id": "34346983-luuct343473qdkqidjopdfp3eb3k4thp.apps.googleusercontent.com",
-                                              "client_secret": "43434343434",
-                                              "code": "4/0AVMBsJgwewewewewewei4D7T6E_fbswxnL3g",
-                                              "grant_type": "authorization_code",
-                                              "redirect_uri": "http://localhost:3000"
-                                              }
-     * @param   {string}           [langCode] - Language code. Default: "en_US".
-     * @returns {ISignUpEntity}               Returns a user object.
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {IOAuthSignUpData} body - Object contains OAuth information for registration. Example:
+        {
+          "client_id": "34346983-luuct343473qdkqidjopdfp3eb3k4thp.apps.googleusercontent.com",
+          "client_secret": "43434343434",
+          "code": "4/0AVMBsJgwewewewewewei4D7T6E_fbswxnL3g",
+          "grant_type": "authorization_code",
+          "redirect_uri": "http://localhost:3000"
+        }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {ISignUpEntity} Returns a user object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description User registration (authorization) via OAUTH.
      */