Decision methods
Every Decision Verb as a typed SDK method, with its inputs, result, refusals and an example.
Reference for Decision.
| Noun | System | Run by |
|---|---|---|
| Decision | Goals | Strategist |
Decision.create
Creates a Decision. Verb page.
interface DecisionVerbs {
create(input: DecisionCreateInput, options?: SB.CallOptions): SB.Call<Decision>
}Emits Decision.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
choice | text | required | What was chosen. |
reason | text | required | Why it was chosen. |
stakes | string | One of low, medium, or high, which sets the delay window. | |
thing | Thing | A Decision records one choice about a Thing and stays on that Thing’s record forever. | |
meeting | Meeting | A Meeting records Decisions, each with its options, choice and reason. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
decision | Decision | required | The Decision. |
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
import { $ } from 'startup-builder'
const decision = await $.Decision.create({ choice: 'Example choice', reason: 'Example reason' })Decision.get
Returns one Decision by id. Verb page.
interface DecisionVerbs {
get(input: DecisionGetInput, options?: SB.CallOptions): SB.Call<Decision>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Decision. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
decision | Decision | required | The Decision. |
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
import { $ } from 'startup-builder'
const decision = await $.Decision.get({ id: 'decision_ipoch3tTJh' })Decision.list
Returns Decisions, newest first, one page at a time. Verb page.
interface DecisionVerbs {
list(input?: DecisionListInput, options?: SB.CallOptions): SB.ListCall<Decision>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | 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 |
|---|---|---|---|
decisions | list of Decision | required | One page of Decisions. |
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
import { $ } from 'startup-builder'
const decisions = await $.Decision.list({ limit: 20 })Decision.supersede
Supersede replaces a Decision with a newer one, keeping both on record with the reason for the change. Verb page.
interface DecisionVerbs {
supersede(input: DecisionSupersedeInput, options?: SB.CallOptions): SB.Call<Decision>
}Emits Decision.superseded.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
decision | Decision | required | The Decision to replace. |
by | Decision | required | The newer Decision. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
decision | Decision | required | The superseded Decision. |
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. |
| The record is not in a state that allows this Verb, so the call is refused. | refused | Read the record, run the Verb that moves it to an allowed state, then retry. | None. |
Example
import { $ } from 'startup-builder'
const decision = await $.Decision.supersede({ decision: 'decision_ipoch3tTJh', by: 'decision_ipoch3tTJh' })