AeontelAeontel Docs

Triggers hooks

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

Hooks

useCreateTrigger mutation

Create a trigger.

TypeScript
useCreateTrigger(options?: MutationOpts<Trigger, CreateTriggerParams>)

Types: Trigger · CreateTriggerParams

useDeleteTrigger mutation

Soft-delete a trigger.

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

Types: SuccessResponse

useListTriggers query

List triggers.

TypeScript
useListTriggers(params?: Omit<ListTriggersParams, | > & { filter?: TriggerFilter; orderBy?: TriggerOrderBy[]; } & TriggerShorthands, options?: QueryOpts<Page<Trigger>>)

Types: ListTriggersParams · TriggerFilter · TriggerOrderBy · TriggerShorthands · Page · Trigger

usePurgeTrigger composite

Permanently delete a soft-deleted trigger.

TypeScript
usePurgeTrigger(options?: MutationOpts<SuccessResponse, PurgeTriggerParams>)

Types: SuccessResponse · PurgeTriggerParams

useRestoreTrigger composite

Restore a soft-deleted trigger.

TypeScript
useRestoreTrigger(options?: MutationOpts<Trigger, string>)

Types: Trigger

useRetrieveTrigger query

Get a trigger by ID.

TypeScript
useRetrieveTrigger(id: string, options?: QueryOpts<Trigger>)

Types: Trigger

useUpdateTrigger mutation

Update a trigger.

TypeScript
useUpdateTrigger(options?: MutationOpts<Trigger, UpdateTriggerParams>)

Types: Trigger · UpdateTriggerParams