Sequence methods: update, delete

Reference for Sequence, one group of Sequence methods.

Sequence.update

Changes the given properties of a Sequence. Verb page.

TypeScript

interface SequenceVerbs {
  update(input: SequenceUpdateInput, options?: SB.CallOptions): SB.Call<Sequence>
}

Emits Sequence.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Sequence.
`steps`	`json`		The steps, waits, and branches.
`exitOn`	`string`		The Events that end it from any step, such as a reply or a purchase.

Returns

Output	Type	Required	Description
`sequence`	Sequence	required	The Sequence.

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 sequence = await $.Sequence.update({ id: 'sequence_H7knHGrBdP', steps: {} })

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

TypeScript

interface SequenceVerbs {
  delete(input: SequenceDeleteInput, options?: SB.CallOptions): SB.Call<Sequence>
}

Emits Sequence.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`sequence`	Sequence	required	The Sequence.

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 sequence = await $.Sequence.delete({ id: 'sequence_H7knHGrBdP' })