Partner methods: update, delete

Reference for Partner, one group of Partner methods.

Partner.update

Changes the given properties of a Partner. Verb page.

TypeScript

interface PartnerVerbs {
  update(input: PartnerUpdateInput, options?: SB.CallOptions): SB.Call<Partner>
}

Emits Partner.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Partner.
`name`	`string`		The name it trades under.
`hostname`	`string`		The web domain that keys it.
`side`	`string`		One of `supply`, `distribution`, or `both`.

Returns

Output	Type	Required	Description
`partner`	Partner	required	The Partner.

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 partner = await $.Partner.update({ id: 'partner_YcEOEgSexq', side: 'supply' })

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

TypeScript

interface PartnerVerbs {
  delete(input: PartnerDeleteInput, options?: SB.CallOptions): SB.Call<Partner>
}

Emits Partner.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`partner`	Partner	required	The Partner.

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 partner = await $.Partner.delete({ id: 'partner_YcEOEgSexq' })