Outcome Contract programs · StartupBuilder

Noun	System	Run by
Outcome Contract	Service delivery	Delivery Manager

OutcomeContract.get

Returns one Outcome Contract by id. Verb page.

Text

do: return await $.OutcomeContract.get(input)

Reads only: it emits no Event.

Inputs

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

Returns

Output	Type	Required	Description
`outcomeContract`	Outcome Contract	required	The Outcome Contract.

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.OutcomeContract.get({ id: 'outcome_goNlouZJ7A' })"
  }
}

Returns Outcome Contracts, newest first, one page at a time. Verb page.

Text

do: return await $.OutcomeContract.list(input)

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
`outcomeContracts`	list of Outcome Contract	required	One page of Outcome Contracts.

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.OutcomeContract.list({ limit: 20 })"
  }
}

Changes the given properties of an Outcome Contract. Verb page.

Text

do: return await $.OutcomeContract.update(input)

Emits OutcomeContract.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Outcome Contract.
`done`	`text`		The state or Event that counts as done.
`accept`	`text`		Who accepts the result, and within what window.
`remedy`	`text`		What happens on a miss: redo, refund, or credit.
`revisions`	`integer`		How many times the Customer may send work back before the remedy applies, such as 1.
`silence`	`string`		What the Customer’s silence means once the acceptance window passes.
`earns`	`string`		The Event that captures payment and earns the fee.
`assurance`	`json`		The Evaluators that check done before every delivery, and the share of work a person grades, such as 2%.
`window`	`string`		How long the Customer has to confirm, revise or dispute each delivery, as an ISO duration.

Returns

Output	Type	Required	Description
`outcomeContract`	Outcome Contract	required	The Outcome Contract.

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.OutcomeContract.update({ id: 'outcome_goNlouZJ7A', done: 'Order.accepted' })"
  }
}