auth0 5.1.0 → 5.3.0

package/dist/cjs/management/api/resources/users/client/Client.d.ts

@@ -1,57 +1,60 @@
 import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
 import * as core from "../../../../core/index.js";
 import * as Management from "../../../index.js";
-import { AuthenticationMethods } from "../resources/authenticationMethods/client/Client.js";
-import { Authenticators } from "../resources/authenticators/client/Client.js";
-import { ConnectedAccounts } from "../resources/connectedAccounts/client/Client.js";
-import { Enrollments } from "../resources/enrollments/client/Client.js";
-import { FederatedConnectionsTokensets } from "../resources/federatedConnectionsTokensets/client/Client.js";
-import { Identities } from "../resources/identities/client/Client.js";
-import { Logs } from "../resources/logs/client/Client.js";
-import { Multifactor } from "../resources/multifactor/client/Client.js";
-import { Organizations } from "../resources/organizations/client/Client.js";
-import { Permissions } from "../resources/permissions/client/Client.js";
-import { RiskAssessments } from "../resources/riskAssessments/client/Client.js";
-import { Roles } from "../resources/roles/client/Client.js";
-import { RefreshToken } from "../resources/refreshToken/client/Client.js";
-import { Sessions } from "../resources/sessions/client/Client.js";
-export declare namespace Users {
-    interface Options extends BaseClientOptions {
-    }
+import { AuthenticationMethodsClient } from "../resources/authenticationMethods/client/Client.js";
+import { AuthenticatorsClient } from "../resources/authenticators/client/Client.js";
+import { ConnectedAccountsClient } from "../resources/connectedAccounts/client/Client.js";
+import { EnrollmentsClient } from "../resources/enrollments/client/Client.js";
+import { FederatedConnectionsTokensetsClient } from "../resources/federatedConnectionsTokensets/client/Client.js";
+import { GroupsClient } from "../resources/groups/client/Client.js";
+import { IdentitiesClient } from "../resources/identities/client/Client.js";
+import { LogsClient } from "../resources/logs/client/Client.js";
+import { MultifactorClient } from "../resources/multifactor/client/Client.js";
+import { OrganizationsClient } from "../resources/organizations/client/Client.js";
+import { PermissionsClient } from "../resources/permissions/client/Client.js";
+import { RefreshTokenClient } from "../resources/refreshToken/client/Client.js";
+import { RiskAssessmentsClient } from "../resources/riskAssessments/client/Client.js";
+import { RolesClient } from "../resources/roles/client/Client.js";
+import { SessionsClient } from "../resources/sessions/client/Client.js";
+export declare namespace UsersClient {
+    type Options = BaseClientOptions;
     interface RequestOptions extends BaseRequestOptions {
     }
 }
-export declare class Users {
-    protected readonly _options: Users.Options;
-    protected _authenticationMethods: AuthenticationMethods | undefined;
-    protected _authenticators: Authenticators | undefined;
-    protected _connectedAccounts: ConnectedAccounts | undefined;
-    protected _enrollments: Enrollments | undefined;
-    protected _federatedConnectionsTokensets: FederatedConnectionsTokensets | undefined;
-    protected _identities: Identities | undefined;
-    protected _logs: Logs | undefined;
-    protected _multifactor: Multifactor | undefined;
-    protected _organizations: Organizations | undefined;
-    protected _permissions: Permissions | undefined;
-    protected _riskAssessments: RiskAssessments | undefined;
-    protected _roles: Roles | undefined;
-    protected _refreshToken: RefreshToken | undefined;
-    protected _sessions: Sessions | undefined;
-    constructor(_options: Users.Options);
-    get authenticationMethods(): AuthenticationMethods;
-    get authenticators(): Authenticators;
-    get connectedAccounts(): ConnectedAccounts;
-    get enrollments(): Enrollments;
-    get federatedConnectionsTokensets(): FederatedConnectionsTokensets;
-    get identities(): Identities;
-    get logs(): Logs;
-    get multifactor(): Multifactor;
-    get organizations(): Organizations;
-    get permissions(): Permissions;
-    get riskAssessments(): RiskAssessments;
-    get roles(): Roles;
-    get refreshToken(): RefreshToken;
-    get sessions(): Sessions;
+export declare class UsersClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<UsersClient.Options>;
+    protected _authenticationMethods: AuthenticationMethodsClient | undefined;
+    protected _authenticators: AuthenticatorsClient | undefined;
+    protected _connectedAccounts: ConnectedAccountsClient | undefined;
+    protected _enrollments: EnrollmentsClient | undefined;
+    protected _federatedConnectionsTokensets: FederatedConnectionsTokensetsClient | undefined;
+    protected _groups: GroupsClient | undefined;
+    protected _identities: IdentitiesClient | undefined;
+    protected _logs: LogsClient | undefined;
+    protected _multifactor: MultifactorClient | undefined;
+    protected _organizations: OrganizationsClient | undefined;
+    protected _permissions: PermissionsClient | undefined;
+    protected _riskAssessments: RiskAssessmentsClient | undefined;
+    protected _roles: RolesClient | undefined;
+    protected _refreshToken: RefreshTokenClient | undefined;
+    protected _sessions: SessionsClient | undefined;
+    constructor(options: UsersClient.Options);
+    get authenticationMethods(): AuthenticationMethodsClient;
+    get authenticators(): AuthenticatorsClient;
+    get connectedAccounts(): ConnectedAccountsClient;
+    get enrollments(): EnrollmentsClient;
+    get federatedConnectionsTokensets(): FederatedConnectionsTokensetsClient;
+    get groups(): GroupsClient;
+    get identities(): IdentitiesClient;
+    get logs(): LogsClient;
+    get multifactor(): MultifactorClient;
+    get organizations(): OrganizationsClient;
+    get permissions(): PermissionsClient;
+    get riskAssessments(): RiskAssessmentsClient;
+    get roles(): RolesClient;
+    get refreshToken(): RefreshTokenClient;
+    get sessions(): SessionsClient;
     /**
      * Retrieve details of users. It is possible to:
      *
@@ -69,7 +72,7 @@ export declare class Users {
      * Auth0 limits the number of users you can return. If you exceed this threshold, please redefine your search, use the <a href="https://auth0.com/docs/api/management/v2#!/Jobs/post_users_exports">export job</a>, or the <a href="https://auth0.com/docs/extensions/user-import-export">User Import / Export</a> extension.
      *
      * @param {Management.ListUsersRequestParameters} request
-     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Management.BadRequestError}
      * @throws {@link Management.UnauthorizedError}
@@ -91,14 +94,14 @@ export declare class Users {
      *         primary_order: true
      *     })
      */
-    list(request?: Management.ListUsersRequestParameters, requestOptions?: Users.RequestOptions): Promise<core.Page<Management.UserResponseSchema, Management.ListUsersOffsetPaginatedResponseContent>>;
+    list(request?: Management.ListUsersRequestParameters, requestOptions?: UsersClient.RequestOptions): Promise<core.Page<Management.UserResponseSchema, Management.ListUsersOffsetPaginatedResponseContent>>;
     /**
      * Create a new user for a given <a href="https://auth0.com/docs/connections/database">database</a> or <a href="https://auth0.com/docs/connections/passwordless">passwordless</a> connection.
      *
      * Note: <code>connection</code> is required but other parameters such as <code>email</code> and <code>password</code> are dependent upon the type of connection.
      *
      * @param {Management.CreateUserRequestContent} request
-     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Management.BadRequestError}
      * @throws {@link Management.UnauthorizedError}
@@ -111,7 +114,7 @@ export declare class Users {
      *         connection: "connection"
      *     })
      */
-    create(request: Management.CreateUserRequestContent, requestOptions?: Users.RequestOptions): core.HttpResponsePromise<Management.CreateUserResponseContent>;
+    create(request: Management.CreateUserRequestContent, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Management.CreateUserResponseContent>;
     private __create;
     /**
      * Find users by email. If Auth0 is the identity provider (idP), the email address associated with a user is saved in lower case, regardless of how you initially provided it.
@@ -121,7 +124,7 @@ export declare class Users {
      * Therefore, when using this endpoint, make sure that you are searching for users via email addresses using the correct case.
      *
      * @param {Management.ListUsersByEmailRequestParameters} request
-     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Management.BadRequestError}
      * @throws {@link Management.UnauthorizedError}
@@ -135,14 +138,14 @@ export declare class Users {
      *         email: "email"
      *     })
      */
-    listUsersByEmail(request: Management.ListUsersByEmailRequestParameters, requestOptions?: Users.RequestOptions): core.HttpResponsePromise<Management.UserResponseSchema[]>;
+    listUsersByEmail(request: Management.ListUsersByEmailRequestParameters, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Management.UserResponseSchema[]>;
     private __listUsersByEmail;
     /**
      * Retrieve user details. A list of fields to include or exclude may also be specified. For more information, see <a href="https://auth0.com/docs/manage-users/user-search/retrieve-users-with-get-users-endpoint">Retrieve Users with the Get Users Endpoint</a>.
      *
      * @param {string} id - ID of the user to retrieve.
      * @param {Management.GetUserRequestParameters} request
-     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Management.BadRequestError}
      * @throws {@link Management.UnauthorizedError}
@@ -156,13 +159,13 @@ export declare class Users {
      *         include_fields: true
      *     })
      */
-    get(id: string, request?: Management.GetUserRequestParameters, requestOptions?: Users.RequestOptions): core.HttpResponsePromise<Management.GetUserResponseContent>;
+    get(id: string, request?: Management.GetUserRequestParameters, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Management.GetUserResponseContent>;
     private __get;
     /**
      * Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard instructions, see <a href="https://auth0.com/docs/manage-users/user-accounts/delete-users">Delete Users</a>.
      *
      * @param {string} id - ID of the user to delete.
-     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Management.BadRequestError}
      * @throws {@link Management.UnauthorizedError}
@@ -172,7 +175,7 @@ export declare class Users {
      * @example
      *     await client.users.delete("id")
      */
-    delete(id: string, requestOptions?: Users.RequestOptions): core.HttpResponsePromise<void>;
+    delete(id: string, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
     /**
      * Update a user.
@@ -248,7 +251,7 @@ export declare class Users {
      *
      * @param {string} id - ID of the user to update.
      * @param {Management.UpdateUserRequestContent} request
-     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Management.BadRequestError}
      * @throws {@link Management.UnauthorizedError}
@@ -259,13 +262,13 @@ export declare class Users {
      * @example
      *     await client.users.update("id")
      */
-    update(id: string, request?: Management.UpdateUserRequestContent, requestOptions?: Users.RequestOptions): core.HttpResponsePromise<Management.UpdateUserResponseContent>;
+    update(id: string, request?: Management.UpdateUserRequestContent, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Management.UpdateUserResponseContent>;
     private __update;
     /**
      * Remove an existing multi-factor authentication (MFA) <a href="https://auth0.com/docs/secure/multi-factor-authentication/reset-user-mfa">recovery code</a> and generate a new one. If a user cannot access the original device or account used for MFA enrollment, they can use a recovery code to authenticate.
      *
      * @param {string} id - ID of the user to regenerate a multi-factor authentication recovery code for.
-     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Management.BadRequestError}
      * @throws {@link Management.UnauthorizedError}
@@ -275,14 +278,14 @@ export declare class Users {
      * @example
      *     await client.users.regenerateRecoveryCode("id")
      */
-    regenerateRecoveryCode(id: string, requestOptions?: Users.RequestOptions): core.HttpResponsePromise<Management.RegenerateUsersRecoveryCodeResponseContent>;
+    regenerateRecoveryCode(id: string, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Management.RegenerateUsersRecoveryCodeResponseContent>;
     private __regenerateRecoveryCode;
     /**
      * Revokes selected resources related to a user (sessions, refresh tokens, ...).
      *
      * @param {string} id - ID of the user.
      * @param {Management.RevokeUserAccessRequestContent} request
-     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Management.BadRequestError}
      * @throws {@link Management.UnauthorizedError}
@@ -292,7 +295,6 @@ export declare class Users {
      * @example
      *     await client.users.revokeAccess("id")
      */
-    revokeAccess(id: string, request?: Management.RevokeUserAccessRequestContent, requestOptions?: Users.RequestOptions): core.HttpResponsePromise<void>;
+    revokeAccess(id: string, request?: Management.RevokeUserAccessRequestContent, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<void>;
     private __revokeAccess;
-    protected _getAuthorizationHeader(): Promise<string>;
 }