@payabli/sdk-node 0.0.116 → 0.0.117

package/dist/cjs/api/resources/user/client/Client.d.ts

@@ -1,18 +1,21 @@
 import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
 import * as core from "../../../../core/index.js";
 import * as Payabli from "../../../index.js";
-export declare namespace User {
+export declare namespace UserClient {
     interface Options extends BaseClientOptions {
     }
     interface RequestOptions extends BaseRequestOptions {
     }
 }
-export declare class User {
-    protected readonly _options: User.Options;
-    constructor(_options?: User.Options);
+export declare class UserClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<UserClient.Options>;
+    constructor(options?: UserClient.Options);
     /**
+     * Use this endpoint to add a new user to an organization.
+     *
      * @param {Payabli.UserData} request
-     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {UserClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -22,10 +25,12 @@ export declare class User {
      * @example
      *     await client.user.addUser({})
      */
-    addUser(request: Payabli.UserData, requestOptions?: User.RequestOptions): core.HttpResponsePromise<Payabli.AddUserResponse>;
+    addUser(request: Payabli.UserData, requestOptions?: UserClient.RequestOptions): core.HttpResponsePromise<Payabli.AddUserResponse>;
     private __addUser;
     /**
-     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     * Use this endpoint to refresh the authentication token for a user within an organization.
+     *
+     * @param {UserClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -35,11 +40,13 @@ export declare class User {
      * @example
      *     await client.user.authRefreshUser()
      */
-    authRefreshUser(requestOptions?: User.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponseUserMfa>;
+    authRefreshUser(requestOptions?: UserClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponseUserMfa>;
     private __authRefreshUser;
     /**
+     * Use this endpoint to initiate a password reset for a user within an organization.
+     *
      * @param {Payabli.UserAuthResetRequest} request
-     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {UserClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -49,14 +56,14 @@ export declare class User {
      * @example
      *     await client.user.authResetUser()
      */
-    authResetUser(request?: Payabli.UserAuthResetRequest, requestOptions?: User.RequestOptions): core.HttpResponsePromise<Payabli.AuthResetUserResponse>;
+    authResetUser(request?: Payabli.UserAuthResetRequest, requestOptions?: UserClient.RequestOptions): core.HttpResponsePromise<Payabli.AuthResetUserResponse>;
     private __authResetUser;
     /**
      * This endpoint requires an application API token.
      *
      * @param {string} provider - Auth provider. This fields is optional and defaults to null for the built-in provider.
      * @param {Payabli.UserAuthRequest} request
-     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {UserClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -66,11 +73,13 @@ export declare class User {
      * @example
      *     await client.user.authUser("provider")
      */
-    authUser(provider: string, request?: Payabli.UserAuthRequest, requestOptions?: User.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponseMfaBasic>;
+    authUser(provider: string, request?: Payabli.UserAuthRequest, requestOptions?: UserClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponseMfaBasic>;
     private __authUser;
     /**
+     * Use this endpoint to change the password for a user within an organization.
+     *
      * @param {Payabli.UserAuthPswResetRequest} request
-     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {UserClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -80,11 +89,13 @@ export declare class User {
      * @example
      *     await client.user.changePswUser()
      */
-    changePswUser(request?: Payabli.UserAuthPswResetRequest, requestOptions?: User.RequestOptions): core.HttpResponsePromise<Payabli.ChangePswUserResponse>;
+    changePswUser(request?: Payabli.UserAuthPswResetRequest, requestOptions?: UserClient.RequestOptions): core.HttpResponsePromise<Payabli.ChangePswUserResponse>;
     private __changePswUser;
     /**
+     * Use this endpoint to delete a specific user within an organization.
+     *
      * @param {number} userId - The Payabli-generated `userId` value.
-     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {UserClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -94,12 +105,14 @@ export declare class User {
      * @example
      *     await client.user.deleteUser(1000000)
      */
-    deleteUser(userId: number, requestOptions?: User.RequestOptions): core.HttpResponsePromise<Payabli.DeleteUserResponse>;
+    deleteUser(userId: number, requestOptions?: UserClient.RequestOptions): core.HttpResponsePromise<Payabli.DeleteUserResponse>;
     private __deleteUser;
     /**
+     * Use this endpoint to enable or disable multi-factor authentication (MFA) for a user within an organization.
+     *
      * @param {number} userId - User Identifier
      * @param {Payabli.MfaData} request
-     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {UserClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -109,12 +122,14 @@ export declare class User {
      * @example
      *     await client.user.editMfaUser(1000000, {})
      */
-    editMfaUser(userId: number, request: Payabli.MfaData, requestOptions?: User.RequestOptions): core.HttpResponsePromise<Payabli.EditMfaUserResponse>;
+    editMfaUser(userId: number, request: Payabli.MfaData, requestOptions?: UserClient.RequestOptions): core.HttpResponsePromise<Payabli.EditMfaUserResponse>;
     private __editMfaUser;
     /**
+     * Use this endpoint to modify the details of a specific user within an organization.
+     *
      * @param {number} userId - User Identifier
      * @param {Payabli.UserData} request
-     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {UserClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -124,12 +139,14 @@ export declare class User {
      * @example
      *     await client.user.editUser(1000000, {})
      */
-    editUser(userId: number, request: Payabli.UserData, requestOptions?: User.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponse>;
+    editUser(userId: number, request: Payabli.UserData, requestOptions?: UserClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponse>;
     private __editUser;
     /**
+     * Use this endpoint to retrieve information about a specific user within an organization.
+     *
      * @param {number} userId - The Payabli-generated `userId` value.
      * @param {Payabli.GetUserRequest} request
-     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {UserClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -141,10 +158,12 @@ export declare class User {
      *         entry: "478ae1234"
      *     })
      */
-    getUser(userId: number, request?: Payabli.GetUserRequest, requestOptions?: User.RequestOptions): core.HttpResponsePromise<Payabli.UserQueryRecord>;
+    getUser(userId: number, request?: Payabli.GetUserRequest, requestOptions?: UserClient.RequestOptions): core.HttpResponsePromise<Payabli.UserQueryRecord>;
     private __getUser;
     /**
-     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     * Use this endpoint to log a user out from the system.
+     *
+     * @param {UserClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -154,13 +173,15 @@ export declare class User {
      * @example
      *     await client.user.logoutUser()
      */
-    logoutUser(requestOptions?: User.RequestOptions): core.HttpResponsePromise<Payabli.LogoutUserResponse>;
+    logoutUser(requestOptions?: UserClient.RequestOptions): core.HttpResponsePromise<Payabli.LogoutUserResponse>;
     private __logoutUser;
     /**
-     * @param {string} entry -
-     * @param {number} entryType -
+     * Resends the MFA code to the user via the selected MFA mode (email or SMS).
+     *
      * @param {string} usrname -
-     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {string} Entry -
+     * @param {number} EntryType -
+     * @param {UserClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -168,13 +189,15 @@ export declare class User {
      * @throws {@link Payabli.ServiceUnavailableError}
      *
      * @example
-     *     await client.user.resendMfaCode("Entry", 1, "usrname")
+     *     await client.user.resendMfaCode("usrname", "Entry", 1)
      */
-    resendMfaCode(entry: string, entryType: number, usrname: string, requestOptions?: User.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponseMfaBasic>;
+    resendMfaCode(usrname: string, Entry: string, EntryType: number, requestOptions?: UserClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponseMfaBasic>;
     private __resendMfaCode;
     /**
+     * Use this endpoint to validate the multi-factor authentication (MFA) code for a user within an organization.
+     *
      * @param {Payabli.MfaValidationData} request
-     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {UserClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -184,7 +207,6 @@ export declare class User {
      * @example
      *     await client.user.validateMfaUser()
      */
-    validateMfaUser(request?: Payabli.MfaValidationData, requestOptions?: User.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponseUserMfa>;
+    validateMfaUser(request?: Payabli.MfaValidationData, requestOptions?: UserClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponseUserMfa>;
     private __validateMfaUser;
-    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
 }