Skip to content

Memory methods: update, delete

The Memory Verbs update, delete as typed SDK methods, with inputs, result, refusals and an example.

Reference for Memory, one group of Memory methods.

Memory.update

Changes the given properties of a Memory. Verb page.

TypeScript
interface MemoryVerbs {
  update(input: MemoryUpdateInput, options?: SB.CallOptions): SB.Call<Memory>
}

Emits Memory.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Memory.
typelist of NounThe Nouns this Thing is an instance of.
outsidejsonThe ids this Thing has in outside tools, one per Integration, so a re-run matches instead of duplicating.
queryjsonThe saved query that defines a dynamic Collection.

Returns

OutputTypeRequiredDescription
memoryMemoryrequiredThe Memory.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse 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 memory = await $.Memory.update({ id: 'memory_Y52OcaSexq', type: ['noun_v0akLUrXCN'] })

Memory.delete

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

TypeScript
interface MemoryVerbs {
  delete(input: MemoryDeleteInput, options?: SB.CallOptions): SB.Call<Memory>
}

Emits Memory.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Memory.

Returns

OutputTypeRequiredDescription
memoryMemoryrequiredThe Memory.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse 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 memory = await $.Memory.delete({ id: 'memory_Y52OcaSexq' })