Verb methods: retire
The Verb Verbs retire as typed SDK methods, with inputs, result, refusals and an example.
Reference for Verb, one group of Verb methods.
Verb.retire
Retire removes a published Verb from new Versions; callers pinned to earlier Versions keep calling it. Verb page.
interface VerbVerbs {
retire(input: VerbRetireInput, options?: SB.CallOptions): SB.Call<VerbRetireOutput>
}Emits Verb.retired.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
verb | Verb | required | The Verb to retire. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
version | Version | required | The new Version, without the Verb. |
verb | Verb | required | The Verb, now retired from new Versions. |
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
import { $ } from 'startup-builder'
const { version, verb } = await $.Verb.retire({ verb: 'verb_hlkWBvrAyZ' })