Implementation methods: update, delete

Implementation.update

Changes the given properties of an Implementation. Verb page.

TypeScript

interface ImplementationVerbs {
  update(input: ImplementationUpdateInput, options?: SB.CallOptions): SB.Call<Implementation>
}

Emits Implementation.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Implementation.
`kind`	`string`		One of `managed`, `custom`, or `external`.
`endpoint`	`url`		For an external Implementation, where api.sb routes each call.
`deliverBy`	`date`		For a `declared` Implementation: when a Function runs the Verb; a missed date refunds every reserve.

Returns

Output	Type	Required	Description
`implementation`	Implementation	required	The Implementation.

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 implementation = await $.Implementation.update({ id: 'implementation_gnulUgZJ7A', kind: 'managed' })

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

TypeScript

interface ImplementationVerbs {
  delete(input: ImplementationDeleteInput, options?: SB.CallOptions): SB.Call<Implementation>
}

Emits Implementation.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`implementation`	Implementation	required	The Implementation.

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 implementation = await $.Implementation.delete({ id: 'implementation_gnulUgZJ7A' })