50 lines
1.6 KiB
TypeScript
50 lines
1.6 KiB
TypeScript
import { APIResource } from "../../resource.js";
|
|
import * as Core from "../../core.js";
|
|
import * as Shared from "../shared.js";
|
|
import { RolesV4PagePaginationArray } from "../shared.js";
|
|
import { type V4PagePaginationArrayParams } from "../../pagination.js";
|
|
export declare class Roles extends APIResource {
|
|
/**
|
|
* Get all available roles for an account.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* // Automatically fetches more pages as needed.
|
|
* for await (const role of client.accounts.roles.list({
|
|
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
|
|
* })) {
|
|
* // ...
|
|
* }
|
|
* ```
|
|
*/
|
|
list(params: RoleListParams, options?: Core.RequestOptions): Core.PagePromise<RolesV4PagePaginationArray, Shared.Role>;
|
|
/**
|
|
* Get information about a specific role for an account.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* const role = await client.accounts.roles.get(
|
|
* '3536bcfad5faccb999b47003c79917fb',
|
|
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
|
|
* );
|
|
* ```
|
|
*/
|
|
get(roleId: string, params: RoleGetParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Role>;
|
|
}
|
|
export interface RoleListParams extends V4PagePaginationArrayParams {
|
|
/**
|
|
* Path param: Account identifier tag.
|
|
*/
|
|
account_id: string;
|
|
}
|
|
export interface RoleGetParams {
|
|
/**
|
|
* Account identifier tag.
|
|
*/
|
|
account_id: string;
|
|
}
|
|
export declare namespace Roles {
|
|
export { type RoleListParams as RoleListParams, type RoleGetParams as RoleGetParams };
|
|
}
|
|
export { RolesV4PagePaginationArray };
|
|
//# sourceMappingURL=roles.d.ts.map
|