import { APIResource } from "../../../resource.js"; import * as Core from "../../../core.js"; import * as Shared from "../../shared.js"; import { TokensV4PagePaginationArray } from "../../shared.js"; import * as PermissionGroupsAPI from "./permission-groups.js"; import { PermissionGroupListParams, PermissionGroupListResponse, PermissionGroupListResponsesSinglePage, PermissionGroups } from "./permission-groups.js"; import * as ValueAPI from "./value.js"; import { Value, ValueUpdateParams } from "./value.js"; import { type V4PagePaginationArrayParams } from "../../../pagination.js"; export declare class Tokens extends APIResource { permissionGroups: PermissionGroupsAPI.PermissionGroups; value: ValueAPI.Value; /** * Create a new access token. * * @example * ```ts * const token = await client.user.tokens.create({ * name: 'readonly token', * policies: [ * { * effect: 'allow', * permission_groups: [ * { id: 'c8fed203ed3043cba015a93ad1616f1f' }, * { id: '82e64a83756745bbbb1c9c2701bf816b' }, * ], * resources: { foo: 'string' }, * }, * ], * }); * ``` */ create(body: TokenCreateParams, options?: Core.RequestOptions): Core.APIPromise; /** * Update an existing token. * * @example * ```ts * const token = await client.user.tokens.update( * 'ed17574386854bf78a67040be0a770b0', * { * name: 'readonly token', * policies: [ * { * effect: 'allow', * permission_groups: [ * { id: 'c8fed203ed3043cba015a93ad1616f1f' }, * { id: '82e64a83756745bbbb1c9c2701bf816b' }, * ], * resources: { foo: 'string' }, * }, * ], * }, * ); * ``` */ update(tokenId: string, body: TokenUpdateParams, options?: Core.RequestOptions): Core.APIPromise; /** * List all access tokens you created. * * @example * ```ts * // Automatically fetches more pages as needed. * for await (const token of client.user.tokens.list()) { * // ... * } * ``` */ list(query?: TokenListParams, options?: Core.RequestOptions): Core.PagePromise; list(options?: Core.RequestOptions): Core.PagePromise; /** * Destroy a token. * * @example * ```ts * const token = await client.user.tokens.delete( * 'ed17574386854bf78a67040be0a770b0', * ); * ``` */ delete(tokenId: string, options?: Core.RequestOptions): Core.APIPromise; /** * Get information about a specific token. * * @example * ```ts * const token = await client.user.tokens.get( * 'ed17574386854bf78a67040be0a770b0', * ); * ``` */ get(tokenId: string, options?: Core.RequestOptions): Core.APIPromise; /** * Test whether a token works. * * @example * ```ts * const response = await client.user.tokens.verify(); * ``` */ verify(options?: Core.RequestOptions): Core.APIPromise; } export interface TokenCreateResponse { /** * Token identifier tag. */ id?: string; condition?: TokenCreateResponse.Condition; /** * The expiration time on or after which the JWT MUST NOT be accepted for * processing. */ expires_on?: string; /** * The time on which the token was created. */ issued_on?: string; /** * Last time the token was used. */ last_used_on?: string; /** * Last time the token was modified. */ modified_on?: string; /** * Token name. */ name?: string; /** * The time before which the token MUST NOT be accepted for processing. */ not_before?: string; /** * List of access policies assigned to the token. */ policies?: Array; /** * Status of the token. */ status?: 'active' | 'disabled' | 'expired'; /** * The token value. */ value?: Shared.TokenValue; } export declare namespace TokenCreateResponse { interface Condition { /** * Client IP restrictions. */ request_ip?: Condition.RequestIP; } namespace Condition { /** * Client IP restrictions. */ interface RequestIP { /** * List of IPv4/IPv6 CIDR addresses. */ in?: Array; /** * List of IPv4/IPv6 CIDR addresses. */ not_in?: Array; } } } export interface TokenDeleteResponse { /** * Identifier */ id: string; } export interface TokenVerifyResponse { /** * Token identifier tag. */ id: string; /** * Status of the token. */ status: 'active' | 'disabled' | 'expired'; /** * The expiration time on or after which the JWT MUST NOT be accepted for * processing. */ expires_on?: string; /** * The time before which the token MUST NOT be accepted for processing. */ not_before?: string; } export interface TokenCreateParams { /** * Token name. */ name: string; /** * List of access policies assigned to the token. */ policies: Array; condition?: TokenCreateParams.Condition; /** * The expiration time on or after which the JWT MUST NOT be accepted for * processing. */ expires_on?: string; /** * The time before which the token MUST NOT be accepted for processing. */ not_before?: string; } export declare namespace TokenCreateParams { interface Condition { /** * Client IP restrictions. */ request_ip?: Condition.RequestIP; } namespace Condition { /** * Client IP restrictions. */ interface RequestIP { /** * List of IPv4/IPv6 CIDR addresses. */ in?: Array; /** * List of IPv4/IPv6 CIDR addresses. */ not_in?: Array; } } } export interface TokenUpdateParams { /** * Token name. */ name: string; /** * List of access policies assigned to the token. */ policies: Array; condition?: TokenUpdateParams.Condition; /** * The expiration time on or after which the JWT MUST NOT be accepted for * processing. */ expires_on?: string; /** * The time before which the token MUST NOT be accepted for processing. */ not_before?: string; /** * Status of the token. */ status?: 'active' | 'disabled' | 'expired'; } export declare namespace TokenUpdateParams { interface Condition { /** * Client IP restrictions. */ request_ip?: Condition.RequestIP; } namespace Condition { /** * Client IP restrictions. */ interface RequestIP { /** * List of IPv4/IPv6 CIDR addresses. */ in?: Array; /** * List of IPv4/IPv6 CIDR addresses. */ not_in?: Array; } } } export interface TokenListParams extends V4PagePaginationArrayParams { /** * Direction to order results. */ direction?: 'asc' | 'desc'; } export declare namespace Tokens { export { type TokenCreateResponse as TokenCreateResponse, type TokenDeleteResponse as TokenDeleteResponse, type TokenVerifyResponse as TokenVerifyResponse, type TokenCreateParams as TokenCreateParams, type TokenUpdateParams as TokenUpdateParams, type TokenListParams as TokenListParams, }; export { PermissionGroups as PermissionGroups, type PermissionGroupListResponse as PermissionGroupListResponse, PermissionGroupListResponsesSinglePage as PermissionGroupListResponsesSinglePage, type PermissionGroupListParams as PermissionGroupListParams, }; export { Value as Value, type ValueUpdateParams as ValueUpdateParams }; } export { TokensV4PagePaginationArray }; //# sourceMappingURL=tokens.d.ts.map