Role methods: update, delete

Reference for Role, one group of Role methods.

Role.update

Changes the given properties of a Role. Verb page.

TypeScript

interface RoleVerbs {
  update(input: RoleUpdateInput, options?: SB.CallOptions): SB.Call<Role>
}

Emits Role.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Role.
`name`	`string`		The title of the seat.
`responsibilities`	`text`		The work the seat owns.
`approvals`	`json`		What waits for the founder: rules by action class (`spend`, `sign`, `publish`, `price`, `send`), each optionally above an amount in USD.

Returns

Output	Type	Required	Description
`role`	Role	required	The Role.

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 role = await $.Role.update({ id: 'role_oloMFMUeCH', name: 'Leaseline' })

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

TypeScript

interface RoleVerbs {
  delete(input: RoleDeleteInput, options?: SB.CallOptions): SB.Call<Role>
}

Emits Role.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`role`	Role	required	The Role.

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 role = await $.Role.delete({ id: 'role_oloMFMUeCH' })