Source methods: update, delete

Reference for Source, one group of Source methods.

Source.update

Changes the given properties of a Source. Verb page.

TypeScript

interface SourceVerbs {
  update(input: SourceUpdateInput, options?: SB.CallOptions): SB.Call<Source>
}

Emits Source.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Source.
`acquired`	`string`		One of `owned`, `wrapped`, or `recruited`.
`terms`	`text`		The terms the Startup holds the right to use and resell it under.

Returns

Output	Type	Required	Description
`source`	Source	required	The Source.

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 source = await $.Source.update({ id: 'source_DIdhfB6mF5', acquired: 'owned' })

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

TypeScript

interface SourceVerbs {
  delete(input: SourceDeleteInput, options?: SB.CallOptions): SB.Call<Source>
}

Emits Source.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`source`	Source	required	The Source.

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 source = await $.Source.delete({ id: 'source_DIdhfB6mF5' })