Risk methods: accept, assess, close, treat
The Risk Verbs accept, assess, close, treat as typed SDK methods, with inputs, result, refusals and an example.
Reference for Risk, one group of Risk methods.
Risk.accept
Accept records an officer’s signed Decision to carry a Risk untreated until its next review. Verb page.
interface RiskVerbs {
accept(input: RiskAcceptInput, options?: SB.CallOptions): SB.Call<Risk>
}Emits Risk.accepted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
risk | Risk | required | The Risk to carry. |
reason | text | required | Why it is carried, recorded as a Decision. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
risk | Risk | required | The accepted 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
import { $ } from 'startup-builder'
const risk = await $.Risk.accept({ risk: 'risk_a3Rw0qcmRy', reason: 'Example reason' })Risk.assess
Assess scores a Risk’s likelihood and impact from the Startup’s records and sets its next review date. Verb page.
interface RiskVerbs {
assess(input: RiskAssessInput, options?: SB.CallOptions): SB.Call<Risk>
}Emits Risk.assessed.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
risk | Risk | required | The Risk to score. |
likelihood | integer | required | Likelihood from 1 to 5. |
impact | integer | required | Impact from 1 to 5. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
risk | Risk | required | The scored 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
import { $ } from 'startup-builder'
const risk = await $.Risk.assess({ risk: 'risk_a3Rw0qcmRy', likelihood: 1, impact: 1 })Risk.close
Close ends a Risk that can no longer happen and keeps it, with its scores and treatments, forever. Verb page.
interface RiskVerbs {
close(input: RiskCloseInput, options?: SB.CallOptions): SB.Call<Risk>
}Emits Risk.closed.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
risk | Risk | required | The Risk to close. |
reason | text | required | Why it can no longer happen. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
risk | Risk | required | The closed Risk, kept forever. |
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 risk = await $.Risk.close({ risk: 'risk_a3Rw0qcmRy', reason: 'Example reason' })Risk.treat
Treat links a Risk to the Controls that lower it and records the score it should reach. Verb page.
interface RiskVerbs {
treat(input: RiskTreatInput, options?: SB.CallOptions): SB.Call<Risk>
}Emits Risk.treated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
risk | Risk | required | The Risk to treat. |
controls | list of Control | required | The Controls that lower it. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
risk | Risk | required | The treated 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
import { $ } from 'startup-builder'
const risk = await $.Risk.treat({ risk: 'risk_a3Rw0qcmRy', controls: ['control_o4pMmXUeCH'] })