auth0 5.10.0 → 5.12.0

package/dist/esm/management/api/resources/users/client/Client.mjs

@@ -18,6 +18,8 @@ import * as Management from "../../../index.mjs";
 import { AuthenticationMethodsClient } from "../resources/authenticationMethods/client/Client.mjs";
 import { AuthenticatorsClient } from "../resources/authenticators/client/Client.mjs";
 import { ConnectedAccountsClient } from "../resources/connectedAccounts/client/Client.mjs";
+import { EffectivePermissionsClient } from "../resources/effectivePermissions/client/Client.mjs";
+import { EffectiveRolesClient } from "../resources/effectiveRoles/client/Client.mjs";
 import { EnrollmentsClient } from "../resources/enrollments/client/Client.mjs";
 import { FederatedConnectionsTokensetsClient } from "../resources/federatedConnectionsTokensets/client/Client.mjs";
 import { GroupsClient } from "../resources/groups/client/Client.mjs";
@@ -46,6 +48,14 @@ export class UsersClient {
         var _a;
         return ((_a = this._connectedAccounts) !== null && _a !== void 0 ? _a : (this._connectedAccounts = new ConnectedAccountsClient(this._options)));
     }
+    get effectivePermissions() {
+        var _a;
+        return ((_a = this._effectivePermissions) !== null && _a !== void 0 ? _a : (this._effectivePermissions = new EffectivePermissionsClient(this._options)));
+    }
+    get effectiveRoles() {
+        var _a;
+        return ((_a = this._effectiveRoles) !== null && _a !== void 0 ? _a : (this._effectiveRoles = new EffectiveRolesClient(this._options)));
+    }
     get enrollments() {
         var _a;
         return ((_a = this._enrollments) !== null && _a !== void 0 ? _a : (this._enrollments = new EnrollmentsClient(this._options)));
@@ -101,14 +111,18 @@ export class UsersClient {
      * - Sort the users to be returned
      * - Select the fields to be returned
      * - Specify the number of users to retrieve per page and the page index
-     *  <!-- only v3 is available -->
-     * The <code>q</code> query parameter can be used to get users that match the specified criteria <a href="https://auth0.com/docs/users/search/v3/query-syntax">using query string syntax.</a>
      *
-     * <a href="https://auth0.com/docs/users/search/v3">Learn more about searching for users.</a>
      *
-     * Read about <a href="https://auth0.com/docs/users/search/best-practices">best practices</a> when working with the API endpoints for retrieving 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.
+     * The `q` query parameter can be used to get users that match the specified criteria [using query string syntax.](https://auth0.com/docs/users/search/v3/query-syntax)
+     *
+     * [Learn more about searching for users.](https://auth0.com/docs/users/search/v3)
+     *
+     * Read about [best practices](https://auth0.com/docs/users/search/best-practices) when working with the API endpoints for retrieving users.
+     *
+     *
+     *
+     * Auth0 limits the number of users you can return. If you exceed this threshold, please redefine your search, use the [export job](https://auth0.com/docs/api/management/v2#!/Jobs/post_users_exports), or the [User Import / Export](https://auth0.com/docs/extensions/user-import-export) extension.
      *
      * @param {Management.ListUsersRequestParameters} request
      * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -210,9 +224,9 @@ export class UsersClient {
         });
     }
     /**
-     * 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.
+     * Create a new user for a given [database](https://auth0.com/docs/connections/database) or [passwordless](https://auth0.com/docs/connections/passwordless) 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.
+     * Note: `connection` is required but other parameters such as `email` and `password` are dependent upon the type of connection.
      *
      * @param {Management.CreateUserRequestContent} request
      * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -352,7 +366,7 @@ export class UsersClient {
         });
     }
     /**
-     * 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>.
+     * Retrieve user details. A list of fields to include or exclude may also be specified. For more information, see [Retrieve Users with the Get Users Endpoint](https://auth0.com/docs/manage-users/user-search/retrieve-users-with-get-users-endpoint).
      *
      * @param {string} id - ID of the user to retrieve.
      * @param {Management.GetUserRequestParameters} request
@@ -425,7 +439,7 @@ export class UsersClient {
         });
     }
     /**
-     * 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>.
+     * Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard instructions, see [Delete Users](https://auth0.com/docs/manage-users/user-accounts/delete-users).
      *
      * @param {string} id - ID of the user to delete.
      * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -486,64 +500,84 @@ export class UsersClient {
      *
      * These are the attributes that can be updated at the root level:
      *
-     * <ul>
-     *     <li>app_metadata</li>
-     *     <li>blocked</li>
-     *     <li>email</li>
-     *     <li>email_verified</li>
-     *     <li>family_name</li>
-     *     <li>given_name</li>
-     *     <li>name</li>
-     *     <li>nickname</li>
-     *     <li>password</li>
-     *     <li>phone_number</li>
-     *     <li>phone_verified</li>
-     *     <li>picture</li>
-     *     <li>username</li>
-     *     <li>user_metadata</li>
-     *     <li>verify_email</li>
-     * </ul>
+     * - app_metadata
+     * - blocked
+     * - email
+     * - email_verified
+     * - family_name
+     * - given_name
+     * - name
+     * - nickname
+     * - password
+     * - phone_number
+     * - phone_verified
+     * - picture
+     * - username
+     * - user_metadata
+     * - verify_email
      *
      * Some considerations:
-     * <ul>
-     *     <li>The properties of the new object will replace the old ones.</li>
-     *     <li>The metadata fields are an exception to this rule (<code>user_metadata</code> and <code>app_metadata</code>). These properties are merged instead of being replaced but be careful, the merge only occurs on the first level.</li>
-     *     <li>If you are updating <code>email</code>, <code>email_verified</code>, <code>phone_number</code>, <code>phone_verified</code>, <code>username</code> or <code>password</code> of a secondary identity, you need to specify the <code>connection</code> property too.</li>
-     *     <li>If you are updating <code>email</code> or <code>phone_number</code> you can specify, optionally, the <code>client_id</code> property.</li>
-     *     <li>Updating <code>email_verified</code> is not supported for enterprise and passwordless sms connections.</li>
-     *     <li>Updating the <code>blocked</code> to <code>false</code> does not affect the user's blocked state from an excessive amount of incorrectly provided credentials. Use the "Unblock a user" endpoint from the "User Blocks" API to change the user's state.</li>
-     *     <li>Supported attributes can be unset by supplying <code>null</code> as the value.</li>
-     * </ul>
-     *
-     * <h5>Updating a field (non-metadata property)</h5>
+     *
+     * - The properties of the new object will replace the old ones.
+     * - The metadata fields are an exception to this rule (`user_metadata` and `app_metadata`). These properties are merged instead of being replaced but be careful, the merge only occurs on the first level.
+     * - If you are updating `email`, `email_verified`, `phone_number`, `phone_verified`, `username` or `password` of a secondary identity, you need to specify the `connection` property too.
+     * - If you are updating `email` or `phone_number` you can specify, optionally, the `client_id` property.
+     * - Updating `email_verified` is not supported for enterprise and passwordless sms connections.
+     * - Updating the `blocked` to `false` does not affect the user's blocked state from an excessive amount of incorrectly provided credentials. Use the "Unblock a user" endpoint from the "User Blocks" API to change the user's state.
+     * - Supported attributes can be unset by supplying `null` as the value.
+     *
+     * **Updating a field (non-metadata property)**
+     *
      * To mark the email address of a user as verified, the body to send should be:
-     * <pre><code>{ "email_verified": true }</code></pre>
      *
-     * <h5>Updating a user metadata root property</h5>Let's assume that our test user has the following <code>user_metadata</code>:
-     * <pre><code>{ "user_metadata" : { "profileCode": 1479 } }</code></pre>
+     * ```json
+     * { "email_verified": true }
+     * ```
+     *
+     * **Updating a user metadata root property**
+     *
+     * Let's assume that our test user has the following `user_metadata`:
+     *
+     * ```json
+     * { "user_metadata" : { "profileCode": 1479 } }
+     * ```
      *
-     * To add the field <code>addresses</code> the body to send should be:
-     * <pre><code>{ "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}</code></pre>
+     * To add the field `addresses` the body to send should be:
      *
-     * The modified object ends up with the following <code>user_metadata</code> property:<pre><code>{
+     * ```json
+     * { "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}
+     * ```
+     *
+     * The modified object ends up with the following `user_metadata` property:
+     *
+     * ```json
+     * {
      *   "user_metadata": {
      *     "profileCode": 1479,
      *     "addresses": { "work_address": "100 Industrial Way" }
      *   }
-     * }</code></pre>
+     * }
+     * ```
+     *
+     * **Updating an inner user metadata property**
      *
-     * <h5>Updating an inner user metadata property</h5>If there's existing user metadata to which we want to add  <code>"home_address": "742 Evergreen Terrace"</code> (using the <code>addresses</code> property) we should send the whole <code>addresses</code> object. Since this is a first-level object, the object will be merged in, but its own properties will not be. The body to send should be:
-     * <pre><code>{
+     * If there's existing user metadata to which we want to add  `"home_address": "742 Evergreen Terrace"` (using the `addresses` property) we should send the whole `addresses` object. Since this is a first-level object, the object will be merged in, but its own properties will not be. The body to send should be:
+     *
+     * ```json
+     * {
      *   "user_metadata": {
      *     "addresses": {
      *       "work_address": "100 Industrial Way",
      *       "home_address": "742 Evergreen Terrace"
      *     }
      *   }
-     * }</code></pre>
+     * }
+     * ```
+     *
+     * The modified object ends up with the following `user_metadata` property:
      *
-     * The modified object ends up with the following <code>user_metadata</code> property:
-     * <pre><code>{
+     * ```json
+     * {
      *   "user_metadata": {
      *     "profileCode": 1479,
      *     "addresses": {
@@ -551,7 +585,8 @@ export class UsersClient {
      *       "home_address": "742 Evergreen Terrace"
      *     }
      *   }
-     * }</code></pre>
+     * }
+     * ```
      *
      * @param {string} id - ID of the user to update.
      * @param {Management.UpdateUserRequestContent} request
@@ -615,7 +650,7 @@ export class UsersClient {
         });
     }
     /**
-     * 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.
+     * Remove an existing multi-factor authentication (MFA) [recovery code](https://auth0.com/docs/secure/multi-factor-authentication/reset-user-mfa) 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 {UsersClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/management/api/resources/users/resources/authenticators/client/Client.d.mts

@@ -10,7 +10,7 @@ export declare class AuthenticatorsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<AuthenticatorsClient.Options>;
     constructor(options: AuthenticatorsClient.Options);
     /**
-     * Remove all authenticators registered to a given user ID, such as OTP, email, phone, and push-notification. This action cannot be undone. For more information, review <a href="https://auth0.com/docs/secure/multi-factor-authentication/manage-mfa-auth0-apis/manage-authentication-methods-with-management-api">Manage Authentication Methods with Management API</a>.
+     * Remove all authenticators registered to a given user ID, such as OTP, email, phone, and push-notification. This action cannot be undone. For more information, review [Manage Authentication Methods with Management API](https://auth0.com/docs/secure/multi-factor-authentication/manage-mfa-auth0-apis/manage-authentication-methods-with-management-api).
      *
      * @param {string} id - ID of the user to delete.
      * @param {AuthenticatorsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/management/api/resources/users/resources/authenticators/client/Client.mjs

@@ -20,7 +20,7 @@ export class AuthenticatorsClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
-     * Remove all authenticators registered to a given user ID, such as OTP, email, phone, and push-notification. This action cannot be undone. For more information, review <a href="https://auth0.com/docs/secure/multi-factor-authentication/manage-mfa-auth0-apis/manage-authentication-methods-with-management-api">Manage Authentication Methods with Management API</a>.
+     * Remove all authenticators registered to a given user ID, such as OTP, email, phone, and push-notification. This action cannot be undone. For more information, review [Manage Authentication Methods with Management API](https://auth0.com/docs/secure/multi-factor-authentication/manage-mfa-auth0-apis/manage-authentication-methods-with-management-api).
      *
      * @param {string} id - ID of the user to delete.
      * @param {AuthenticatorsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/management/api/resources/users/resources/effectivePermissions/client/Client.d.mts

@@ -0,0 +1,37 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../../../BaseClient.mjs";
+import * as core from "../../../../../../core/index.mjs";
+import * as Management from "../../../../../index.mjs";
+import { SourcesClient } from "../resources/sources/client/Client.mjs";
+export declare namespace EffectivePermissionsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class EffectivePermissionsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<EffectivePermissionsClient.Options>;
+    protected _sources: SourcesClient | undefined;
+    constructor(options: EffectivePermissionsClient.Options);
+    get sources(): SourcesClient;
+    /**
+     * Returns the list of effective permissions for a user, taking into account permissions granted directly to the user, as well as those inherited through roles and group memberships.
+     *
+     * @param {string} id - ID of the user to retrieve the permissions for.
+     * @param {Management.ListUserEffectivePermissionsRequestParameters} request
+     * @param {EffectivePermissionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Management.BadRequestError}
+     * @throws {@link Management.UnauthorizedError}
+     * @throws {@link Management.ForbiddenError}
+     * @throws {@link Management.NotFoundError}
+     * @throws {@link Management.TooManyRequestsError}
+     *
+     * @example
+     *     await client.users.effectivePermissions.list("id", {
+     *         from: "from",
+     *         take: 1,
+     *         resource_server_identifier: "resource_server_identifier"
+     *     })
+     */
+    list(id: string, request: Management.ListUserEffectivePermissionsRequestParameters, requestOptions?: EffectivePermissionsClient.RequestOptions): Promise<core.Page<Management.UserEffectivePermissionResponseContent, Management.ListUserEffectivePermissionsResponseContent>>;
+}

package/dist/esm/management/api/resources/users/resources/effectivePermissions/client/Client.mjs

@@ -0,0 +1,114 @@
+// This file was auto-generated by Fern from our API Definition.
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { normalizeClientOptionsWithAuth } from "../../../../../../BaseClient.mjs";
+import * as core from "../../../../../../core/index.mjs";
+import { mergeHeaders } from "../../../../../../core/headers.mjs";
+import * as environments from "../../../../../../environments.mjs";
+import { handleNonStatusCodeError } from "../../../../../../errors/handleNonStatusCodeError.mjs";
+import * as errors from "../../../../../../errors/index.mjs";
+import * as Management from "../../../../../index.mjs";
+import { SourcesClient } from "../resources/sources/client/Client.mjs";
+export class EffectivePermissionsClient {
+    constructor(options) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+    get sources() {
+        var _a;
+        return ((_a = this._sources) !== null && _a !== void 0 ? _a : (this._sources = new SourcesClient(this._options)));
+    }
+    /**
+     * Returns the list of effective permissions for a user, taking into account permissions granted directly to the user, as well as those inherited through roles and group memberships.
+     *
+     * @param {string} id - ID of the user to retrieve the permissions for.
+     * @param {Management.ListUserEffectivePermissionsRequestParameters} request
+     * @param {EffectivePermissionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Management.BadRequestError}
+     * @throws {@link Management.UnauthorizedError}
+     * @throws {@link Management.ForbiddenError}
+     * @throws {@link Management.NotFoundError}
+     * @throws {@link Management.TooManyRequestsError}
+     *
+     * @example
+     *     await client.users.effectivePermissions.list("id", {
+     *         from: "from",
+     *         take: 1,
+     *         resource_server_identifier: "resource_server_identifier"
+     *     })
+     */
+    list(id, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+                const { from: from_, take = 50, resource_server_identifier: resourceServerIdentifier } = request;
+                const _queryParams = {
+                    from: from_,
+                    take,
+                    resource_server_identifier: resourceServerIdentifier,
+                };
+                const _authRequest = yield this._options.authProvider.getAuthRequest();
+                let _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+                const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
+                    url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ManagementEnvironment.Default, `users/${core.url.encodePathParam(id)}/effective-permissions`),
+                    method: "GET",
+                    headers: _headers,
+                    queryString: core.url
+                        .queryBuilder()
+                        .addMany(_queryParams)
+                        .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
+                        .build(),
+                    timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
+                    maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
+                    abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                    fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.fetch,
+                    logging: this._options.logging,
+                });
+                if (_response.ok) {
+                    return {
+                        data: _response.body,
+                        rawResponse: _response.rawResponse,
+                    };
+                }
+                if (_response.error.reason === "status-code") {
+                    switch (_response.error.statusCode) {
+                        case 400:
+                            throw new Management.BadRequestError(_response.error.body, _response.rawResponse);
+                        case 401:
+                            throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
+                        case 403:
+                            throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
+                        case 404:
+                            throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
+                        case 429:
+                            throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                        default:
+                            throw new errors.ManagementError({
+                                statusCode: _response.error.statusCode,
+                                body: _response.error.body,
+                                rawResponse: _response.rawResponse,
+                            });
+                    }
+                }
+                return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/users/{id}/effective-permissions");
+            }));
+            const dataWithRawResponse = yield list(request).withRawResponse();
+            return new core.Page({
+                response: dataWithRawResponse.data,
+                rawResponse: dataWithRawResponse.rawResponse,
+                hasNextPage: (response) => (response === null || response === void 0 ? void 0 : response.next) != null && !(typeof (response === null || response === void 0 ? void 0 : response.next) === "string" && (response === null || response === void 0 ? void 0 : response.next) === ""),
+                getItems: (response) => { var _a; return (_a = response === null || response === void 0 ? void 0 : response.permissions) !== null && _a !== void 0 ? _a : []; },
+                loadPage: (response) => {
+                    return list(core.setObjectProperty(request, "from", response === null || response === void 0 ? void 0 : response.next));
+                },
+            });
+        });
+    }
+}

