AeontelAeontel Docs

Workspace Members hooks

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

Hooks

useAddWorkspaceMember mutation

Add a member to a workspace.

TypeScript
useAddWorkspaceMember(options?: MutationOpts<WorkspaceMember, AddWorkspaceMemberParams>)

Types: WorkspaceMember · AddWorkspaceMemberParams

useListWorkspaceMembers query

List workspace members.

TypeScript
useListWorkspaceMembers(params?: Omit<ListWorkspaceMembersParams, | > & { filter?: WorkspaceMemberFilter; orderBy?: WorkspaceMemberOrderBy[]; } & WorkspaceMemberShorthands, options?: QueryOpts<Page<WorkspaceMember>>)

Types: ListWorkspaceMembersParams · WorkspaceMemberFilter · WorkspaceMemberOrderBy · WorkspaceMemberShorthands · Page · WorkspaceMember

useRemoveWorkspaceMember mutation

Remove a workspace member.

TypeScript
useRemoveWorkspaceMember(options?: MutationOpts<SuccessResponse, RemoveWorkspaceMemberParams>)

Types: SuccessResponse · RemoveWorkspaceMemberParams

useRetrieveWorkspaceMember query

Get a workspace member by ID.

TypeScript
useRetrieveWorkspaceMember(id: string, options?: QueryOpts<WorkspaceMember>)

Types: WorkspaceMember

useUpdateWorkspaceMember mutation

Update a workspace member.

TypeScript
useUpdateWorkspaceMember(options?: MutationOpts<WorkspaceMember, UpdateWorkspaceMemberParams>)

Types: WorkspaceMember · UpdateWorkspaceMemberParams