Flow methods: update, delete

Reference for Flow, one group of Flow methods.

Flow.update

Changes the given properties of a Flow. Verb page.

TypeScript

interface FlowVerbs {
  update(input: FlowUpdateInput, options?: SB.CallOptions): SB.Call<Flow>
}

Emits Flow.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Flow.
`persona`	Persona		The Persona it guides; its Role decides which Verbs each step offers.
`offer`	Offer		The Offer whose activation Event ends the Flow; time to value reads from first step to that Event.
`steps`	list of Dashboard		The Dashboards in order, first run first, each ending in the Verb that opens the next.

Returns

Output	Type	Required	Description
`flow`	Flow	required	The Flow.

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 flow = await $.Flow.update({ id: 'flow_uuJzIzjvrp', persona: 'persona_YdpO6wSexq' })

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

TypeScript

interface FlowVerbs {
  delete(input: FlowDeleteInput, options?: SB.CallOptions): SB.Call<Flow>
}

Emits Flow.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`flow`	Flow	required	The Flow.

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 flow = await $.Flow.delete({ id: 'flow_uuJzIzjvrp' })