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