Class ApiKeys

Hierarchy

HeyApiClient
- ApiKeys

Index

Methods

create list revoke

Methods

create

create<ThrowOnError extends boolean = true>(
    parameters: { name: string },
    options?: Options<never, ThrowOnError, unknown>,
): RequestResult<
    CreateApiKeyResponses,
    CreateApiKeyErrors,
    ThrowOnError,
    "data",
>
Create an API key
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- parameters: { name: string }
- Optionaloptions: Options<never, ThrowOnError, unknown>
Returns RequestResult<CreateApiKeyResponses, CreateApiKeyErrors, ThrowOnError, "data">
- Defined in src/generated/sdk.gen.ts:578

list

list<ThrowOnError extends boolean = true>(
    parameters?: { amount?: number; page?: string },
    options?: Options<never, ThrowOnError, unknown>,
): RequestResult<
    ListApiKeysResponses,
    ListApiKeysErrors,
    ThrowOnError,
    "data",
>
List API keys
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionalparameters: { amount?: number; page?: string }
- Optionaloptions: Options<never, ThrowOnError, unknown>
Returns RequestResult<ListApiKeysResponses, ListApiKeysErrors, ThrowOnError, "data">
- Defined in src/generated/sdk.gen.ts:531

revoke

revoke<ThrowOnError extends boolean = true>(
    parameters: { api_key_id: string },
    options?: Options<never, ThrowOnError, unknown>,
): RequestResult<
    RevokeApiKeyResponses,
    RevokeApiKeyErrors,
    ThrowOnError,
    "data",
>
Revoke an API key
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- parameters: { api_key_id: string }
- Optionaloptions: Options<never, ThrowOnError, unknown>
Returns RequestResult<RevokeApiKeyResponses, RevokeApiKeyErrors, ThrowOnError, "data">
- Defined in src/generated/sdk.gen.ts:622