Entitlement methods: update, delete

Entitlement.update

Changes the given properties of an Entitlement. Verb page.

TypeScript

interface EntitlementVerbs {
  update(input: EntitlementUpdateInput, options?: SB.CallOptions): SB.Call<Entitlement>
}

Emits Entitlement.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Entitlement.
`verb`	Verb		The Verb it grants.
`limit`	Limit		The Limit that bounds it.
`kind`	`string`		Computed, never set: `feature`, or `limit` when a Limit bounds it.

Returns

Output	Type	Required	Description
`entitlement`	Entitlement	required	The Entitlement.

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 entitlement = await $.Entitlement.update({ id: 'ent_7MQACmrzGj', verb: 'verb_hlkWBvrAyZ' })

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

TypeScript

interface EntitlementVerbs {
  delete(input: EntitlementDeleteInput, options?: SB.CallOptions): SB.Call<Entitlement>
}

Emits Entitlement.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`entitlement`	Entitlement	required	The Entitlement.

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 entitlement = await $.Entitlement.delete({ id: 'ent_7MQACmrzGj' })