Brand methods: update, delete

Reference for Brand, one group of Brand methods.

Brand.update

Changes the given properties of a Brand. Verb page.

TypeScript

interface BrandVerbs {
  update(input: BrandUpdateInput, options?: SB.CallOptions): SB.Call<Brand>
}

Emits Brand.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Brand.
`name`	`string`		The name customers see.
`voice`	`text`		How the Brand writes and speaks.
`logo`	`url`		The logo image.

Returns

Output	Type	Required	Description
`brand`	Brand	required	The Brand.

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 brand = await $.Brand.update({ id: 'brand_PluVQrB1HF', name: 'Leaseline' })

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

TypeScript

interface BrandVerbs {
  delete(input: BrandDeleteInput, options?: SB.CallOptions): SB.Call<Brand>
}

Emits Brand.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`brand`	Brand	required	The Brand.

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 brand = await $.Brand.delete({ id: 'brand_PluVQrB1HF' })