Role methods: create, get, list

Reference for Role, one group of Role methods.

Role.create

Creates a Role. Verb page.

TypeScript

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

Emits Role.created.

Inputs

Input	Type	Required	Description
`name`	`string`	required	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.
`team`	Team		A Team groups the Roles that do one kind of work under one owner.

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.create({ name: 'Leaseline' })

Returns one Role by id. Verb page.

TypeScript

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

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Role.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

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.get({ id: 'role_oloMFMUeCH' })

Returns Roles, newest first, one page at a time. Verb page.

TypeScript

interface RoleVerbs {
  list(input?: RoleListInput, options?: SB.CallOptions): SB.ListCall<Role>
}

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`roles`	list of Role	required	One page of Roles.

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 roles = await $.Role.list({ limit: 20 })