Risk methods: create, get, list

Reference for Risk, one group of Risk methods.

Risk.create

Creates a Risk. Verb page.

TypeScript

interface RiskVerbs {
  create(input: RiskCreateInput, options?: SB.CallOptions): SB.Call<Risk>
}

Emits Risk.created.

Inputs

Input	Type	Required	Description
`scope`	`string`	required	Whose Risk it is: `startup` or `portfolio`, for exposure shared across siblings.
`likelihood`	`integer`	required	How likely it is within a year, from 1 (rare) to 5 (expected).
`impact`	`integer`	required	How much harm it does if it happens, from 1 (minor) to 5 (ends the Startup).
`treatment`	`string`		The chosen response: `treat`, `accept`, `transfer`, or `avoid`.
`owner`	Role	required	The Role that owns the Risk and its next review.
`reviewBy`	`date`		When the owner next scores it again.
`portfolio`	Portfolio		Exposure shared across sibling Startups, such as one upstream every sibling relies on.

Returns

Output	Type	Required	Description
`risk`	Risk	required	The Risk.

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 risk = await $.Risk.create({ scope: 'Example scope', likelihood: 1, impact: 1, owner: 'role_oloMFMUeCH' })

Returns one Risk by id. Verb page.

TypeScript

interface RiskVerbs {
  get(input: RiskGetInput, options?: SB.CallOptions): SB.Call<Risk>
}

Reads only: it emits no Event.

Inputs

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

Returns

Output	Type	Required	Description
`risk`	Risk	required	The Risk.

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 risk = await $.Risk.get({ id: 'risk_a3Rw0qcmRy' })

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

TypeScript

interface RiskVerbs {
  list(input?: RiskListInput, options?: SB.CallOptions): SB.ListCall<Risk>
}

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
`risks`	list of Risk	required	One page of Risks.

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