package/dist/esm/management/api/resources/users/resources/effectivePermissions/client/index.d.mts

@@ -0,0 +1 @@
+export {};

package/dist/esm/management/api/resources/users/resources/effectivePermissions/client/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/management/api/resources/users/resources/effectivePermissions/index.d.mts

@@ -0,0 +1,2 @@
+export * from "./client/index.mjs";
+export * from "./resources/index.mjs";

package/dist/esm/management/api/resources/users/resources/effectivePermissions/index.mjs

@@ -0,0 +1,2 @@
+export * from "./client/index.mjs";
+export * from "./resources/index.mjs";

package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/index.d.mts

@@ -0,0 +1 @@
+export * as sources from "./sources/index.mjs";

package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/index.mjs

@@ -0,0 +1 @@
+export * as sources from "./sources/index.mjs";

package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/client/Client.d.mts

@@ -0,0 +1,12 @@
+import type { BaseClientOptions } from "../../../../../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../../../../../BaseClient.mjs";
+import { RolesClient } from "../resources/roles/client/Client.mjs";
+export declare namespace SourcesClient {
+    type Options = BaseClientOptions;
+}
+export declare class SourcesClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<SourcesClient.Options>;
+    protected _roles: RolesClient | undefined;
+    constructor(options: SourcesClient.Options);
+    get roles(): RolesClient;
+}

