Readout methods: update, delete

Reference for Readout, one group of Readout methods.

Readout.update

Changes the given properties of a Readout. Verb page.

TypeScript

interface ReadoutVerbs {
  update(input: ReadoutUpdateInput, options?: SB.CallOptions): SB.Call<Readout>
}

Emits Readout.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Readout.
`value`	`number`		The Metric’s value for the Variant.
`n`	`integer`		How many exposed units it counts.
`interval`	`json`		The low and high bounds of the estimate.
`readability`	`string`		One of `A`, `B`, `C`, or `inadmissible`: how far the number can be trusted.
`pooled`	`boolean`		True when exposures from sibling Startups or earlier Portfolio results are pooled in.

Returns

Output	Type	Required	Description
`readout`	Readout	required	The Readout.

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 readout = await $.Readout.update({ id: 'readout_dlRDxjf2vt', value: 1 })

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

TypeScript

interface ReadoutVerbs {
  delete(input: ReadoutDeleteInput, options?: SB.CallOptions): SB.Call<Readout>
}

Emits Readout.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`readout`	Readout	required	The Readout.

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 readout = await $.Readout.delete({ id: 'readout_dlRDxjf2vt' })