Software methods: update, delete

Reference for Software, one group of Software methods.

Software.update

Changes the given properties of a Software. Verb page.

TypeScript

interface SoftwareVerbs {
  update(input: SoftwareUpdateInput, options?: SB.CallOptions): SB.Call<Software>
}

Emits Software.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Software.
`name`	`string`		The name of the Product.
`promise`	`text`		What the Customer can rely on.
`headless`	`boolean`		True when it ships without screens of its own.

Returns

Output	Type	Required	Description
`software`	Software	required	The Software.

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 software = await $.Software.update({ id: 'software_D5qhJn6mF5', headless: true })

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

TypeScript

interface SoftwareVerbs {
  delete(input: SoftwareDeleteInput, options?: SB.CallOptions): SB.Call<Software>
}

Emits Software.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`software`	Software	required	The Software.

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 software = await $.Software.delete({ id: 'software_D5qhJn6mF5' })