Play methods: create, get, list

Reference for Play, one group of Play methods.

Play.create

Creates a Play. Verb page.

TypeScript

interface PlayVerbs {
  create(input: PlayCreateInput, options?: SB.CallOptions): SB.Call<Play>
}

Emits Play.created.

Inputs

Input	Type	Required	Description
`family`	`string`	required	The job it does, such as `demand`, `retention`, or `pricing`.
`cost`	`money`		What one run costs.
`cohort`	`json`		The Portfolio query a Studio rolls it out to.
`from`	`string`		Lineage: the slot it compiles from, as `Hypothesis#<slot>@v<version>`.

Returns

Output	Type	Required	Description
`play`	Play	required	The Play.

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 play = await $.Play.create({ family: 'demand' })

Returns one Play by id. Verb page.

TypeScript

interface PlayVerbs {
  get(input: PlayGetInput, options?: SB.CallOptions): SB.Call<Play>
}

Reads only: it emits no Event.

Inputs

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

Returns

Output	Type	Required	Description
`play`	Play	required	The Play.

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 play = await $.Play.get({ id: 'play_hr4WTcrAyZ' })

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

TypeScript

interface PlayVerbs {
  list(input?: PlayListInput, options?: SB.CallOptions): SB.ListCall<Play>
}

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
`plays`	list of Play	required	One page of Plays.

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