Skip to content

by Startups.Studio

Product What you sell Outcome Contract

OutcomeContract.update

PATCH /{namespace}/outcome-contracts/{id}

Changes the given properties of an Outcome Contract.

Noun: Outcome Contract
Mode: do
Event: OutcomeContract.updated

You, to your agent

Change the latest outcome contract.

curl -X PATCH https://api.sb/patentpad.com/outcome-contracts/outcome_contract_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"done":"Order.accepted"}'

import { $ } from 'startup-builder'

const outcomeContract = await $.OutcomeContract.update({ id: 'outcome_contract_1', done: 'Order.accepted' })

npx startup-builder do OutcomeContract.update --json '{"id":"outcome_contract_1","done":"Order.accepted"}'

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

Update changes the given properties of an Outcome Contract. It is inherited: every Noun has get, list, create, update and delete.

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.

Outputs

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

Effects

Emits OutcomeContract.updated.
Two-way: try, send, do.

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.	OutcomeContract.update

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

OutcomeContract.list

Previous Page

Product

Next Page