Verb methods: update, delete

Reference for Verb, one group of Verb methods.

Verb.update

Changes the given properties of a Verb. Verb page.

TypeScript

interface VerbVerbs {
  update(input: VerbUpdateInput, options?: SB.CallOptions): SB.Call<Verb>
}

Emits Verb.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Verb.
`name`	`string`		The camelCase action form.
`event`	`string`		The event the Verb emits.
`publishedIn`	Version		The first published Version that serves it; from then on, edits go through a Change and `delete` refuses.

Returns

Output	Type	Required	Description
`verb`	Verb	required	The Verb.

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 verb = await $.Verb.update({ id: 'verb_hlkWBvrAyZ', name: 'Leaseline' })

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

TypeScript

interface VerbVerbs {
  delete(input: VerbDeleteInput, options?: SB.CallOptions): SB.Call<Verb>
}

Emits Verb.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`verb`	Verb	required	The Verb.

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 verb = await $.Verb.delete({ id: 'verb_hlkWBvrAyZ' })