Referral methods: create, get, list

Reference for Referral, one group of Referral methods.

Referral.create

Creates a Referral. Verb page.

TypeScript

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

Emits Referral.created.

Inputs

Input	Type	Description
`reward`	`money`	What the referrer earns.
`rewardKind`	`string`	What the referrer earns: earlier `access`, or `cash`, which pays only after Live.
`party`	Party	The Party who sends a Referral earns its reward.

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.create({ reward: { amount: 29, currency: 'USD' } })

Returns one Referral by id. Verb page.

TypeScript

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

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Referral.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

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.get({ id: 'referral_I89J7wngKt' })

Returns Referrals, newest first, one page at a time. Verb page.

TypeScript

interface ReferralVerbs {
  list(input?: ReferralListInput, options?: SB.CallOptions): SB.ListCall<Referral>
}

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`referrals`	list of Referral	required	One page of Referrals.

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 referrals = await $.Referral.list({ limit: 20 })