AeontelAeontel Docs

Organization Members hooks

Hand-written shim. Implementation is generated; see ./organization-members.gen.

Hooks

useAddOrganizationMember mutation

Add a member to an organization.

TypeScript
useAddOrganizationMember(options?: MutationOpts<OrganizationMember, AddOrganizationMemberParams>)

Types: OrganizationMember · AddOrganizationMemberParams

useListOrganizationMembers query

List organization members.

TypeScript
useListOrganizationMembers(params?: Omit<ListOrganizationMembersParams, | > & { filter?: OrganizationMemberFilter; orderBy?: OrganizationMemberOrderBy[]; } & OrganizationMemberShorthands, options?: QueryOpts<Page<OrganizationMember>>)

Types: ListOrganizationMembersParams · OrganizationMemberFilter · OrganizationMemberOrderBy · OrganizationMemberShorthands · Page · OrganizationMember

useRemoveOrganizationMember mutation

Remove an organization member.

TypeScript
useRemoveOrganizationMember(options?: MutationOpts<SuccessResponse, RemoveOrganizationMemberParams>)

Types: SuccessResponse · RemoveOrganizationMemberParams

useRetrieveOrganizationMember query

Get an organization member by ID.

TypeScript
useRetrieveOrganizationMember(id: string, options?: QueryOpts<OrganizationMember>)

Types: OrganizationMember

useUpdateOrganizationMember mutation

Update an organization member.

TypeScript
useUpdateOrganizationMember(options?: MutationOpts<OrganizationMember, UpdateOrganizationMemberParams>)

Types: OrganizationMember · UpdateOrganizationMemberParams