Skip to content

Reserved Act methods: update, delete

The Reserved Act Verbs update, delete as typed SDK methods, with inputs, result, refusals and an example.

Reference for Reserved Act, one group of Reserved Act methods.

ReservedAct.update

Changes the given properties of a Reserved Act. Verb page.

TypeScript
interface ReservedActVerbs {
  update(input: ReservedActUpdateInput, options?: SB.CallOptions): SB.Call<ReservedAct>
}

Emits ReservedAct.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Reserved Act.
jurisdictionstringWhere the law reserves it.

Returns

OutputTypeRequiredDescription
reservedActReserved ActrequiredThe Reserved Act.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse 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 reservedAct = await $.ReservedAct.update({ id: 'reserved_PKPVsB1HFf', jurisdiction: 'US-DE' })

ReservedAct.delete

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

TypeScript
interface ReservedActVerbs {
  delete(input: ReservedActDeleteInput, options?: SB.CallOptions): SB.Call<ReservedAct>
}

Emits ReservedAct.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Reserved Act.

Returns

OutputTypeRequiredDescription
reservedActReserved ActrequiredThe Reserved Act.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse 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 reservedAct = await $.ReservedAct.delete({ id: 'reserved_PKPVsB1HFf' })