@graph8/sdk 0.251.0 → 0.262.0

package/docs/api/appObjects.md

@@ -0,0 +1,568 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.appObjects`: App Objects
+
+10 operations (7 read, 3 write).
+
+No hand-written client covers this area. Call it through `g8.api.appObjects.*` as shown below, or by operationId with `g8.api.call(operationId, input)`.
+
+Every example below assumes this setup (server-side, API key):
+
+```ts
+import { g8 } from "@graph8/sdk";
+
+g8.init({ apiKey: process.env.G8_API_KEY! });
+```
+
+Example values are placeholders that match each field's type. Only required fields are shown. Every example is type-checked against the SDK in CI.
+
+Exact TypeScript types for every operation on this page, and every schema they use: [appObjects.d.ts](appObjects.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`createAppObjectRecord`](#op-createappobjectrecord) | `POST /api/v1/app/objects/{object_slug}/records` | write |  | Create App Object Record |
+| [`getAppObject`](#op-getappobject) | `GET /api/v1/app/objects/{object_slug}` | read |  | Get App Object |
+| [`getAppObjectRecord`](#op-getappobjectrecord) | `GET /api/v1/app/objects/{object_slug}/records/{record_id}` | read |  | Get App Object Record |
+| [`getAppObjectRecordChanges`](#op-getappobjectrecordchanges) | `GET /api/v1/app/objects/{object_slug}/records/{record_id}/changes` | read |  | Get App Object Record Changes |
+| [`getAppObjectRecordHistory`](#op-getappobjectrecordhistory) | `GET /api/v1/app/objects/{object_slug}/records/{record_id}/history` | read |  | Get App Object Record History |
+| [`listAppObjectAttributes`](#op-listappobjectattributes) | `GET /api/v1/app/objects/{object_slug}/attributes` | read |  | List App Object Attributes |
+| [`listAppObjectRecords`](#op-listappobjectrecords) | `GET /api/v1/app/objects/{object_slug}/records` | read |  | List App Object Records |
+| [`listAppObjects`](#op-listappobjects) | `GET /api/v1/app/objects` | read |  | List App Objects |
+| [`restoreAppObjectRecord`](#op-restoreappobjectrecord) | `POST /api/v1/app/objects/{object_slug}/records/{record_id}/restore` | write |  | Restore App Object Record |
+| [`updateAppObjectRecord`](#op-updateappobjectrecord) | `PATCH /api/v1/app/objects/{object_slug}/records/{record_id}` | write |  | Update App Object Record |
+
+---
+
+<a id="op-createappobjectrecord"></a>
+
+### `g8.api.appObjects.createAppObjectRecord(input)`
+
+**Create App Object Record**
+
+- HTTP: `POST /api/v1/app/objects/{object_slug}/records`
+- operationId: `create_app_object_record_app_objects__object_slug__records_post` (also callable as `g8.api.call("create_app_object_record_app_objects__object_slug__records_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: none published
+- Lifecycle: `preview`, enabled by `M6_APP_TOKENS_ENABLED` (may not be enabled for every org yet)
+
+PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.
+
+Create a record in the tenant this app is acting for.
+
+Unknown fields are rejected with 422, not dropped, and every problem comes
+back at once. A collision on a unique attribute is 409.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `body` | `RecordWriteRequest` | yes | Request body; fields below. |
+| `headers.Origin` | `string \| null` | no |  |
+
+Body fields (`RecordWriteRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.values` | `Record<string, unknown>` | no | Attribute values keyed by slug. Call `GET /objects/{object_slug}/attributes` for active fields. Canonical contacts and companies retain CONTACT_*, COMPANY_* and udo_* field names. Unknown keys are rejected with 422. PATCH preserves omitted fields; required fields cannot be cleared with null or an empty multivalue list. Record references must resolve to active records of their configured target ob… |
+
+**Returns** `ApiResponse_ObjectRecordResponse_`: the envelope `{ data: ObjectRecordResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`ObjectRecordResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `string` | yes | Opaque record identifier. |
+| `object_slug` | `string` | yes | The object type this record belongs to. |
+| `created_at` | `string (date-time) \| null` | no |  |
+| `is_archived` | `boolean` | no | Archived records are excluded from listings. default `false` |
+| `revision` | `integer` | no | Record revision for conditional updates. default `1`, min 1 |
+| `updated_at` | `string (date-time) \| null` | no |  |
+| `values` | `Record<string, unknown>` | no | Currently active values, keyed by attribute slug. Shapes follow each attribute's own type; call `GET /objects/{object_slug}/attributes` for the schema. |
+
+**Example**
+
+```ts
+const result = await g8.api.appObjects.createAppObjectRecord({ path: { object_slug: "example" }, body: {} });
+```
+
+---
+
+<a id="op-getappobject"></a>
+
+### `g8.api.appObjects.getAppObject(input)`
+
+**Get App Object**
+
+- HTTP: `GET /api/v1/app/objects/{object_slug}`
+- operationId: `get_app_object_app_objects__object_slug__get` (also callable as `g8.api.call("get_app_object_app_objects__object_slug__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: none published
+- Lifecycle: `preview`, enabled by `M6_APP_TOKENS_ENABLED` (may not be enabled for every org yet)
+
+PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.
+
+Fetch one of this app's object types.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `headers.Origin` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_ObjectDefinitionResponse_`: the envelope `{ data: ObjectDefinitionResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`ObjectDefinitionResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `plural_noun` | `string` | yes | Display name for many records, e.g. "Invoices". |
+| `singular_noun` | `string` | yes | Display name for one record, e.g. "Invoice". |
+| `slug` | `string` | yes | Stable API slug for the object type, e.g. `invoices`. |
+| `description` | `string \| null` | no | Customer-configured object description. |
+| `display_attribute_slug` | `string \| null` | no | Active single-value field used to label records; null uses the default. |
+| `icon` | `string \| null` | no | Configured graph8 icon name; null uses the default. |
+| `is_archived` | `boolean` | no | Archived objects are hidden from listings. default `false` |
+| `is_system` | `boolean` | no | True for objects graph8 ships; system objects cannot be deleted. default `false` |
+
+**Example**
+
+```ts
+const result = await g8.api.appObjects.getAppObject({ path: { object_slug: "example" } });
+```
+
+---
+
+<a id="op-getappobjectrecord"></a>
+
+### `g8.api.appObjects.getAppObjectRecord(input)`
+
+**Get App Object Record**
+
+- HTTP: `GET /api/v1/app/objects/{object_slug}/records/{record_id}`
+- operationId: `get_app_object_record_app_objects__object_slug__records__record_id__get` (also callable as `g8.api.call("get_app_object_record_app_objects__object_slug__records__record_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: none published
+- Lifecycle: `preview`, enabled by `M6_APP_TOKENS_ENABLED` (may not be enabled for every org yet)
+
+PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.
+
+Fetch one record with its currently active values.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `path.record_id` | `string` | yes |  |
+| `headers.Origin` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_ObjectRecordResponse_`: the envelope `{ data: ObjectRecordResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`ObjectRecordResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `string` | yes | Opaque record identifier. |
+| `object_slug` | `string` | yes | The object type this record belongs to. |
+| `created_at` | `string (date-time) \| null` | no |  |
+| `is_archived` | `boolean` | no | Archived records are excluded from listings. default `false` |
+| `revision` | `integer` | no | Record revision for conditional updates. default `1`, min 1 |
+| `updated_at` | `string (date-time) \| null` | no |  |
+| `values` | `Record<string, unknown>` | no | Currently active values, keyed by attribute slug. Shapes follow each attribute's own type; call `GET /objects/{object_slug}/attributes` for the schema. |
+
+**Example**
+
+```ts
+const result = await g8.api.appObjects.getAppObjectRecord({ path: { object_slug: "example", record_id: "id" } });
+```
+
+---
+
+<a id="op-getappobjectrecordchanges"></a>
+
+### `g8.api.appObjects.getAppObjectRecordChanges(input)`
+
+**Get App Object Record Changes**
+
+- HTTP: `GET /api/v1/app/objects/{object_slug}/records/{record_id}/changes`
+- operationId: `get_app_object_record_changes_app_objects__object_slug__records__record_id__changes_get` (also callable as `g8.api.call("get_app_object_record_changes_app_objects__object_slug__records__record_id__changes_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: none published
+
+Read mutation facts within the authenticated app and client namespace.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `path.record_id` | `string` | yes |  |
+| `query.limit` | `integer` | no | default `100` |
+| `query.cursor` | `string \| null` | no |  |
+| `headers.Origin` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_RecordMutationsResponse_`: the envelope `{ data: RecordMutationsResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`RecordMutationsResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `entries` | `Array<RecordMutationEntry>` | yes |  |
+| `record_id` | `string` | yes |  |
+| `next_cursor` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.appObjects.getAppObjectRecordChanges({ path: { object_slug: "example", record_id: "id" } });
+```
+
+---
+
+<a id="op-getappobjectrecordhistory"></a>
+
+### `g8.api.appObjects.getAppObjectRecordHistory(input)`
+
+**Get App Object Record History**
+
+- HTTP: `GET /api/v1/app/objects/{object_slug}/records/{record_id}/history`
+- operationId: `get_app_object_record_history_app_objects__object_slug__records__record_id__history_get` (also callable as `g8.api.call("get_app_object_record_history_app_objects__object_slug__records__record_id__history_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: none published
+- Lifecycle: `preview`, enabled by `M6_APP_TOKENS_ENABLED` (may not be enabled for every org yet)
+
+PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.
+
+A record's value timeline, newest first.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `path.record_id` | `string` | yes |  |
+| `query.limit` | `integer` | no | Maximum generations to return default `100` |
+| `headers.Origin` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_RecordHistoryResponse_`: the envelope `{ data: RecordHistoryResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`RecordHistoryResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `record_id` | `string` | yes |  |
+| `entries` | `Array<RecordHistoryEntry>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.appObjects.getAppObjectRecordHistory({ path: { object_slug: "example", record_id: "id" } });
+```
+
+---
+
+<a id="op-listappobjectattributes"></a>
+
+### `g8.api.appObjects.listAppObjectAttributes(input)`
+
+**List App Object Attributes**
+
+- HTTP: `GET /api/v1/app/objects/{object_slug}/attributes`
+- operationId: `list_app_object_attributes_app_objects__object_slug__attributes_get` (also callable as `g8.api.call("list_app_object_attributes_app_objects__object_slug__attributes_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: none published
+- Lifecycle: `preview`, enabled by `M6_APP_TOKENS_ENABLED` (may not be enabled for every org yet)
+
+PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.
+
+The object's attributes — the schema its records must satisfy.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `headers.Origin` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_list_AttributeDefinitionResponse__`: the envelope `{ data: Array<AttributeDefinitionResponse>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`AttributeDefinitionResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `attribute_type` | `string` | yes | One of the 16 supported attribute types (`text`, `number`, `email_address`, `timestamp`, `select`, `record_reference`, …). Determines how values are validated and canonicalized. |
+| `slug` | `string` | yes | Stable API slug for the attribute, used as a payload key. |
+| `title` | `string` | yes | Customer-facing field label, distinct from its stable API slug. |
+| `config` | `Record<string, unknown>` | no | Type-specific configuration, e.g. select options. Record references require target_object and must resolve to active records in that object within the caller's organization and app. |
+| `default_value` | `unknown` | no | Configured create default. Enabled non-null defaults pass the same validation as explicit values. |
+| `description` | `string \| null` | no | Customer-configured description of the field. |
+| `is_archived` | `boolean` | no | Archived fields retain their values and can be restored. default `false` |
+| `is_default_value_enabled` | `boolean` | no | Apply the configured default when this field is omitted on create. Never applies on PATCH. default `false` |
+| `is_multiselect` | `boolean` | no | Values are a list rather than a scalar. default `false` |
+| `is_required` | `boolean` | no | Required on create. PATCH may omit it, but cannot clear it with null or an empty multivalue list. default `false` |
+| `is_system` | `boolean` | no | Whether this field is protected as a system attribute. default `false` |
+| `is_unique` | `boolean` | no | No two active records may hold the same value for this attribute. A collision is rejected with `409 duplicate_active_value`. default `false` |
+| `sort_order` | `integer` | no | Configured display order; equal values are ordered by API slug. default `0` |
+
+**Example**
+
+```ts
+const result = await g8.api.appObjects.listAppObjectAttributes({ path: { object_slug: "example" } });
+```
+
+---
+
+<a id="op-listappobjectrecords"></a>
+
+### `g8.api.appObjects.listAppObjectRecords(input)`
+
+**List App Object Records**
+
+- HTTP: `GET /api/v1/app/objects/{object_slug}/records`
+- operationId: `list_app_object_records_app_objects__object_slug__records_get` (also callable as `g8.api.call("list_app_object_records_app_objects__object_slug__records_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: none published
+- Lifecycle: `preview`, enabled by `M6_APP_TOKENS_ENABLED` (may not be enabled for every org yet)
+
+PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.
+
+List this app's records in the tenant it is acting for. Archived excluded.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `query.page` | `integer` | no | Page number (ignored when `cursor` is supplied) default `1` |
+| `query.limit` | `integer` | no | Items per page default `50` |
+| `query.cursor` | `string \| null` | no | Opaque cursor from a prior response. Takes precedence over `page`. |
+| `headers.Origin` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_list_ObjectRecordResponse__`: the envelope `{ data: Array<ObjectRecordResponse>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`ObjectRecordResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `string` | yes | Opaque record identifier. |
+| `object_slug` | `string` | yes | The object type this record belongs to. |
+| `created_at` | `string (date-time) \| null` | no |  |
+| `is_archived` | `boolean` | no | Archived records are excluded from listings. default `false` |
+| `revision` | `integer` | no | Record revision for conditional updates. default `1`, min 1 |
+| `updated_at` | `string (date-time) \| null` | no |  |
+| `values` | `Record<string, unknown>` | no | Currently active values, keyed by attribute slug. Shapes follow each attribute's own type; call `GET /objects/{object_slug}/attributes` for the schema. |
+
+**Example**
+
+```ts
+const result = await g8.api.appObjects.listAppObjectRecords({ path: { object_slug: "example" } });
+```
+
+---
+
+<a id="op-listappobjects"></a>
+
+### `g8.api.appObjects.listAppObjects(input?)`
+
+**List App Objects**
+
+- HTTP: `GET /api/v1/app/objects`
+- operationId: `list_app_objects_app_objects_get` (also callable as `g8.api.call("list_app_objects_app_objects_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: none published
+- Lifecycle: `preview`, enabled by `M6_APP_TOKENS_ENABLED` (may not be enabled for every org yet)
+
+PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.
+
+List the object types this app declared, in the tenant it is acting for.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `headers.Origin` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_list_ObjectDefinitionResponse__`: the envelope `{ data: Array<ObjectDefinitionResponse>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`ObjectDefinitionResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `plural_noun` | `string` | yes | Display name for many records, e.g. "Invoices". |
+| `singular_noun` | `string` | yes | Display name for one record, e.g. "Invoice". |
+| `slug` | `string` | yes | Stable API slug for the object type, e.g. `invoices`. |
+| `description` | `string \| null` | no | Customer-configured object description. |
+| `display_attribute_slug` | `string \| null` | no | Active single-value field used to label records; null uses the default. |
+| `icon` | `string \| null` | no | Configured graph8 icon name; null uses the default. |
+| `is_archived` | `boolean` | no | Archived objects are hidden from listings. default `false` |
+| `is_system` | `boolean` | no | True for objects graph8 ships; system objects cannot be deleted. default `false` |
+
+**Example**
+
+```ts
+const result = await g8.api.appObjects.listAppObjects();
+```
+
+---
+
+<a id="op-restoreappobjectrecord"></a>
+
+### `g8.api.appObjects.restoreAppObjectRecord(input)`
+
+**Restore App Object Record**
+
+- HTTP: `POST /api/v1/app/objects/{object_slug}/records/{record_id}/restore`
+- operationId: `restore_app_object_record_app_objects__object_slug__records__record_id__restore_post` (also callable as `g8.api.call("restore_app_object_record_app_objects__object_slug__records__record_id__restore_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: none published
+
+Restore this app's archived record using current constraints and its original ID.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `path.record_id` | `string` | yes |  |
+| `headers.Origin` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_ObjectRecordResponse_`: the envelope `{ data: ObjectRecordResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`ObjectRecordResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `string` | yes | Opaque record identifier. |
+| `object_slug` | `string` | yes | The object type this record belongs to. |
+| `created_at` | `string (date-time) \| null` | no |  |
+| `is_archived` | `boolean` | no | Archived records are excluded from listings. default `false` |
+| `revision` | `integer` | no | Record revision for conditional updates. default `1`, min 1 |
+| `updated_at` | `string (date-time) \| null` | no |  |
+| `values` | `Record<string, unknown>` | no | Currently active values, keyed by attribute slug. Shapes follow each attribute's own type; call `GET /objects/{object_slug}/attributes` for the schema. |
+
+**Example**
+
+```ts
+const result = await g8.api.appObjects.restoreAppObjectRecord({ path: { object_slug: "example", record_id: "id" } });
+```
+
+---
+
+<a id="op-updateappobjectrecord"></a>
+
+### `g8.api.appObjects.updateAppObjectRecord(input)`
+
+**Update App Object Record**
+
+- HTTP: `PATCH /api/v1/app/objects/{object_slug}/records/{record_id}`
+- operationId: `update_app_object_record_app_objects__object_slug__records__record_id__patch` (also callable as `g8.api.call("update_app_object_record_app_objects__object_slug__records__record_id__patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: none published
+- Lifecycle: `preview`, enabled by `M6_APP_TOKENS_ENABLED` (may not be enabled for every org yet)
+
+PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.
+
+Update a record. Only the supplied attributes are touched.
+
+An explicit `null` clears an attribute; omitting the key leaves it alone.
+Values are versioned rather than overwritten.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.object_slug` | `string` | yes |  |
+| `path.record_id` | `string` | yes |  |
+| `body` | `RecordUpdateRequest` | yes | Request body; fields below. |
+| `headers.Origin` | `string \| null` | no |  |
+
+Body fields (`RecordUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.append_values` | `Record<string, Array<unknown>>` | no | Append canonical non-duplicate values to multivalue fields. Fields must not overlap values or remove_values. |
+| `body.expected_revision` | `integer \| null` | no | Required for canonical contact or company PATCH. Apply only if the record still has this revision; otherwise return 409. min 1 |
+| `body.remove_values` | `Record<string, Array<unknown>>` | no | Remove all canonical matches from multivalue fields. Fields must not overlap values or append_values. |
+| `body.values` | `Record<string, unknown>` | no | Attribute values keyed by slug. Call `GET /objects/{object_slug}/attributes` for active fields. Canonical contacts and companies retain CONTACT_*, COMPANY_* and udo_* field names. Unknown keys are rejected with 422. PATCH preserves omitted fields; required fields cannot be cleared with null or an empty multivalue list. Record references must resolve to active records of their configured target ob… |
+
+**Returns** `ApiResponse_ObjectRecordResponse_`: the envelope `{ data: ObjectRecordResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`ObjectRecordResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `string` | yes | Opaque record identifier. |
+| `object_slug` | `string` | yes | The object type this record belongs to. |
+| `created_at` | `string (date-time) \| null` | no |  |
+| `is_archived` | `boolean` | no | Archived records are excluded from listings. default `false` |
+| `revision` | `integer` | no | Record revision for conditional updates. default `1`, min 1 |
+| `updated_at` | `string (date-time) \| null` | no |  |
+| `values` | `Record<string, unknown>` | no | Currently active values, keyed by attribute slug. Shapes follow each attribute's own type; call `GET /objects/{object_slug}/attributes` for the schema. |
+
+**Example**
+
+```ts
+const result = await g8.api.appObjects.updateAppObjectRecord({ path: { object_slug: "example", record_id: "id" }, body: {} });
+```
+
+---
+
+## Referenced types
+
+Named types that appear in the tables above. Full TypeScript definitions: `G8Contract.<Name>` (`import type { G8Contract } from "@graph8/sdk"`).
+
+<a id="type-recordhistoryentry"></a>
+
+### `RecordHistoryEntry`
+
+One generation of one attribute's value. Values are TEMPORAL rather than mutable: setting a new value closes the previous generation and opens a new one, so history is the natural reading of the store rather than a separate log that could drift from it. An entry with a null `active_until` is the value currently in force.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `attribute` | `string` | yes | Attribute slug this generation belongs to. |
+| `active_from` | `string (date-time) \| null` | no | When this value took effect. |
+| `active_until` | `string (date-time) \| null` | no | When it was superseded. Null means it is still in force. |
+| `actor_id` | `string \| null` | no | Opaque id of whoever set it. |
+| `value` | `unknown` | no | The value held during this generation. |
+
+<a id="type-recordmutationentry"></a>
+
+### `RecordMutationEntry`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `action` | `"created" \| "updated" \| "archived" \| "restored"` | yes |  |
+| `actor_id` | `string \| null` | yes |  |
+| `actor_type` | `"user" \| "api" \| "app" \| "integration" \| "system"` | yes |  |
+| `changes` | `Record<string, RecordMutationValueChange>` | yes |  |
+| `id` | `string` | yes |  |
+| `is_archived` | `boolean` | yes |  |
+| `occurred_at` | `string (date-time)` | yes |  |
+| `revision` | `integer` | yes | min 1 |
+| `source` | `string` | yes |  |
+| `was_archived` | `boolean` | yes |  |
+| `app_id` | `string \| null` | no |  |