Thing methods: update, delete

Reference for Thing, one group of Thing methods.

Thing.update

Changes the given properties of a Thing. Verb page.

TypeScript

interface ThingVerbs {
  update(input: ThingUpdateInput, options?: SB.CallOptions): SB.Call<Thing>
}

Emits Thing.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Thing.
`type`	list of Noun		The Nouns this Thing is an instance of.
`outside`	`json`		The ids this Thing has in outside tools, one per Integration, so a re-run matches instead of duplicating.

Returns

Output	Type	Required	Description
`thing`	Thing	required	The Thing.

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 thing = await $.Thing.update({ id: 'thing_8ds0r9vvRl', type: ['noun_v0akLUrXCN'] })

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

TypeScript

interface ThingVerbs {
  delete(input: ThingDeleteInput, options?: SB.CallOptions): SB.Call<Thing>
}

Emits Thing.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`thing`	Thing	required	The Thing.

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 thing = await $.Thing.delete({ id: 'thing_8ds0r9vvRl' })