Approval programs: create, get, list

Reference for Approval, one group of Approval programs.

Approval.create

Creates an Approval. Verb page.

Text

do: return await $.Approval.create(input)

Emits Approval.created.

Inputs

Input	Type	Description
`by`	Worker	The Worker that performed it.
`for`	Party	The Party it was done on behalf of.
`via`	`string`	The Interface or request it arrived through.
`on`	`string`	The Action or Event that caused it, such as the failed attempt a retry follows.
`thing`	`string`	The record, at the Version the Action was decided against.
`input`	`json`	The input it was called with.
`createdAt`	`datetime`	When it was called.
`reserved`	`money`	The most this Action may cost, held against its Limits from the check until it settles, billed misses included.
`due`	`datetime`	When the Task is due.
`priority`	`integer`	Its rank in the inbox, highest first.
`recurrence`	`string`	The schedule a recurring duty repeats on.
`verdict`	`string`	One of `allowed` or `refused`.
`deadline`	`datetime`	When an unanswered Approval cancels the Action.
`action`	Action	An Approval holds one pending Action that exceeds a Limit or Mandate until someone allows or refuses it.

Returns

Output	Type	Required	Description
`approval`	Approval	required	The Approval.

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Approval.create({ by: 'worker_whZFpOKWIV' })"
  }
}

Returns one Approval by id. Verb page.

Text

do: return await $.Approval.get(input)

Reads only: it emits no Event.

Inputs

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

Returns

Output	Type	Required	Description
`approval`	Approval	required	The Approval.

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Approval.get({ id: 'approval_TlxQeWh9uX' })"
  }
}

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

Text

do: return await $.Approval.list(input)

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
`approvals`	list of Approval	required	One page of Approvals.

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Approval.list({ limit: 20 })"
  }
}