Trigger methods: update, delete

Reference for Trigger, one group of Trigger methods.

Trigger.update

Changes the given properties of a Trigger. Verb page.

TypeScript

interface TriggerVerbs {
  update(input: TriggerUpdateInput, options?: SB.CallOptions): SB.Call<Trigger>
}

Emits Trigger.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Trigger.
`event`	`string`		The Event selector it matches, such as `Order.placed`.
`schedule`	`string`		A cadence or cron expression.
`where`	`string`		The predicate an `event` Trigger matches, such as `choice = 'raise'`.
`threshold`	`json`		A Metric staying below or above a value, optionally for a while, such as four weeks.
`at`	`string`		When in its cadence a schedule runs, on the namespace’s clock, such as `mon 09:00`.

Returns

Output	Type	Required	Description
`trigger`	Trigger	required	The Trigger.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const trigger = await $.Trigger.update({ id: 'trigger_Hg9n0lrBdP', threshold: {} })

Deletes a Trigger: a soft delete that keeps its history, undone by Thing.restore. Verb page.

TypeScript

interface TriggerVerbs {
  delete(input: TriggerDeleteInput, options?: SB.CallOptions): SB.Call<Trigger>
}

Emits Trigger.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Trigger.

Returns

Output	Type	Required	Description
`trigger`	Trigger	required	The Trigger.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const trigger = await $.Trigger.delete({ id: 'trigger_Hg9n0lrBdP' })