Play Mix methods · StartupBuilder

Reference for Play Mix.

PlayMix.get

Returns one Play Mix by id. Verb page.

TypeScript

interface PlayMixVerbs {
  get(input: PlayMixGetInput, options?: SB.CallOptions): SB.Call<PlayMix>
}

Reads only: it emits no Event.

Inputs

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

Returns

Output	Type	Required	Description
`playMix`	Play Mix	required	The Play Mix.

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 playMix = await $.PlayMix.get({ id: 'mix_TTNQqOh9uX' })

Returns Play Mixes, newest first, one page at a time. Verb page.

TypeScript

interface PlayMixVerbs {
  list(input?: PlayMixListInput, options?: SB.CallOptions): SB.ListCall<PlayMix>
}

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
`playMixes`	list of Play Mix	required	One page of Play Mixes.

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

Compile builds the next Play Mix from the Demand Budget, each Play’s ledger and last week’s Acquisitions, and records the diff. Verb page.

TypeScript

interface PlayMixVerbs {
  compile(input: PlayMixCompileInput, options?: SB.CallOptions): SB.Call<PlayMix>
}

Inputs

Input	Type	Required	Description
`startup`	Startup	required	The Startup whose Play Mix is compiled.

Returns

Output	Type	Required	Description
`playMix`	Play Mix	required	The new version, or the current one when nothing moved.

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 playMix = await $.PlayMix.compile({ startup: 'startup_l3hr1EnUGY' })