package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/client/Client.mjs

@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+import { normalizeClientOptionsWithAuth, } from "../../../../../../../../BaseClient.mjs";
+import { RolesClient } from "../resources/roles/client/Client.mjs";
+export class SourcesClient {
+    constructor(options) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+    get roles() {
+        var _a;
+        return ((_a = this._roles) !== null && _a !== void 0 ? _a : (this._roles = new RolesClient(this._options)));
+    }
+}

package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/client/index.d.mts

@@ -0,0 +1 @@
+export {};

package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/client/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/index.d.mts

@@ -0,0 +1,2 @@
+export * from "./client/index.mjs";
+export * from "./resources/index.mjs";

package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/index.mjs

@@ -0,0 +1,2 @@
+export * from "./client/index.mjs";
+export * from "./resources/index.mjs";

package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/index.d.mts

@@ -0,0 +1 @@
+export * as roles from "./roles/index.mjs";

package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/index.mjs

@@ -0,0 +1 @@
+export * as roles from "./roles/index.mjs";

package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/client/Client.d.mts

@@ -0,0 +1,35 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../../../../../../../BaseClient.mjs";
+import * as core from "../../../../../../../../../../core/index.mjs";
+import * as Management from "../../../../../../../../../index.mjs";
+export declare namespace RolesClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class RolesClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<RolesClient.Options>;
+    constructor(options: RolesClient.Options);
+    /**
+     * Lists the roles which grant the user a given permission, including roles assigned directly to the user and those inherited through group memberships.
+     *
+     * @param {string} id - ID of the user to retrieve the permissions for.
+     * @param {Management.ListUserEffectivePermissionRoleSourceRequestParameters} request
+     * @param {RolesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Management.BadRequestError}
+     * @throws {@link Management.UnauthorizedError}
+     * @throws {@link Management.ForbiddenError}
+     * @throws {@link Management.NotFoundError}
+     * @throws {@link Management.TooManyRequestsError}
+     *
+     * @example
+     *     await client.users.effectivePermissions.sources.roles.list("id", {
+     *         from: "from",
+     *         take: 1,
+     *         resource_server_identifier: "resource_server_identifier",
+     *         permission_name: "permission_name"
+     *     })
+     */
+    list(id: string, request: Management.ListUserEffectivePermissionRoleSourceRequestParameters, requestOptions?: RolesClient.RequestOptions): Promise<core.Page<Management.UserEffectivePermissionRoleSourceResponseContent, Management.ListUserEffectivePermissionRoleSourcesResponseContent>>;
+}

