Class Members

Hierarchy

HeyApiClient
- Members

Index

Methods

add list remove update

Methods

add

add<ThrowOnError extends boolean = true>(
    parameters: {
        organization: string;
        role: "admin" | "developer" | "reader";
        user: string;
    },
    options?: Options<never, ThrowOnError, unknown>,
): RequestResult<
    AddOrganizationMemberResponses,
    AddOrganizationMemberErrors,
    ThrowOnError,
    "data",
>
Add an organization member
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- parameters: { organization: string; role: "admin" | "developer" | "reader"; user: string }
- Optionaloptions: Options<never, ThrowOnError, unknown>
Returns RequestResult<
    AddOrganizationMemberResponses,
    AddOrganizationMemberErrors,
    ThrowOnError,
    "data",
>
- Defined in src/generated/sdk.gen.ts:712

list

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

remove

remove<ThrowOnError extends boolean = true>(
    parameters: { organization: string; user: string },
    options?: Options<never, ThrowOnError, unknown>,
): RequestResult<
    RemoveOrganizationMemberResponses,
    RemoveOrganizationMemberErrors,
    ThrowOnError,
    "data",
>
Remove an organization member
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- parameters: { organization: string; user: string }
- Optionaloptions: Options<never, ThrowOnError, unknown>
Returns RequestResult<
    RemoveOrganizationMemberResponses,
    RemoveOrganizationMemberErrors,
    ThrowOnError,
    "data",
>
- Defined in src/generated/sdk.gen.ts:766

update

update<ThrowOnError extends boolean = true>(
    parameters: {
        organization: string;
        role: "admin" | "developer" | "reader";
        user: string;
    },
    options?: Options<never, ThrowOnError, unknown>,
): RequestResult<
    UpdateOrganizationMemberResponses,
    UpdateOrganizationMemberErrors,
    ThrowOnError,
    "data",
>
Change an organization member role
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- parameters: { organization: string; role: "admin" | "developer" | "reader"; user: string }
- Optionaloptions: Options<never, ThrowOnError, unknown>
Returns RequestResult<
    UpdateOrganizationMemberResponses,
    UpdateOrganizationMemberErrors,
    ThrowOnError,
    "data",
>
- Defined in src/generated/sdk.gen.ts:813

Class Members

Hierarchy

Index

Methods

Methods

add

Type Parameters

Parameters

Returns RequestResult<
    AddOrganizationMemberResponses,
    AddOrganizationMemberErrors,
    ThrowOnError,
    "data",
>

list

Type Parameters

Parameters

Returns RequestResult<
    ListOrganizationMembersResponses,
    ListOrganizationMembersErrors,
    ThrowOnError,
    "data",
>

remove

Type Parameters

Parameters

Returns RequestResult<
    RemoveOrganizationMemberResponses,
    RemoveOrganizationMemberErrors,
    ThrowOnError,
    "data",
>

update

Type Parameters

Parameters

Returns RequestResult<
    UpdateOrganizationMemberResponses,
    UpdateOrganizationMemberErrors,
    ThrowOnError,
    "data",
>

Settings

On This Page

Class Members

Hierarchy

Index

Methods

Methods

add

Type Parameters

Parameters

Returns RequestResult< AddOrganizationMemberResponses, AddOrganizationMemberErrors, ThrowOnError, "data",>

list

Type Parameters

Parameters

Returns RequestResult< ListOrganizationMembersResponses, ListOrganizationMembersErrors, ThrowOnError, "data",>

remove

Type Parameters

Parameters

Returns RequestResult< RemoveOrganizationMemberResponses, RemoveOrganizationMemberErrors, ThrowOnError, "data",>

update

Type Parameters

Parameters

Returns RequestResult< UpdateOrganizationMemberResponses, UpdateOrganizationMemberErrors, ThrowOnError, "data",>

Settings

On This Page

Returns RequestResult<
AddOrganizationMemberResponses,
AddOrganizationMemberErrors,
ThrowOnError,
"data",
>

Returns RequestResult<
ListOrganizationMembersResponses,
ListOrganizationMembersErrors,
ThrowOnError,
"data",
>

Returns RequestResult<
RemoveOrganizationMemberResponses,
RemoveOrganizationMemberErrors,
ThrowOnError,
"data",
>

Returns RequestResult<
UpdateOrganizationMemberResponses,
UpdateOrganizationMemberErrors,
ThrowOnError,
"data",
>