Mandate methods: create, get, list

Reference for Mandate, one group of Mandate methods.

Mandate.create

Creates a Mandate. Verb page.

TypeScript

interface MandateVerbs {
  create(input: MandateCreateInput, options?: SB.CallOptions): SB.Call<Mandate>
}

Emits Mandate.created.

Inputs

Input	Type	Required	Description
`expiresAt`	`datetime`	required	When it lapses.
`limit`	Limit		The Limit that bounds it.
`verb`	`string`		The Verb it covers, as `Noun.verb`.
`topics`	`string[]`		What it may act on; an Action outside them becomes an Approval.
`channels`	list of Channel		The Channels it may send through.
`agent`	Agent		A Mandate lets an Agent act without asking each time, within its Permissions and Limits, until it expires or is revoked.
`party`	Party		The Party who grants a Mandate is its principal: the Agent acts for them, and each Action records them as `for`.

Returns

Output	Type	Required	Description
`mandate`	Mandate	required	The Mandate.

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 mandate = await $.Mandate.create({ expiresAt: '2026-10-22T12:00:00Z' })

Returns one Mandate by id. Verb page.

TypeScript

interface MandateVerbs {
  get(input: MandateGetInput, options?: SB.CallOptions): SB.Call<Mandate>
}

Reads only: it emits no Event.

Inputs

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

Returns

Output	Type	Required	Description
`mandate`	Mandate	required	The Mandate.

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 mandate = await $.Mandate.get({ id: 'mandate_mKKPrmFQYD' })

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

TypeScript

interface MandateVerbs {
  list(input?: MandateListInput, options?: SB.CallOptions): SB.ListCall<Mandate>
}

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
`mandates`	list of Mandate	required	One page of Mandates.

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