Policy methods: update, delete

Reference for Policy, one group of Policy methods.

Policy.update

Changes the given properties of a Policy. Verb page.

TypeScript

interface PolicyVerbs {
  update(input: PolicyUpdateInput, options?: SB.CallOptions): SB.Call<Policy>
}

Emits Policy.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Policy.
`rule`	`text`		The ruling, stated so code can apply it.

Returns

Output	Type	Required	Description
`policy`	Policy	required	The Policy.

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 policy = await $.Policy.update({ id: 'policy_rTYxr62HGB', rule: 'Example rule' })

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

TypeScript

interface PolicyVerbs {
  delete(input: PolicyDeleteInput, options?: SB.CallOptions): SB.Call<Policy>
}

Emits Policy.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`policy`	Policy	required	The Policy.

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 policy = await $.Policy.delete({ id: 'policy_rTYxr62HGB' })