AeontelAeontel Docs

Organizations hooks

Hand-written shim. Generated CRUD via ./organizations.gen. useGetOrganizationByHandle stays hand-written (custom op).

Hooks

useCreateOrganization mutation

Create an organization.

TypeScript
useCreateOrganization(options?: MutationOpts<Organization, CreateOrganizationParams>)

Types: Organization · CreateOrganizationParams

useDeleteOrganization mutation

Soft-delete an organization.

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

Types: SuccessResponse

useGetOrganizationByHandle query

TypeScript
useGetOrganizationByHandle(handle: string, options?: QueryOpts<Organization>)

Types: Organization

useListOrganizations query

List organizations.

TypeScript
useListOrganizations(params?: Omit<ListOrganizationsParams, | > & { filter?: OrganizationFilter; orderBy?: OrganizationOrderBy[]; } & OrganizationShorthands, options?: QueryOpts<Page<Organization>>)

Types: ListOrganizationsParams · OrganizationFilter · OrganizationOrderBy · OrganizationShorthands · Page · Organization

usePurgeOrganization composite

Permanently delete a soft-deleted organization.

TypeScript
usePurgeOrganization(options?: MutationOpts<SuccessResponse, PurgeOrganizationParams>)

Types: SuccessResponse · PurgeOrganizationParams

useRestoreOrganization composite

Restore a soft-deleted organization.

TypeScript
useRestoreOrganization(options?: MutationOpts<Organization, string>)

Types: Organization

useRetrieveOrganization query

Get an organization by ID.

TypeScript
useRetrieveOrganization(id: string, options?: QueryOpts<Organization>)

Types: Organization

useUpdateOrganization mutation

Update an organization.

TypeScript
useUpdateOrganization(options?: MutationOpts<Organization, UpdateOrganizationParams>)

Types: Organization · UpdateOrganizationParams