oneentry 1.0.126 → 1.0.128

package/dist/auth-provider/authProviderApi.js

@@ -3,46 +3,46 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable jsdoc/no-undefined-types */
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with auth services.
- *
  * @handle /api/content/users-auth-providers
  * @class AuthProviderApi
- * @extends AsyncModules
+ * @augments AsyncModules
  * @implements {IAuthProvider}
- *
  * @description This class provides methods for user registration, authentication, and management of authentication providers.
  */
 class AuthProviderApi extends asyncModules_1.default {
+    /**
+     *
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/users-auth-providers';
     }
     /**
      * 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": "login",
+            "value": "example@oneentry.cloud"
             },
             {
-              "marker": "password",
-              "value": "12345"
+            "marker": "password",
+            "value": "12345"
             }
           ],
           "formData": [
             {
-              "marker": "last_name",
-              "type": "string",
-              "value": "Name"
+            "marker": "last_name",
+            "type": "string",
+            "value": "Name"
             }
           ],
           "notificationData": {
@@ -51,32 +51,32 @@ class AuthProviderApi extends asyncModules_1.default {
             "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 | IAuthFormData[]} body.formData - The form data for the registration, which can be a single object or an array of objects. Example:
+     * @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": "last_name",
-            "type": "string",
-            "value": "Name"
-          }
-      * @param {Object} body.notificationData - An object containing notification data, including email, phonePush, and phoneSMS. Example:
+            "marker": "login",
+            "value": "example@oneentry.cloud"
+          },
           {
-            "email": "example@oneentry.cloud",
-            "phonePush": ["+99999999999"],
-            "phoneSMS": "+99999999999"
+            "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".
-     * @return {ISignUpEntity} Returns a user object.
+     * @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).
      */
@@ -87,13 +87,11 @@ 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".
-     * @return {void} Returns void if the code is successfully generated, or an error object if there was an issue.
+     * @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.
      */
@@ -102,20 +100,17 @@ class AuthProviderApi extends asyncModules_1.default {
             userIdentifier,
             eventIdentifier,
         };
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
         const result = await this._fetchPost(`/marker/${marker}/users/generate-code`, data);
         return result;
     }
     /**
      * 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} 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".
-     * @return {boolean} Returns true if the code is correct, or an error object if there was an issue.
+     * @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
      */
@@ -130,13 +125,11 @@ 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".
-     * @return {boolean} Returns true if the user was successfully activated, or an error object if there was an issue.
+     * @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.
      */
@@ -150,20 +143,18 @@ 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": "login",
+            "value": "example@oneentry.cloud"
             },
             {
-              "marker": "password",
-              "value": "12345"
+            "marker": "password",
+            "value": "12345"
             }
           ]
         }
@@ -175,9 +166,8 @@ class AuthProviderApi extends asyncModules_1.default {
           }
         ]
      * @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".
-     *
-     * @return {IAuthEntity} Returns an auth entity object.
+     * @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.
      */
@@ -193,12 +183,10 @@ 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".
-     * @return {IAuthEntity} Returns an auth entity object with the following values: accessToken, refreshToken, user, and other auth-related data.
+     * @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.
      */
@@ -214,12 +202,10 @@ 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".
-     * @return {boolean} Returns true if the logout was successful, or an error object if there was an issue.
+     * @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.
      */
@@ -239,11 +225,9 @@ 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".
-     * @return {boolean} Returns true if the logout was successful, or an error object if there was an issue.
+     * @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.
      */
@@ -260,9 +244,7 @@ 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".
@@ -270,7 +252,7 @@ class AuthProviderApi extends asyncModules_1.default {
      * @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".
-     * @return {boolean} Returns true if the password was successfully changed, or an error object if there was an issue.
+     * @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).
      */
@@ -288,13 +270,11 @@ 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.
-     * @return {IAuthProvidersEntity[]} Returns an array of auth provider objects.
+     * @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.
      */
@@ -304,12 +284,10 @@ 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".
-     * @return {IAuthProvidersEntity} Returns an auth provider object.
+     * @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.
      */
@@ -319,11 +297,9 @@ 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".
-     * @return {IAuthProvidersEntity} Returns an auth provider object.
+     * @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.
      */
@@ -333,9 +309,7 @@ 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:
         {
@@ -346,7 +320,7 @@ class AuthProviderApi extends asyncModules_1.default {
           "redirect_uri": "http://localhost:3000"
         }
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ISignUpEntity} Returns a user object.
+     * @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.
      */