Play methods: update, delete

Reference for Play, one group of Play methods.

Play.update

Changes the given properties of a Play. Verb page.

TypeScript

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

Emits Play.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Play.
`family`	`string`		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.update({ id: 'play_hr4WTcrAyZ', family: 'demand' })

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

TypeScript

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

Emits Play.deleted.

Inputs

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

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