Human methods: update, delete

Reference for Human, one group of Human methods.

Human.update

Changes the given properties of a Human. Verb page.

TypeScript

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

Emits Human.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Human.
`name`	`string`		The name the Worker goes by in a Startup.
`instructions`	`text`		How the Worker does its work.
`email`	`email`		The address the Human signs in with.

Returns

Output	Type	Required	Description
`human`	Human	required	The 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.

Example

TypeScript

import { $ } from 'startup-builder'

const human = await $.Human.update({ id: 'human_EeCsrv4AOW', email: 'dana@leaseline.app' })

Deletes a Human: a soft delete that keeps its history, undone by Thing.restore. Verb page.

TypeScript

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

Emits Human.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Human.

Returns

Output	Type	Required	Description
`human`	Human	required	The 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.

Example

TypeScript

import { $ } from 'startup-builder'

const human = await $.Human.delete({ id: 'human_EeCsrv4AOW' })