Class Organizations

Hierarchy

HeyApiClient
- Organizations

Index

Accessors

Methods

create delete get list transferOwnership

Accessors

members

get members(): Members
Returns Members
- Defined in src/generated/sdk.gen.ts:1088

Methods

create

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

delete

delete<ThrowOnError extends boolean = true>(
    parameters: { organization: string },
    options?: Options<never, ThrowOnError, unknown>,
): RequestResult<
    DeleteOrganizationResponses,
    DeleteOrganizationErrors,
    ThrowOnError,
    "data",
>
Delete an organization
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- parameters: { organization: string }
- Optionaloptions: Options<never, ThrowOnError, unknown>
Returns RequestResult<
    DeleteOrganizationResponses,
    DeleteOrganizationErrors,
    ThrowOnError,
    "data",
>
- Defined in src/generated/sdk.gen.ts:960

get

get<ThrowOnError extends boolean = true>(
    parameters: { organization: string },
    options?: Options<never, ThrowOnError, unknown>,
): RequestResult<
    GetOrganizationResponses,
    GetOrganizationErrors,
    ThrowOnError,
    "data",
>
Get an organization
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- parameters: { organization: string }
- Optionaloptions: Options<never, ThrowOnError, unknown>
Returns RequestResult<
    GetOrganizationResponses,
    GetOrganizationErrors,
    ThrowOnError,
    "data",
>
- Defined in src/generated/sdk.gen.ts:999

list

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

transferOwnership

transferOwnership<ThrowOnError extends boolean = true>(
    parameters: { organization: string; user: string },
    options?: Options<never, ThrowOnError, unknown>,
): RequestResult<
    TransferOrganizationOwnershipResponses,
    TransferOrganizationOwnershipErrors,
    ThrowOnError,
    "data",
>
Transfer organization ownership
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- parameters: { organization: string; user: string }
- Optionaloptions: Options<never, ThrowOnError, unknown>
Returns RequestResult<
    TransferOrganizationOwnershipResponses,
    TransferOrganizationOwnershipErrors,
    ThrowOnError,
    "data",
>
- Defined in src/generated/sdk.gen.ts:1038