Dashboard methods: update, delete

Reference for Dashboard, one group of Dashboard methods.

Dashboard.update

Changes the given properties of a Dashboard. Verb page.

TypeScript

interface DashboardVerbs {
  update(input: DashboardUpdateInput, options?: SB.CallOptions): SB.Call<Dashboard>
}

Emits Dashboard.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Dashboard.
`scope`	`string`		What it views, such as a Studio, a Startup, a Team, or a Role.

Returns

Output	Type	Required	Description
`dashboard`	Dashboard	required	The Dashboard.

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 dashboard = await $.Dashboard.update({ id: 'dashboard_QL9I0ALqO4', scope: 'Startup' })

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

TypeScript

interface DashboardVerbs {
  delete(input: DashboardDeleteInput, options?: SB.CallOptions): SB.Call<Dashboard>
}

Emits Dashboard.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`dashboard`	Dashboard	required	The Dashboard.

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 dashboard = await $.Dashboard.delete({ id: 'dashboard_QL9I0ALqO4' })