Studio methods: update, delete
The Studio Verbs update, delete as typed SDK methods, with inputs, result, refusals and an example.
Reference for Studio, one group of Studio methods.
Studio.update
Changes the given properties of a Studio. Verb page.
interface StudioVerbs {
update(input: StudioUpdateInput, options?: SB.CallOptions): SB.Call<Studio>
}Emits Studio.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Studio. |
name | string | The name of the Studio. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
studio | Studio | required | The Studio. |
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 studio = await $.Studio.update({ id: 'studio_JCwiflZmXb', name: 'Leaseline' })Studio.delete
Deletes a Studio: a soft delete that keeps its history, undone by Thing.restore. Verb page.
interface StudioVerbs {
delete(input: StudioDeleteInput, options?: SB.CallOptions): SB.Call<Studio>
}Emits Studio.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Studio. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
studio | Studio | required | The Studio. |
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 studio = await $.Studio.delete({ id: 'studio_JCwiflZmXb' })