Issue methods: update, delete

Reference for Issue, one group of Issue methods.

Issue.update

Changes the given properties of an Issue. Verb page.

TypeScript

interface IssueVerbs {
  update(input: IssueUpdateInput, options?: SB.CallOptions): SB.Call<Issue>
}

Emits Issue.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Issue.
`by`	Worker		The Worker that performed it.
`for`	Party		The Party it was done on behalf of.
`via`	`string`		The Interface or request it arrived through.
`on`	`string`		The Action or Event that caused it, such as the failed attempt a retry follows.
`thing`	`string`		The record, at the Version the Action was decided against.
`input`	`json`		The input it was called with.
`createdAt`	`datetime`		When it was called.
`reserved`	`money`		The most this Action may cost, held against its Limits from the check until it settles, billed misses included.
`due`	`datetime`		When the Task is due.
`priority`	`integer`		Its rank in the inbox, highest first.
`recurrence`	`string`		The schedule a recurring duty repeats on.
`kind`	`string`		One of `bug`, `request`, or `question`.
`severity`	`string`		Set by triage; a vulnerability takes `critical`, `high`, `medium` or `low`, which sets `due`. An Incident keeps its own scale.
`advisory`	`string`		For a vulnerability: the public advisory it matches, with the affected package and range.

Returns

Output	Type	Required	Description
`issue`	Issue	required	The Issue.

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 issue = await $.Issue.update({ id: 'issue_vWekeqrXCN', kind: 'bug' })

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

TypeScript

interface IssueVerbs {
  delete(input: IssueDeleteInput, options?: SB.CallOptions): SB.Call<Issue>
}

Emits Issue.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`issue`	Issue	required	The Issue.

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 issue = await $.Issue.delete({ id: 'issue_vWekeqrXCN' })