Skip to main content

Memory Rules

SDK methods for the Memory Rules module, accessed via soat.memoryRules. See the Memory Rules module docs for permissions and data model, and each method's REST page for the full request/response schema.

soat.memoryRules.listMemoryRules()​

List memory rules

  • Method: GET
  • Path: /api/v1/memory-rules
await soat.memoryRules.listMemoryRules({
  query: { /* + optional */ },
});

→ Request & response schema

soat.memoryRules.createMemoryRule()​

Create a memory rule

  • Method: POST
  • Path: /api/v1/memory-rules
await soat.memoryRules.createMemoryRule({
  body: { memory_store_id, on, /* + optional */ },
});

→ Request & response schema

soat.memoryRules.getMemoryRule()​

Get a memory rule

  • Method: GET
  • Path: /api/v1/memory-rules/{memory_rule_id}
await soat.memoryRules.getMemoryRule({
  path: { memory_rule_id },
});

→ Request & response schema

soat.memoryRules.updateMemoryRule()​

Update a memory rule

  • Method: PATCH
  • Path: /api/v1/memory-rules/{memory_rule_id}
await soat.memoryRules.updateMemoryRule({
  path: { memory_rule_id },
  body: { /* + optional */ },
});

→ Request & response schema

soat.memoryRules.deleteMemoryRule()​

Delete a memory rule

  • Method: DELETE
  • Path: /api/v1/memory-rules/{memory_rule_id}
await soat.memoryRules.deleteMemoryRule({
  path: { memory_rule_id },
});

→ Request & response schema