AeontelAeontel Docs

Team Members hooks

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

Hooks

useAddTeamMember mutation

Add a member to a team.

TypeScript
useAddTeamMember(options?: MutationOpts<TeamMember, AddTeamMemberParams>)

Types: TeamMember · AddTeamMemberParams

useListTeamMembers query

List team members.

TypeScript
useListTeamMembers(params?: Omit<ListTeamMembersParams, | > & { filter?: TeamMemberFilter; orderBy?: TeamMemberOrderBy[]; } & TeamMemberShorthands, options?: QueryOpts<Page<TeamMember>>)

Types: ListTeamMembersParams · TeamMemberFilter · TeamMemberOrderBy · TeamMemberShorthands · Page · TeamMember

useRemoveTeamMember mutation

Remove a team member.

TypeScript
useRemoveTeamMember(options?: MutationOpts<SuccessResponse, RemoveTeamMemberParams>)

Types: SuccessResponse · RemoveTeamMemberParams

useRetrieveTeamMember query

Get a team member by ID.

TypeScript
useRetrieveTeamMember(id: string, options?: QueryOpts<TeamMember>)

Types: TeamMember

useUpdateTeamMember mutation

Update a team member.

TypeScript
useUpdateTeamMember(options?: MutationOpts<TeamMember, UpdateTeamMemberParams>)

Types: TeamMember · UpdateTeamMemberParams