Process methods: create, get, list

Reference for Process, one group of Process methods.

Process.create

Creates a Process. Verb page.

TypeScript

interface ProcessVerbs {
  create(input: ProcessCreateInput, options?: SB.CallOptions): SB.Call<Process>
}

Emits Process.created.

Inputs

Input	Type	Required	Description
`name`	`string`	required	The name in sentence case, such as `Month-end close`.
`says`	`text[]`		What a founder says to run, turn on, or ask about it.
`settings`	`json`		The Settings it reads: key, type, default, the founder’s sentence and the Verb that sets each.
`defaultOn`	`string[]`		The Product Templates it is on in by default.
`wakes`	`json`		The Events that wake it in the Startup’s own records.
`inputs`	`string[]`		The Nouns an Action reads at its start.
`outputs`	`string[]`		The Nouns a finished Action leaves behind, rolled up from its Workflows.
`outcome`	`text`		What a finished Action leaves true, in one sentence.
`serviceLevel`	`json`		Its target duration, clock, escalation Role, and the waits that stop the clock.
`scope`	`string`		Where it runs: `startup`, `studio`, or `any`.
`play`	Play		A Process runs the steps of a Play each time the Startup runs it.

Returns

Output	Type	Required	Description
`process`	Process	required	The Process.

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 process = await $.Process.create({ name: 'Leaseline' })

Returns one Process by id. Verb page.

TypeScript

interface ProcessVerbs {
  get(input: ProcessGetInput, options?: SB.CallOptions): SB.Call<Process>
}

Reads only: it emits no Event.

Inputs

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

Returns

Output	Type	Required	Description
`process`	Process	required	The Process.

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 process = await $.Process.get({ id: 'process_X2zteZ3CQI' })

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

TypeScript

interface ProcessVerbs {
  list(input?: ProcessListInput, options?: SB.CallOptions): SB.ListCall<Process>
}

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
`processes`	list of Process	required	One page of Processes.

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