Theme methods: update, delete
The Theme Verbs update, delete as typed SDK methods, with inputs, result, refusals and an example.
Reference for Theme, one group of Theme methods.
Theme.update
Changes the given properties of a Theme. Verb page.
interface ThemeVerbs {
update(input: ThemeUpdateInput, options?: SB.CallOptions): SB.Call<Theme>
}Emits Theme.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Theme. |
tokens | json | The token values, in light and dark modes. | |
css | text | Extra CSS, applied after the tokens. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
theme | Theme | required | The Theme. |
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 theme = await $.Theme.update({ id: 'theme_sZHbu0W683', tokens: {} })Theme.delete
Deletes a Theme: a soft delete that keeps its history, undone by Thing.restore. Verb page.
interface ThemeVerbs {
delete(input: ThemeDeleteInput, options?: SB.CallOptions): SB.Call<Theme>
}Emits Theme.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Theme. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
theme | Theme | required | The Theme. |
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 theme = await $.Theme.delete({ id: 'theme_sZHbu0W683' })