Human methods: release, remit, suspend

Reference for Human, one group of Human methods.

Human.release

Release frees a held amount for payout once its Dispute closes or its clearance period ends. Verb page.

TypeScript

interface HumanVerbs {
  release(input: HumanReleaseInput, options?: SB.CallOptions): SB.Call<Human>
}

Inputs

Input	Type	Required	Description
`human`	Human	required	The payee.
`cause`	`string`	required	The Order or Dispute whose hold ends.

Returns

Output	Type	Required	Description
`human`	Human	required	The payee, with the hold removed.

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 human = await $.Human.release({ human: 'human_EeCsrv4AOW', cause: 'Example cause' })

Remit pays a supplying Human’s earned balance to their bank account through the Startup’s payment account. Verb page.

TypeScript

interface HumanVerbs {
  remit(input: HumanRemitInput, options?: SB.CallOptions): SB.Call<HumanRemitOutput>
}

Inputs

Input	Type	Required	Description
`human`	Human	required	The Human to pay.
`amount`	`money`		The amount. Defaults to the full earned balance.

Returns

Output	Type	Required	Description
`transaction`	Transaction	required	The payout Transaction.
`human`	Human	required	The Human paid, with the balance now zero.

Refuses when

Check	Error	Fix	Then call
The operation is part of an Offer the caller has not accepted or paid for.	`payment-required`	Accept the Offer named in the response, then retry the call.	Offer.accept
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 { transaction, human } = await $.Human.remit({ human: 'human_EeCsrv4AOW' })

Suspend stops a supplying Human from taking new Tasks while a Credential lapses or a dispute is open. Verb page.

TypeScript

interface HumanVerbs {
  suspend(input: HumanSuspendInput, options?: SB.CallOptions): SB.Call<Human>
}

Inputs

Input	Type	Required	Description
`human`	Human	required	The Human to suspend.
`reason`	`text`	required	Why the Human stops.

Returns

Output	Type	Required	Description
`human`	Human	required	The suspended Human.

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.
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const human = await $.Human.suspend({ human: 'human_EeCsrv4AOW', reason: 'Example reason' })