Template methods: update, delete
The Template Verbs update, delete as typed SDK methods, with inputs, result, refusals and an example.
Reference for Template, one group of Template methods.
Template.update
Changes the given properties of a Template. Verb page.
interface TemplateVerbs {
update(input: TemplateUpdateInput, options?: SB.CallOptions): SB.Call<Template>
}Emits Template.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Template. |
body | text | The MDX source with its variables. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
template | Template | required | The Template. |
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 template = await $.Template.update({ id: 'template_THRQF1h9uX', body: 'Example body' })Template.delete
Deletes a Template: a soft delete that keeps its history, undone by Thing.restore. Verb page.
interface TemplateVerbs {
delete(input: TemplateDeleteInput, options?: SB.CallOptions): SB.Call<Template>
}Emits Template.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Template. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
template | Template | required | The Template. |
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 template = await $.Template.delete({ id: 'template_THRQF1h9uX' })