Action methods: resume, retry, undo

Reference for Action, one group of Action methods.

Action.resume

Resume ends a pause and lets the Action run as reviewed, or reopen what remained of its delay window. Verb page.

TypeScript

interface ActionVerbs {
  resume(input: ActionResumeInput, options?: SB.CallOptions): SB.Call<Action>
}

Inputs

Input	Type	Required	Description
`action`	Action	required	The paused Action.
`reason`	`text`	required	Why it may proceed.

Returns

Output	Type	Required	Description
`action`	Action	required	The resumed Action.

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 action = await $.Action.resume({ action: 'act_br07HsG8MG', reason: 'Example reason' })

Retry runs a failed Action again as a new Action linked to the one that failed. Verb page.

TypeScript

interface ActionVerbs {
  retry(input: ActionRetryInput, options?: SB.CallOptions): SB.Call<Action>
}

Inputs

Input	Type	Required	Description
`action`	Action	required	The failed Action.

Returns

Output	Type	Required	Description
`retry`	Action	required	The new Action.

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.
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const retry = await $.Action.retry({ action: 'act_br07HsG8MG' })

Undo reverses a done Action: it deletes the records the Action created and restores what it changed, each restorable. Verb page.

TypeScript

interface ActionVerbs {
  undo(input: ActionUndoInput, options?: SB.CallOptions): SB.Call<Action>
}

Inputs

Input	Type	Required	Description
`action`	Action	required	The done Action to undo.

Returns

Output	Type	Required	Description
`action`	Action	required	The undone Action, linked to the records it removed and restored.

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 action = await $.Action.undo({ action: 'act_br07HsG8MG' })