package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/client/Client.mjs

@@ -0,0 +1,111 @@
+// This file was auto-generated by Fern from our API Definition.
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { normalizeClientOptionsWithAuth, } from "../../../../../../../../../../BaseClient.mjs";
+import * as core from "../../../../../../../../../../core/index.mjs";
+import { mergeHeaders } from "../../../../../../../../../../core/headers.mjs";
+import * as environments from "../../../../../../../../../../environments.mjs";
+import { handleNonStatusCodeError } from "../../../../../../../../../../errors/handleNonStatusCodeError.mjs";
+import * as errors from "../../../../../../../../../../errors/index.mjs";
+import * as Management from "../../../../../../../../../index.mjs";
+export class RolesClient {
+    constructor(options) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+    /**
+     * Lists the roles which grant the user a given permission, including roles assigned directly to the user and those inherited through group memberships.
+     *
+     * @param {string} id - ID of the user to retrieve the permissions for.
+     * @param {Management.ListUserEffectivePermissionRoleSourceRequestParameters} request
+     * @param {RolesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Management.BadRequestError}
+     * @throws {@link Management.UnauthorizedError}
+     * @throws {@link Management.ForbiddenError}
+     * @throws {@link Management.NotFoundError}
+     * @throws {@link Management.TooManyRequestsError}
+     *
+     * @example
+     *     await client.users.effectivePermissions.sources.roles.list("id", {
+     *         from: "from",
+     *         take: 1,
+     *         resource_server_identifier: "resource_server_identifier",
+     *         permission_name: "permission_name"
+     *     })
+     */
+    list(id, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+                const { from: from_, take = 50, resource_server_identifier: resourceServerIdentifier, permission_name: permissionName, } = request;
+                const _queryParams = {
+                    from: from_,
+                    take,
+                    resource_server_identifier: resourceServerIdentifier,
+                    permission_name: permissionName,
+                };
+                const _authRequest = yield this._options.authProvider.getAuthRequest();
+                let _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+                const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
+                    url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ManagementEnvironment.Default, `users/${core.url.encodePathParam(id)}/effective-permissions/sources/effective-roles`),
+                    method: "GET",
+                    headers: _headers,
+                    queryString: core.url
+                        .queryBuilder()
+                        .addMany(_queryParams)
+                        .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
+                        .build(),
+                    timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
+                    maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
+                    abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                    fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.fetch,
+                    logging: this._options.logging,
+                });
+                if (_response.ok) {
+                    return {
+                        data: _response.body,
+                        rawResponse: _response.rawResponse,
+                    };
+                }
+                if (_response.error.reason === "status-code") {
+                    switch (_response.error.statusCode) {
+                        case 400:
+                            throw new Management.BadRequestError(_response.error.body, _response.rawResponse);
+                        case 401:
+                            throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
+                        case 403:
+                            throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
+                        case 404:
+                            throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
+                        case 429:
+                            throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                        default:
+                            throw new errors.ManagementError({
+                                statusCode: _response.error.statusCode,
+                                body: _response.error.body,
+                                rawResponse: _response.rawResponse,
+                            });
+                    }
+                }
+                return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/users/{id}/effective-permissions/sources/effective-roles");
+            }));
+            const dataWithRawResponse = yield list(request).withRawResponse();
+            return new core.Page({
+                response: dataWithRawResponse.data,
+                rawResponse: dataWithRawResponse.rawResponse,
+                hasNextPage: (response) => (response === null || response === void 0 ? void 0 : response.next) != null && !(typeof (response === null || response === void 0 ? void 0 : response.next) === "string" && (response === null || response === void 0 ? void 0 : response.next) === ""),
+                getItems: (response) => { var _a; return (_a = response === null || response === void 0 ? void 0 : response.roles) !== null && _a !== void 0 ? _a : []; },
+                loadPage: (response) => {
+                    return list(core.setObjectProperty(request, "from", response === null || response === void 0 ? void 0 : response.next));
+                },
+            });
+        });
+    }
+}

package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/client/index.d.mts

@@ -0,0 +1 @@
+export {};

package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/client/index.mjs

@@ -0,0 +1 @@
+export {};