Referral methods: update, delete

Reference for Referral, one group of Referral methods.

Referral.update

Changes the given properties of a Referral. Verb page.

TypeScript

interface ReferralVerbs {
  update(input: ReferralUpdateInput, options?: SB.CallOptions): SB.Call<Referral>
}

Emits Referral.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Referral.
`reward`	`money`		What the referrer earns.
`rewardKind`	`string`		What the referrer earns: earlier `access`, or `cash`, which pays only after Live.

Returns

Output	Type	Required	Description
`referral`	Referral	required	The Referral.

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 referral = await $.Referral.update({ id: 'referral_I89J7wngKt', reward: { amount: 29, currency: 'USD' } })

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

TypeScript

interface ReferralVerbs {
  delete(input: ReferralDeleteInput, options?: SB.CallOptions): SB.Call<Referral>
}

Emits Referral.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`referral`	Referral	required	The Referral.

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 referral = await $.Referral.delete({ id: 'referral_I89J7wngKt' })