// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. import { APIResource } from '../../../resource'; import * as Core from '../../../core'; import * as Shared from '../../shared'; import { TokensV4PagePaginationArray } from '../../shared'; import * as PermissionGroupsAPI from './permission-groups'; import { PermissionGroupGetParams, PermissionGroupGetResponse, PermissionGroupGetResponsesSinglePage, PermissionGroupListParams, PermissionGroupListResponse, PermissionGroupListResponsesSinglePage, PermissionGroups, } from './permission-groups'; import * as ValueAPI from './value'; import { Value, ValueUpdateParams } from './value'; import { type V4PagePaginationArrayParams } from '../../../pagination'; export class Tokens extends APIResource { permissionGroups: PermissionGroupsAPI.PermissionGroups = new PermissionGroupsAPI.PermissionGroups( this._client, ); value: ValueAPI.Value = new ValueAPI.Value(this._client); /** * Create a new Account Owned API token. */ create(params: TokenCreateParams, options?: Core.RequestOptions): Core.APIPromise { const { account_id, ...body } = params; return ( this._client.post(`/accounts/${account_id}/tokens`, { body, ...options }) as Core.APIPromise<{ result: TokenCreateResponse; }> )._thenUnwrap((obj) => obj.result); } /** * Update an existing token. */ update( tokenId: string, params: TokenUpdateParams, options?: Core.RequestOptions, ): Core.APIPromise { const { account_id, ...body } = params; return ( this._client.put(`/accounts/${account_id}/tokens/${tokenId}`, { body, ...options }) as Core.APIPromise<{ result: Shared.Token; }> )._thenUnwrap((obj) => obj.result); } /** * List all Account Owned API tokens created for this account. */ list( params: TokenListParams, options?: Core.RequestOptions, ): Core.PagePromise { const { account_id, ...query } = params; return this._client.getAPIList(`/accounts/${account_id}/tokens`, TokensV4PagePaginationArray, { query, ...options, }); } /** * Destroy an Account Owned API token. */ delete( tokenId: string, params: TokenDeleteParams, options?: Core.RequestOptions, ): Core.APIPromise { const { account_id } = params; return ( this._client.delete(`/accounts/${account_id}/tokens/${tokenId}`, options) as Core.APIPromise<{ result: TokenDeleteResponse | null; }> )._thenUnwrap((obj) => obj.result); } /** * Get information about a specific Account Owned API token. */ get(tokenId: string, params: TokenGetParams, options?: Core.RequestOptions): Core.APIPromise { const { account_id } = params; return ( this._client.get(`/accounts/${account_id}/tokens/${tokenId}`, options) as Core.APIPromise<{ result: Shared.Token; }> )._thenUnwrap((obj) => obj.result); } /** * Test whether a token works. */ verify(params: TokenVerifyParams, options?: Core.RequestOptions): Core.APIPromise { const { account_id } = params; return ( this._client.get(`/accounts/${account_id}/tokens/verify`, options) as Core.APIPromise<{ result: TokenVerifyResponse; }> )._thenUnwrap((obj) => obj.result); } } 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 namespace TokenCreateResponse { export interface Condition { /** * Client IP restrictions. */ request_ip?: Condition.RequestIP; } export namespace Condition { /** * Client IP restrictions. */ export 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 { /** * Path param: Account identifier tag. */ account_id: string; /** * Body param: Token name. */ name: string; /** * Body param: List of access policies assigned to the token. */ policies: Array; /** * Body param: */ condition?: TokenCreateParams.Condition; /** * Body param: The expiration time on or after which the JWT MUST NOT be accepted * for processing. */ expires_on?: string; /** * Body param: The time before which the token MUST NOT be accepted for processing. */ not_before?: string; } export namespace TokenCreateParams { export interface Condition { /** * Client IP restrictions. */ request_ip?: Condition.RequestIP; } export namespace Condition { /** * Client IP restrictions. */ export interface RequestIP { /** * List of IPv4/IPv6 CIDR addresses. */ in?: Array; /** * List of IPv4/IPv6 CIDR addresses. */ not_in?: Array; } } } export interface TokenUpdateParams { /** * Path param: Account identifier tag. */ account_id: string; /** * Body param: Token name. */ name: string; /** * Body param: List of access policies assigned to the token. */ policies: Array; /** * Body param: Status of the token. */ status: 'active' | 'disabled' | 'expired'; /** * Body param: */ condition?: TokenUpdateParams.Condition; /** * Body param: The expiration time on or after which the JWT MUST NOT be accepted * for processing. */ expires_on?: string; /** * Body param: The time before which the token MUST NOT be accepted for processing. */ not_before?: string; } export namespace TokenUpdateParams { export interface Condition { /** * Client IP restrictions. */ request_ip?: Condition.RequestIP; } export namespace Condition { /** * Client IP restrictions. */ export interface RequestIP { /** * List of IPv4/IPv6 CIDR addresses. */ in?: Array; /** * List of IPv4/IPv6 CIDR addresses. */ not_in?: Array; } } } export interface TokenListParams extends V4PagePaginationArrayParams { /** * Path param: Account identifier tag. */ account_id: string; /** * Query param: Direction to order results. */ direction?: 'asc' | 'desc'; } export interface TokenDeleteParams { /** * Account identifier tag. */ account_id: string; } export interface TokenGetParams { /** * Account identifier tag. */ account_id: string; } export interface TokenVerifyParams { /** * Account identifier tag. */ account_id: string; } Tokens.PermissionGroups = PermissionGroups; Tokens.PermissionGroupListResponsesSinglePage = PermissionGroupListResponsesSinglePage; Tokens.PermissionGroupGetResponsesSinglePage = PermissionGroupGetResponsesSinglePage; Tokens.Value = Value; 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, type TokenDeleteParams as TokenDeleteParams, type TokenGetParams as TokenGetParams, type TokenVerifyParams as TokenVerifyParams, }; export { PermissionGroups as PermissionGroups, type PermissionGroupListResponse as PermissionGroupListResponse, type PermissionGroupGetResponse as PermissionGroupGetResponse, PermissionGroupListResponsesSinglePage as PermissionGroupListResponsesSinglePage, PermissionGroupGetResponsesSinglePage as PermissionGroupGetResponsesSinglePage, type PermissionGroupListParams as PermissionGroupListParams, type PermissionGroupGetParams as PermissionGroupGetParams, }; export { Value as Value, type ValueUpdateParams as ValueUpdateParams }; } export { TokensV4PagePaginationArray };