Metric methods: update, delete

Reference for Metric, one group of Metric methods.

Metric.update

Changes the given properties of a Metric. Verb page.

TypeScript

interface MetricVerbs {
  update(input: MetricUpdateInput, options?: SB.CallOptions): SB.Call<Metric>
}

Emits Metric.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Metric.
`query`	`text`		How it is computed. An agent never varies the Metrics it is judged by. Never randomized.
`unit`	`string`		The unit, such as dollars or percent.

Returns

Output	Type	Required	Description
`metric`	Metric	required	The Metric.

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 metric = await $.Metric.update({ id: 'metric_GXFHAlK100', query: 'Example query' })

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

TypeScript

interface MetricVerbs {
  delete(input: MetricDeleteInput, options?: SB.CallOptions): SB.Call<Metric>
}

Emits Metric.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`metric`	Metric	required	The Metric.

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 metric = await $.Metric.delete({ id: 'metric_GXFHAlK100' })