Interface methods: update, delete

Reference for Interface, one group of Interface methods.

Interface.update

Changes the given properties of an Interface. Verb page.

TypeScript

interface InterfaceVerbs {
  update(input: InterfaceUpdateInput, options?: SB.CallOptions): SB.Call<Interface>
}

Emits Interface.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Interface.
`kind`	`string`		One of `api`, `mcp`, `cli`, `sdk`, `site`, `app`, `docs`, or `webhooks`.
`path`	`string`		Where it is mounted on its Domain, such as `/api`.
`conformsTo`	`json`		The Standards it also speaks, each mapping the Standard’s operations onto the Product’s Verbs.

Returns

Output	Type	Required	Description
`interface`	Interface	required	The Interface.

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

TypeScript

import { $ } from 'startup-builder'

const result = await $.Interface.update({ id: 'interface_TMyQ3kh9uX', kind: 'api' })

Deletes an Interface: a soft delete that keeps its history, undone by Thing.restore. Verb page.

TypeScript

interface InterfaceVerbs {
  delete(input: InterfaceDeleteInput, options?: SB.CallOptions): SB.Call<Interface>
}

Emits Interface.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Interface.

Returns

Output	Type	Required	Description
`interface`	Interface	required	The Interface.

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

TypeScript

import { $ } from 'startup-builder'

const result = await $.Interface.delete({ id: 'interface_TMyQ3kh9uX' })