Problem methods: create, get, list

Reference for Problem, one group of Problem methods.

Problem.create

Creates a Problem. Verb page.

TypeScript

interface ProblemVerbs {
  create(input: ProblemCreateInput, options?: SB.CallOptions): SB.Call<Problem>
}

Emits Problem.created.

Inputs

Input	Type	Required	Description
`statement`	`text`	required	The struggle, in the words of the ICP.
`costPerPeriod`	`json`		What the Problem costs the ICP per period: hours times wage, or the spend on what they hire today.
`address`	`json`		The opportunity map cell it sits on: an occupation, a task it performs, and an industry.
`moment`	`text`		The moment the job starts, with the observable trigger that marks it.
`progress`	`text`		The progress the ICP wants, from the state before to the state after.
`hiredToday`	`json`		What the ICP hires for the job today, by kind and cost: software, a Service, their own hands, or nothing.

Returns

Output	Type	Required	Description
`problem`	Problem	required	The Problem.

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 problem = await $.Problem.create({ statement: 'Tracks lease renewals for small property managers.' })

Returns one Problem by id. Verb page.

TypeScript

interface ProblemVerbs {
  get(input: ProblemGetInput, options?: SB.CallOptions): SB.Call<Problem>
}

Reads only: it emits no Event.

Inputs

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

Returns

Output	Type	Required	Description
`problem`	Problem	required	The Problem.

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 problem = await $.Problem.get({ id: 'problem_UzvXXfKsJB' })

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

TypeScript

interface ProblemVerbs {
  list(input?: ProblemListInput, options?: SB.CallOptions): SB.ListCall<Problem>
}

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
`problems`	list of Problem	required	One page of Problems.

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