AeontelAeontel Docs

Teams hooks

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

Hooks

useCreateTeam mutation

Create a team.

TypeScript
useCreateTeam(options?: MutationOpts<Team, CreateTeamParams>)

Types: Team · CreateTeamParams

useDeleteTeam mutation

Soft-delete a team.

TypeScript
useDeleteTeam(options?: MutationOpts<SuccessResponse, string>)

Types: SuccessResponse

useListTeams query

List teams.

TypeScript
useListTeams(params?: Omit<ListTeamsParams, | > & { filter?: TeamFilter; orderBy?: TeamOrderBy[]; } & TeamShorthands, options?: QueryOpts<Page<Team>>)

Types: ListTeamsParams · TeamFilter · TeamOrderBy · TeamShorthands · Page · Team

usePurgeTeam composite

Permanently delete a soft-deleted team.

TypeScript
usePurgeTeam(options?: MutationOpts<SuccessResponse, PurgeTeamParams>)

Types: SuccessResponse · PurgeTeamParams

useRestoreTeam composite

Restore a soft-deleted team.

TypeScript
useRestoreTeam(options?: MutationOpts<Team, string>)

Types: Team

useRetrieveTeam query

Get a team by ID.

TypeScript
useRetrieveTeam(id: string, options?: QueryOpts<Team>)

Types: Team

useUpdateTeam mutation

Update a team.

TypeScript
useUpdateTeam(options?: MutationOpts<Team, UpdateTeamParams>)

Types: Team · UpdateTeamParams