Supplier methods: update, delete

Reference for Supplier, one group of Supplier methods.

Supplier.update

Changes the given properties of a Supplier. Verb page.

TypeScript

interface SupplierVerbs {
  update(input: SupplierUpdateInput, options?: SB.CallOptions): SB.Call<Supplier>
}

Emits Supplier.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Supplier.
`name`	`string`		The legal or personal name.
`payoutAccount`	`string`		Where payouts land, held through Stripe.

Returns

Output	Type	Required	Description
`supplier`	Supplier	required	The Supplier.

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 supplier = await $.Supplier.update({ id: 'supplier_QTsIMiLqO4', payoutAccount: 'Example payout account' })

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

TypeScript

interface SupplierVerbs {
  delete(input: SupplierDeleteInput, options?: SB.CallOptions): SB.Call<Supplier>
}

Emits Supplier.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`supplier`	Supplier	required	The Supplier.

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 supplier = await $.Supplier.delete({ id: 'supplier_QTsIMiLqO4' })