Startup methods: update, delete

Reference for Startup, one group of Startup methods.

Startup.update

Changes the given properties of a Startup. Verb page.

TypeScript

interface StartupVerbs {
  update(input: StartupUpdateInput, options?: SB.CallOptions): SB.Call<Startup>
}

Emits Startup.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Startup.
`name`	`string`		The name the Startup trades under.
`domain`	`url`		The canonical hostname of the Startup.
`launchedAt`	`datetime`		When the Startup went live.
`template`	`string`		The slug of the template it extends; the root one when none is named.
`idea`	`text`		The Idea it starts from, in a sentence, recorded as its Idea.
`spendState`	`string`		How freely money Limits allow spend: `free`, `tight` (discretionary Limits halved) or `hold` (one-way spend stops).

Returns

Output	Type	Required	Description
`startup`	Startup	required	The Startup.

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 startup = await $.Startup.update({ id: 'startup_l3hr1EnUGY', name: 'Leaseline' })

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

TypeScript

interface StartupVerbs {
  delete(input: StartupDeleteInput, options?: SB.CallOptions): SB.Call<Startup>
}

Emits Startup.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`startup`	Startup	required	The Startup.

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 startup = await $.Startup.delete({ id: 'startup_l3hr1EnUGY' })