Flag methods: update, delete

Reference for Flag, one group of Flag methods.

Flag.update

Changes the given properties of a Flag. Verb page.

TypeScript

interface FlagVerbs {
  update(input: FlagUpdateInput, options?: SB.CallOptions): SB.Call<Flag>
}

Emits Flag.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Flag.
`key`	`string`		The name code reads.
`rules`	`json`		Who gets which value, including percentage splits.

Returns

Output	Type	Required	Description
`flag`	Flag	required	The Flag.

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 flag = await $.Flag.update({ id: 'flag_1YJLhjTlfx', key: 'new-checkout' })

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

TypeScript

interface FlagVerbs {
  delete(input: FlagDeleteInput, options?: SB.CallOptions): SB.Call<Flag>
}

Emits Flag.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`flag`	Flag	required	The Flag.

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 flag = await $.Flag.delete({ id: 'flag_1YJLhjTlfx' })