Meter methods: update, delete

Reference for Meter, one group of Meter methods.

Meter.update

Changes the given properties of a Meter. Verb page.

TypeScript

interface MeterVerbs {
  update(input: MeterUpdateInput, options?: SB.CallOptions): SB.Call<Meter>
}

Emits Meter.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Meter.
`unit`	`string`		What it counts, such as calls or tokens.
`of`	`string`		The declared Event the Meter counts.
`aggregation`	`string`		How counted Events combine over the window: a sum of a value, a count, or the last value.
`window`	`string`		The period usage accrues over before it bills, such as a month.

Returns

Output	Type	Required	Description
`meter`	Meter	required	The Meter.

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 meter = await $.Meter.update({ id: 'mtr_z08Ufi8LwY', unit: 'call' })

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

TypeScript

interface MeterVerbs {
  delete(input: MeterDeleteInput, options?: SB.CallOptions): SB.Call<Meter>
}

Emits Meter.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`meter`	Meter	required	The Meter.

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 meter = await $.Meter.delete({ id: 'mtr_z08Ufi8LwY' })