@graph8/sdk 0.14.0 → 0.15.0

package/README.md

@@ -251,11 +251,41 @@ export const CTA = () => {
 | `g8.webhooks.constructEvent(body, sig, ts, secret, opts?)` | Verify a delivery's HMAC signature and return the parsed event (throws `WebhookSignatureError`) |
 | `g8.webhooks.knownEvents` | The known event-type catalog |
 
+The unreleased CRM increment adds `crm.record.created`, `crm.record.updated`,
+`crm.record.archived`, and `crm.record.restored`. Their `data` contains
+`object_slug`, `record_id`, and `revision`, rather than private field values.
+The envelope `id` is a stable event ID; `X-Studio-Delivery-Id` identifies a
+subscription's delivery. Verify the original request bytes before processing,
+and deduplicate by the stable identifiers because delivery is at least once.
+CRM subscription creation, update, deletion and secret rotation through the API
+require explicit `webhooks:write` and `objects:read` scopes. Removing CRM events
+also requires these grants. Reading CRM subscriptions or their delivery history
+requires explicit `webhooks:read` and `objects:read` scopes; a subscription list
+containing CRM subscriptions enforces the same read grants before returning data.
+These checks refresh credentials and apply even during compatibility scope soak.
+The backend checks current credential, membership and record access again before
+sending. Native custom
+records currently follow workspace-level access; app-owned/delegated authority
+and configurable Enterprise object grants remain incomplete.
+
 ## Native custom objects
 
 Use an organization API key with explicit `objects:read` for schema/record/history
-reads, `objects:write` for create/PATCH, and `objects:delete` for archive. Unscoped
-keys receive 403. `objects:*` grants all three; grant only the operations the
+reads, `objects:write` for record create/PATCH, and `objects:delete` for record archive.
+Schema create/update/archive require `objects:manage` and current Admin access through
+a personal API key. `objects.update(slug, { is_archived: false })` restores an object.
+Object create accepts `description` and a typed `icon`. Update also accepts
+`display_attribute_slug` for an active, single-value label field. Omit presentation
+properties to preserve them or pass `null` to clear them. The current display field
+must be replaced or cleared before archiving it or making it multivalue.
+Attribute administration in the unreleased increment uses `objects.createAttribute`,
+`objects.updateAttribute`, and `objects.archiveAttribute` with the same scope and Admin requirement.
+Restore with `objects.updateAttribute(objectSlug, attributeSlug, { is_archived: false })`.
+Use `objects.listAttributes(objectSlug, { include_archived: true })` to find archived fields;
+normal discovery and record validation use active fields only. Attribute PATCH preserves
+omitted fields; `default_value: null` explicitly clears a default. Requires the matching backend.
+
+Unscoped keys receive 403. `objects:*` grants all object scopes; grant only the operations the
 integration needs.
 
 ```typescript
@@ -273,6 +303,36 @@ PATCH preserves omitted attributes. Enabled defaults apply only on create;
 unknown fields return 422 and unique-value collisions return 409. Standard
 contacts, companies, and deals continue using their existing SDK resources.
 
+### Create or update by a unique key
+
+Use an active, single-value unique attribute to match a native custom record.
+Supply its nonempty value with the fields to write. Existing matches retain
+their graph8 ID and omitted values; new records receive configured defaults.
+
+```typescript
+import { g8 } from '@graph8/sdk';
+
+g8.init({ apiKey: process.env.G8_API_KEY! });
+// Assumes invoices.reference is a unique text attribute in this workspace.
+const invoice = await g8.objects.upsertRecord('invoices', 'reference', {
+  reference: 'INV-1042',
+});
+// A conditional update fails with 409 if the record changed or no longer matches.
+await g8.objects.upsertRecord('invoices', 'reference', {
+  reference: 'INV-1042',
+}, { expectedRevision: invoice.revision });
+```
+
+The REST operation is `POST /api/v1/objects/{object_slug}/records/upsert` with
+`{ "matching_attribute": "reference", "values": { "reference": "INV-1042" } }`.
+It requires `objects:write`, returns 201 for creation or 200 for an update, and
+accepts optional `expected_revision`. MCP exposes `g8_object_record_upsert`
+with the same fields. Archived records do not match. Invalid or nonunique
+matching attributes return 422; another unique-field collision returns 409.
+Legacy values requiring a uniqueness backfill also return 409 rather than
+creating a duplicate. Repeated upserts can create additional update history;
+unique-key matching is not a promise of exactly-once side effects.
+
 ## App Platform
 
 Hosted apps do not carry a permanent org API key. Instead they **exchange** a
@@ -371,3 +431,68 @@ unique value has been reused. Validation failures leave the record archived.
 Ambiguous legacy history returns 422 with `archive_snapshot_unavailable` rather
 than guessing its prior values. Repeating a successful restore adds no revision
 or history entry.
+
+### Append or remove multivalue items
+
+```ts
+import { g8 } from "@graph8/sdk";
+
+g8.init({ apiKey: "YOUR_API_KEY" });
+const projectId = "your-project-record-id";
+const record = await g8.objects.getRecord("projects", projectId);
+await g8.objects.updateRecord("projects", projectId, {}, {
+  appendValues: { tags: ["priority"] },
+  removeValues: { reviewers: ["former-reviewer-id"] },
+  expectedRevision: record.revision,
+});
+```
+
+Native and app PATCH APIs use `append_values` and `remove_values`; the MCP
+`g8_object_record_update` tool accepts those same names. Each field must occur
+in exactly one of `values`, `append_values`, or `remove_values`. These operations
+require a multivalue attribute; `values` still replaces the entire supplied field.
+Append preserves existing order and adds only canonically distinct items. Remove
+deletes all matching items. The resulting values must satisfy required, unique,
+and reference constraints. Changes are atomic and read the current values under
+a record lock, so concurrent appends do not discard each other.
+
+Repeating an append can leave the values unchanged while still advancing the
+record revision and history. This is not an idempotency guarantee for events.
+Deploy the matching backend before using these optional request fields.
+
+### Record mutation history
+
+```ts
+import { g8 } from "@graph8/sdk";
+
+g8.init({ apiKey: "YOUR_API_KEY" });
+const firstPage = await g8.objects.changes("projects", "your-project-record-id", { limit: 50 });
+if (firstPage.next_cursor) {
+  const olderPage = await g8.objects.changes("projects", "your-project-record-id", {
+    limit: 50,
+    cursor: firstPage.next_cursor,
+  });
+  console.log(olderPage.entries);
+}
+```
+
+The matching native and app APIs expose `/objects/{object_slug}/records/{record_id}/changes`
+and `/app/objects/{object_slug}/records/{record_id}/changes`. The MCP tool is
+`g8_object_record_changes`. These additions require the matching backend deployment.
+Entries include the record revision, action, actor identity/type, source, time,
+and changed values. Presence flags distinguish a cleared field from a present null.
+An empty page means no mutation entries were recorded, not that the record never
+changed; the existing value-history endpoint remains available for older facts.
+Use the returned opaque cursor for older pages. A storage failure is an error,
+not an empty history. This interface does not establish broader object/record ACL parity.
+
+### Conditional deal updates (unreleased)
+
+Read the canonical deal record through `GET /api/v1/objects/deals/records/{id}`
+to obtain its CRM revision, then pass `expected_revision` to
+`g8.deals.update(id, { name: "Updated", expected_revision: revision })`.
+A stale edit returns HTTP 409; reload and reconcile before retrying. A successful
+conditional update returns `revision`. If tenant revision tracking is unavailable,
+the conditional write returns 503 before mutation. Omitting `expected_revision`
+retains the existing PATCH contract. The MCP `g8_update_deal` tool accepts the same
+field. Deal UI integration and deployed QA verification remain pending.

package/dist/index.d.mts

@@ -1550,6 +1550,8 @@ declare const createInboxClient: (apiKey: string, apiUrl?: string) => {
 };
 
 interface Deal {
+    /** Canonical CRM revision returned by a conditional update. */
+    revision?: number | null;
     id: string | null;
     name: string | null;
     description: string | null;
@@ -1614,6 +1616,8 @@ interface DealCreateParams {
     allow_duplicate?: boolean;
 }
 interface DealUpdateParams {
+    /** Require this current CRM revision; a stale edit returns HTTP 409. */
+    expected_revision?: number;
     name?: string;
     description?: string;
     amount?: number;
@@ -1739,6 +1743,7 @@ declare const createDealsClient: (apiKey: string, apiUrl?: string) => {
     }>;
 };
 
+type CustomObjectIcon = "box" | "briefcase" | "building" | "calendar" | "flag" | "folder" | "globe" | "heart" | "layers" | "package" | "target" | "users";
 /** A custom object type in your workspace — a record type you define. */
 interface CustomObject {
     /** Stable API slug, e.g. `invoices`. */
@@ -1748,6 +1753,28 @@ interface CustomObject {
     /** True for object types graph8 ships; system objects cannot be deleted. */
     is_system: boolean;
     is_archived: boolean;
+    /** Presentation settings may be absent on older servers. */
+    description?: string | null;
+    icon?: string | null;
+    display_attribute_slug?: string | null;
+}
+/** Native schema creation requires objects:manage and current Admin access. */
+interface CreateCustomObject {
+    slug: string;
+    singular_noun: string;
+    plural_noun: string;
+    description?: string | null;
+    icon?: CustomObjectIcon | null;
+}
+/** Omitted labels/state are preserved. The API slug is immutable. */
+interface UpdateCustomObject {
+    singular_noun?: string;
+    plural_noun?: string;
+    is_archived?: boolean;
+    /** Omit to preserve; null clears the setting. */
+    description?: string | null;
+    icon?: CustomObjectIcon | null;
+    display_attribute_slug?: string | null;
 }
 /**
  * One attribute on a custom object, and the rules its values must satisfy.
@@ -1760,6 +1787,15 @@ interface CustomObject {
  */
 interface CustomObjectAttribute {
     slug: string;
+    /** Customer-facing label. Display metadata is absent on older servers. */
+    title?: string;
+    description?: string | null;
+    /** Display order; ties are ordered by slug. */
+    sort_order?: number;
+    /** Protected system field rather than a customer-defined field. */
+    is_system?: boolean;
+    /** Archive state; absent on older servers. */
+    is_archived?: boolean;
     attribute_type: string;
     is_required: boolean;
     /** No two ACTIVE records may hold the same value. A collision returns 409. */
@@ -1772,6 +1808,24 @@ interface CustomObjectAttribute {
     /** Type-specific configuration, e.g. the allowed options for a `select`. */
     config: Record<string, unknown>;
 }
+/** Schema creation requires objects:manage and current Admin access. */
+interface CreateCustomObjectAttribute {
+    slug: string;
+    title: string;
+    attribute_type: "text" | "number" | "currency" | "date" | "timestamp" | "checkbox" | "select" | "status" | "email_address" | "phone_number" | "domain" | "location" | "personal_name" | "record_reference" | "rating" | "actor_reference";
+    description?: string | null;
+    is_required?: boolean;
+    is_unique?: boolean;
+    is_multiselect?: boolean;
+    is_default_value_enabled?: boolean;
+    default_value?: unknown;
+    config?: Record<string, unknown>;
+    sort_order?: number;
+}
+/** Omitted fields are preserved; explicit null can clear the configured default. */
+type UpdateCustomObjectAttribute = Partial<Omit<CreateCustomObjectAttribute, "slug" | "attribute_type">> & {
+    is_archived?: boolean;
+};
 /** One record, with its currently active attribute values. */
 interface CustomObjectRecord {
     id: string;
@@ -1802,6 +1856,29 @@ interface CustomObjectHistory {
     record_id: string;
     entries: CustomObjectHistoryEntry[];
 }
+interface CustomObjectMutation {
+    id: string;
+    action: "created" | "updated" | "archived" | "restored";
+    occurred_at: string;
+    revision: number;
+    actor_id: string | null;
+    actor_type: "user" | "api" | "app" | "integration" | "system";
+    source: string;
+    app_id: string | null;
+    changes: Record<string, {
+        before_present: boolean;
+        before: unknown;
+        after_present: boolean;
+        after: unknown;
+    }>;
+    was_archived: boolean;
+    is_archived: boolean;
+}
+interface CustomObjectMutations {
+    record_id: string;
+    entries: CustomObjectMutation[];
+    next_cursor: string | null;
+}
 interface ListRecordsParams {
     page?: number;
     /** 1-200, default 50. */
@@ -1866,16 +1943,33 @@ interface ObjectPagination {
  */
 declare const createObjectsClient: (apiKey: string, apiUrl?: string) => {
     /** List the custom object types in your workspace. */
-    list(): Promise<{
+    list(params?: {
+        include_archived?: boolean;
+    }): Promise<{
         data: CustomObject[];
     }>;
+    /** Create a native custom object. Requires objects:manage and Admin access. */
+    create(input: CreateCustomObject): Promise<CustomObject>;
+    /** Rename, archive or restore an object while preserving its slug and data. */
+    update(objectSlug: string, input: UpdateCustomObject): Promise<CustomObject>;
+    /** Archive the object without deleting records; restore with update({ is_archived: false }). */
+    archive(objectSlug: string): Promise<CustomObject>;
     /** Fetch one object type by slug. */
     get(objectSlug: string): Promise<CustomObject>;
     /** The object's attributes — the schema its records must satisfy. */
-    listAttributes(objectSlug: string): Promise<{
+    listAttributes(objectSlug: string, params?: {
+        include_archived?: boolean;
+    }): Promise<{
         data: CustomObjectAttribute[];
     }>;
-    /** Paginated records with their current values. Archived records are excluded. */
+    /** Create a field using the same schema rules as the customer UI. */
+    createAttribute(objectSlug: string, input: CreateCustomObjectAttribute): Promise<CustomObjectAttribute>;
+    /** Edit or restore a field; its type and slug are immutable. */
+    updateAttribute(objectSlug: string, attributeSlug: string, input: UpdateCustomObjectAttribute): Promise<CustomObjectAttribute>;
+    /** Archive without deleting values; restore with updateAttribute({ is_archived: false }). */
+    archiveAttribute(objectSlug: string, attributeSlug: string): Promise<CustomObjectAttribute>;
+    /** Paginated custom records or canonical deals with current values and revisions.
+     * Deal totals and related references respect current record access. */
     listRecords(objectSlug: string, params?: ListRecordsParams): Promise<{
         data: CustomObjectRecord[];
         pagination?: ObjectPagination;
@@ -1886,18 +1980,28 @@ declare const createObjectsClient: (apiKey: string, apiUrl?: string) => {
      * unique attribute is a 409.
      */
     createRecord(objectSlug: string, values: Record<string, unknown>): Promise<CustomObjectRecord>;
-    /** Fetch one record with its currently active values. */
+    /** Match a unique single-value key, creating or updating while preserving omitted fields. */
+    upsertRecord(objectSlug: string, matchingAttribute: string, values: Record<string, unknown>, options?: {
+        expectedRevision?: number;
+    }): Promise<CustomObjectRecord>;
+    /** Fetch one custom record, canonical contact/company, or deal by its stable graph8 ID.
+     * Deals retain their UUIDs and expose company, primary-contact and contact_ids references only
+     * when permitted. Generic deal mutations are not yet supported.
+     */
     getRecord(objectSlug: string, recordId: string): Promise<CustomObjectRecord>;
     /**
      * Update a record. PARTIAL: only the attributes you send are touched, so
      * required attributes you omit are left alone rather than reported missing.
      * Sending an explicit `null` CLEARS that attribute.
      *
-     * Values are versioned rather than overwritten, so the previous value stays
-     * readable through `history`.
+     * Custom values retain generations through `history`. Canonical contacts and
+     * companies require expectedRevision from a fresh read and expose recorded
+     * mutations through `changes`. They do not yet support appendValues/removeValues.
      */
     updateRecord(objectSlug: string, recordId: string, values: Record<string, unknown>, options?: {
         expectedRevision?: number;
+        appendValues?: Record<string, unknown[]>;
+        removeValues?: Record<string, unknown[]>;
     }): Promise<CustomObjectRecord>;
     /**
      * Archive a record. It leaves listings, stays readable by id, and keeps its
@@ -1911,6 +2015,14 @@ declare const createObjectsClient: (apiKey: string, apiUrl?: string) => {
      * null is the value currently in force.
      */
     history(objectSlug: string, recordId: string, limit?: number): Promise<CustomObjectHistory>;
+    /** Recorded custom-record or canonical contact/company mutations. Pass next_cursor to continue.
+     * Canonical history respects current access/privacy; archived records and older
+     * unrecorded writes are not reconstructed. Store unavailability returns 503.
+     */
+    changes(objectSlug: string, recordId: string, options?: {
+        limit?: number;
+        cursor?: string;
+    }): Promise<CustomObjectMutations>;
 };
 
 /**
@@ -2785,7 +2897,7 @@ declare const createContactsClient: (apiKey: string, apiUrl?: string) => {
  * adds events. ``WebhookEvent`` also accepts any string so a newly-added
  * backend event never breaks a client that hasn't upgraded.
  */
-declare const KNOWN_WEBHOOK_EVENTS: readonly ["campaign.created", "campaign.updated", "campaign.deleted", "campaign.launched", "campaign.paused", "campaign.completed", "campaign.status_changed", "campaign.content_ready", "document.generated", "document.failed", "intelligence.completed", "intelligence.failed", "company.enriched", "company_intelligence.completed", "audience.ready", "audience.failed", "sequence.draft_created", "sequence.started", "sequence.paused", "sequence.completed", "engagement.email_sent", "engagement.email_replied", "engagement.email_bounced", "engagement.email_skipped", "engagement.call_dispatched", "engagement.sms_sent", "engagement.sms_replied", "engagement.whatsapp_sent", "engagement.linkedin_connection_sent", "engagement.linkedin_message_sent", "engagement.linkedin_inmail_sent", "engagement.linkedin_reply_received", "engagement.linkedin_connection_accepted", "meeting.booked", "meeting.cancelled", "meeting.rescheduled"];
+declare const KNOWN_WEBHOOK_EVENTS: readonly ["campaign.created", "campaign.updated", "campaign.deleted", "campaign.launched", "campaign.paused", "campaign.completed", "campaign.status_changed", "campaign.content_ready", "document.generated", "document.failed", "intelligence.completed", "intelligence.failed", "company.enriched", "company_intelligence.completed", "audience.ready", "audience.failed", "sequence.draft_created", "sequence.started", "sequence.paused", "sequence.completed", "engagement.email_sent", "engagement.email_replied", "engagement.email_bounced", "engagement.email_skipped", "engagement.call_dispatched", "engagement.call_connected", "engagement.call_graded", "engagement.sms_sent", "engagement.sms_replied", "engagement.whatsapp_sent", "engagement.linkedin_connection_sent", "engagement.linkedin_message_sent", "engagement.linkedin_inmail_sent", "engagement.linkedin_reply_received", "engagement.linkedin_connection_accepted", "meeting.booked", "meeting.cancelled", "meeting.rescheduled", "deal.won", "crm.record.created", "crm.record.updated", "crm.record.archived", "crm.record.restored"];
 type WebhookEvent = (typeof KNOWN_WEBHOOK_EVENTS)[number] | (string & {});
 /** The decoded body graph8 delivers to a webhook endpoint. */
 interface WebhookEventPayload {
@@ -2793,7 +2905,7 @@ interface WebhookEventPayload {
     timestamp: string;
     data: Record<string, unknown>;
     org_id: string;
-    /** Stable per-delivery id (present once the backend adds it; for consumer dedup). */
+    /** Stable event ID for consumer deduplication; delivery ID is in X-Studio-Delivery-Id. */
     id?: string;
 }
 interface ConstructEventOptions {
@@ -2844,7 +2956,7 @@ declare const createWebhooksClient: (_apiKey: string, apiUrl?: string) => {
     /** Base URL the webhook subscription API lives under. */
     baseUrl: string;
     /** Known event types (for autocomplete / validation). */
-    knownEvents: readonly ["campaign.created", "campaign.updated", "campaign.deleted", "campaign.launched", "campaign.paused", "campaign.completed", "campaign.status_changed", "campaign.content_ready", "document.generated", "document.failed", "intelligence.completed", "intelligence.failed", "company.enriched", "company_intelligence.completed", "audience.ready", "audience.failed", "sequence.draft_created", "sequence.started", "sequence.paused", "sequence.completed", "engagement.email_sent", "engagement.email_replied", "engagement.email_bounced", "engagement.email_skipped", "engagement.call_dispatched", "engagement.sms_sent", "engagement.sms_replied", "engagement.whatsapp_sent", "engagement.linkedin_connection_sent", "engagement.linkedin_message_sent", "engagement.linkedin_inmail_sent", "engagement.linkedin_reply_received", "engagement.linkedin_connection_accepted", "meeting.booked", "meeting.cancelled", "meeting.rescheduled"];
+    knownEvents: readonly ["campaign.created", "campaign.updated", "campaign.deleted", "campaign.launched", "campaign.paused", "campaign.completed", "campaign.status_changed", "campaign.content_ready", "document.generated", "document.failed", "intelligence.completed", "intelligence.failed", "company.enriched", "company_intelligence.completed", "audience.ready", "audience.failed", "sequence.draft_created", "sequence.started", "sequence.paused", "sequence.completed", "engagement.email_sent", "engagement.email_replied", "engagement.email_bounced", "engagement.email_skipped", "engagement.call_dispatched", "engagement.call_connected", "engagement.call_graded", "engagement.sms_sent", "engagement.sms_replied", "engagement.whatsapp_sent", "engagement.linkedin_connection_sent", "engagement.linkedin_message_sent", "engagement.linkedin_inmail_sent", "engagement.linkedin_reply_received", "engagement.linkedin_connection_accepted", "meeting.booked", "meeting.cancelled", "meeting.rescheduled", "deal.won", "crm.record.created", "crm.record.updated", "crm.record.archived", "crm.record.restored"];
     /** Verify an incoming webhook's HMAC signature and return the parsed event. */
     constructEvent(payload: string, signature: string, timestamp: string | number, secret: string, opts?: ConstructEventOptions): WebhookEventPayload;
 };
@@ -3947,7 +4059,7 @@ declare class G8 {
     /** Webhook event listeners (requires API key). */
     get webhooks(): {
         baseUrl: string;
-        knownEvents: readonly ["campaign.created", "campaign.updated", "campaign.deleted", "campaign.launched", "campaign.paused", "campaign.completed", "campaign.status_changed", "campaign.content_ready", "document.generated", "document.failed", "intelligence.completed", "intelligence.failed", "company.enriched", "company_intelligence.completed", "audience.ready", "audience.failed", "sequence.draft_created", "sequence.started", "sequence.paused", "sequence.completed", "engagement.email_sent", "engagement.email_replied", "engagement.email_bounced", "engagement.email_skipped", "engagement.call_dispatched", "engagement.sms_sent", "engagement.sms_replied", "engagement.whatsapp_sent", "engagement.linkedin_connection_sent", "engagement.linkedin_message_sent", "engagement.linkedin_inmail_sent", "engagement.linkedin_reply_received", "engagement.linkedin_connection_accepted", "meeting.booked", "meeting.cancelled", "meeting.rescheduled"];
+        knownEvents: readonly ["campaign.created", "campaign.updated", "campaign.deleted", "campaign.launched", "campaign.paused", "campaign.completed", "campaign.status_changed", "campaign.content_ready", "document.generated", "document.failed", "intelligence.completed", "intelligence.failed", "company.enriched", "company_intelligence.completed", "audience.ready", "audience.failed", "sequence.draft_created", "sequence.started", "sequence.paused", "sequence.completed", "engagement.email_sent", "engagement.email_replied", "engagement.email_bounced", "engagement.email_skipped", "engagement.call_dispatched", "engagement.call_connected", "engagement.call_graded", "engagement.sms_sent", "engagement.sms_replied", "engagement.whatsapp_sent", "engagement.linkedin_connection_sent", "engagement.linkedin_message_sent", "engagement.linkedin_inmail_sent", "engagement.linkedin_reply_received", "engagement.linkedin_connection_accepted", "meeting.booked", "meeting.cancelled", "meeting.rescheduled", "deal.won", "crm.record.created", "crm.record.updated", "crm.record.archived", "crm.record.restored"];
         constructEvent(payload: string, signature: string, timestamp: string | number, secret: string, opts?: ConstructEventOptions): WebhookEventPayload;
     };
     /** Contacts CRUD (requires API key). */
@@ -4125,25 +4237,44 @@ declare class G8 {
     };
     /** Custom object types, their schema, and their records (requires API key). PREVIEW. */
     get objects(): {
-        list(): Promise<{
+        list(params?: {
+            include_archived?: boolean;
+        }): Promise<{
             data: CustomObject[];
         }>;
+        create(input: CreateCustomObject): Promise<CustomObject>;
+        update(objectSlug: string, input: UpdateCustomObject): Promise<CustomObject>;
+        archive(objectSlug: string): Promise<CustomObject>;
         get(objectSlug: string): Promise<CustomObject>;
-        listAttributes(objectSlug: string): Promise<{
+        listAttributes(objectSlug: string, params?: {
+            include_archived?: boolean;
+        }): Promise<{
             data: CustomObjectAttribute[];
         }>;
+        createAttribute(objectSlug: string, input: CreateCustomObjectAttribute): Promise<CustomObjectAttribute>;
+        updateAttribute(objectSlug: string, attributeSlug: string, input: UpdateCustomObjectAttribute): Promise<CustomObjectAttribute>;
+        archiveAttribute(objectSlug: string, attributeSlug: string): Promise<CustomObjectAttribute>;
         listRecords(objectSlug: string, params?: ListRecordsParams): Promise<{
             data: CustomObjectRecord[];
             pagination?: ObjectPagination;
         }>;
         createRecord(objectSlug: string, values: Record<string, unknown>): Promise<CustomObjectRecord>;
+        upsertRecord(objectSlug: string, matchingAttribute: string, values: Record<string, unknown>, options?: {
+            expectedRevision?: number;
+        }): Promise<CustomObjectRecord>;
         getRecord(objectSlug: string, recordId: string): Promise<CustomObjectRecord>;
         updateRecord(objectSlug: string, recordId: string, values: Record<string, unknown>, options?: {
             expectedRevision?: number;
+            appendValues?: Record<string, unknown[]>;
+            removeValues?: Record<string, unknown[]>;
         }): Promise<CustomObjectRecord>;
         archiveRecord(objectSlug: string, recordId: string): Promise<CustomObjectRecord>;
         restoreRecord(objectSlug: string, recordId: string): Promise<CustomObjectRecord>;
         history(objectSlug: string, recordId: string, limit?: number): Promise<CustomObjectHistory>;
+        changes(objectSlug: string, recordId: string, options?: {
+            limit?: number;
+            cursor?: string;
+        }): Promise<CustomObjectMutations>;
     };
     /** Deals and pipelines (requires API key). */
     get deals(): {
@@ -4967,4 +5098,4 @@ interface Graph8ServiceClient {
  */
 declare function createGraph8ServiceClient(config: Graph8ServiceClientConfig): Graph8ServiceClient;
 
-export { type AddToSequenceConfig, type AgencyClient, type AgencyInfo, type App, type AppCreateParams, type AppDomain, type AppInstallation, type AppLimit, type AppLogs, type AppRequest, type AppRequestOptions, type AppSecretMetadata, type AppSourceParams, type AppStatus, type AppTokenResponse, type AppUsageSummary, type AudienceSync, type AudienceSyncCreateParams, type AudienceSyncError, type AudienceSyncMode, type AudienceSyncPlatform, type AudienceSyncRun, type AudienceSyncUpdateParams, type Booking, type BookingRequest, type CalendarConfig, type CallGradingResult, type Campaign, type CampaignCreateConfig, type CampaignLaunchExecution, type CampaignLaunchResult, type ChatConfig, type Company, type CompanyColumn, type CompanyColumnCreateParams, type CompanyContact, type CompanyEnrichment, type CompanyListParams, type CompanyUpdateParams, type ConstructEventOptions, type Contact, type ContactColumn, type ContactColumnCreateParams, type ContactCreateParams, type ContactDeal, type ContactList, type ContactListParams, type ContactUpdateParams, type ContainerLog, type CopilotConfig, type CreateDeploymentParams, type CreatedField, type CustomObject, type CustomObjectAttribute, type CustomObjectHistory, type CustomObjectHistoryEntry, type CustomObjectRecord, DEFAULT_APP_API, type Deal, type DealCreateParams, type DealListParams, type DealUpdateParams, type Deployment, type DeploymentStatus, type DialerAgentSummary, type DialerAgentsListParams, type DialerAgentsListResult, type DialerNumberInfo, type DialerNumbersListResult, type DialerReportFilters, type DialerReportMetric, type DialerSessionCreateParams, type DialerSessionCreateResult, type DialerSessionResumeResult, type DialerSessionStatus, type DialerSessionStatusUpdateResult, type DialerSessionSummary, type DialerSessionsListParams, type DialerSessionsListResult, type DialerStatsParams, type DialerStatsResult, type DomainVerificationInstructions, type DomainVerificationStatus, type EmailVerification, type EnrichLookupResult, type EvidenceKey, type Field, type FieldCreateParams, type FieldDeleteParams, type G8Config, G8Error, type G8PrivacyConfig, type GlobalContextDocument, type Graph8AppClient, type Graph8AppClientConfig, type Graph8ServiceClient, type Graph8ServiceClientConfig, type ICP, type IdentifyProperties, type InboxAssignResult, type InboxAssignee, type InboxChannel, type InboxContact, type InboxDraft, type InboxListParams, type InboxMessage, type InboxSendParams, type InboxSendResult, type InboxTag, type InboxTagResult, type InboxThread, type InstallStatus, type IntelligenceData, type IntentCompany, type IntentContact, type IntentKeyword, type IntentPage, type IntentSignals, type IntentStats, type IntentVisitor, KNOWN_WEBHOOK_EVENTS, type ListContact, type ListRecordsParams, MAX_TAIL_LINES, MIN_TAIL_LINES, type MarketplaceHiring, type MarketplaceOffer, type MarketplaceProfile, type MeetingAnalysis, type MeetingAttendee, type MeetingDetail, type MeetingListParams, type MeetingSummary, type MeetingTranscriptLine, type MissedCallback, type MissedCallbacksResult, type NodeTypeSchema, type Note, type ObjectPagination, type PaginatedResponse, type PaginationMeta$1 as PaginationMeta, type PersonEnrichment, type Persona, type Pipeline, type PipelineStage, type PipelineSuggestion, type QuotableProduct, type QuoteCreateParams, type QuoteDetail, type QuoteLineItem, type QuoteListParams, type QuoteSendParams, type QuoteSettings, type QuoteStatus, type QuoteSummary, type QuoteUpdateParams, type RequestOptions, type ResearchReport, type SchemaVersion, type SchemaVersionStatus, type SearchCompanyItem, type SearchCondition, type SearchContactItem, type SearchFilter, type SearchOperator, type SearchParams, type SearchResults, type SearchSaveParams, type SearchSaveResult, type Sequence, type SequenceActionResult, type SequenceAnalytics, type SequenceChannelConfig, type SequenceContactItem, type SequenceContactsParams, type SequenceCreateParams, type SequenceCreateResult, type SequenceDetail, type SequenceKind, type SequenceListItem, type SequenceListParams, type SequencePreview, type SequencePreviewChannel, type SequencePreviewStep, type SequenceStepConfig, type SequenceStepInputType, type SequenceStepType, type SequenceStepUpdateParams, type SequenceUpdateParams, type SetFieldValueParams, type Skill, type SkillCreateAPIParams, type SkillCreateLLMParams, type SkillInputField, type SkillListParams, type SkillTemplate, type SkillType, type SkillUpdateAPIParams, type SkillUpdateLLMParams, type Snippet, type SourceProvider, type StageCreateParams, type StagePipeline, type StagePipelineCreateParams, type StagePipelineStage, type StagePipelineUpdateParams, type StageUpdateParams, type Task, type TaskCreateParams, type TaskListParams, type TaskUpdateParams, type TimeSlot, type TokenManager, type TrackProperties, type VisitorCompany, type VisitorScore, type VoicePagination, type WebhookEvent, type WebhookEventPayload, WebhookSignatureError, type Workflow, type WorkflowConfig, type WorkflowConnection, type WorkflowCreateParams, type WorkflowExecution, type WorkflowListParams, type WorkflowNode, type WorkflowUpdateParams, backoffDelayMs, constructEvent, createAppPlatformClient, createAppRequester, createGraph8AppClient, createGraph8ServiceClient, createTokenManager, exchangeBrowserToken, exchangeServiceToken, g8, isRetryableStatus, paginate, parseRetryAfter, request };
+export { type AddToSequenceConfig, type AgencyClient, type AgencyInfo, type App, type AppCreateParams, type AppDomain, type AppInstallation, type AppLimit, type AppLogs, type AppRequest, type AppRequestOptions, type AppSecretMetadata, type AppSourceParams, type AppStatus, type AppTokenResponse, type AppUsageSummary, type AudienceSync, type AudienceSyncCreateParams, type AudienceSyncError, type AudienceSyncMode, type AudienceSyncPlatform, type AudienceSyncRun, type AudienceSyncUpdateParams, type Booking, type BookingRequest, type CalendarConfig, type CallGradingResult, type Campaign, type CampaignCreateConfig, type CampaignLaunchExecution, type CampaignLaunchResult, type ChatConfig, type Company, type CompanyColumn, type CompanyColumnCreateParams, type CompanyContact, type CompanyEnrichment, type CompanyListParams, type CompanyUpdateParams, type ConstructEventOptions, type Contact, type ContactColumn, type ContactColumnCreateParams, type ContactCreateParams, type ContactDeal, type ContactList, type ContactListParams, type ContactUpdateParams, type ContainerLog, type CopilotConfig, type CreateCustomObject, type CreateCustomObjectAttribute, type CreateDeploymentParams, type CreatedField, type CustomObject, type CustomObjectAttribute, type CustomObjectHistory, type CustomObjectHistoryEntry, type CustomObjectIcon, type CustomObjectMutation, type CustomObjectMutations, type CustomObjectRecord, DEFAULT_APP_API, type Deal, type DealCreateParams, type DealListParams, type DealUpdateParams, type Deployment, type DeploymentStatus, type DialerAgentSummary, type DialerAgentsListParams, type DialerAgentsListResult, type DialerNumberInfo, type DialerNumbersListResult, type DialerReportFilters, type DialerReportMetric, type DialerSessionCreateParams, type DialerSessionCreateResult, type DialerSessionResumeResult, type DialerSessionStatus, type DialerSessionStatusUpdateResult, type DialerSessionSummary, type DialerSessionsListParams, type DialerSessionsListResult, type DialerStatsParams, type DialerStatsResult, type DomainVerificationInstructions, type DomainVerificationStatus, type EmailVerification, type EnrichLookupResult, type EvidenceKey, type Field, type FieldCreateParams, type FieldDeleteParams, type G8Config, G8Error, type G8PrivacyConfig, type GlobalContextDocument, type Graph8AppClient, type Graph8AppClientConfig, type Graph8ServiceClient, type Graph8ServiceClientConfig, type ICP, type IdentifyProperties, type InboxAssignResult, type InboxAssignee, type InboxChannel, type InboxContact, type InboxDraft, type InboxListParams, type InboxMessage, type InboxSendParams, type InboxSendResult, type InboxTag, type InboxTagResult, type InboxThread, type InstallStatus, type IntelligenceData, type IntentCompany, type IntentContact, type IntentKeyword, type IntentPage, type IntentSignals, type IntentStats, type IntentVisitor, KNOWN_WEBHOOK_EVENTS, type ListContact, type ListRecordsParams, MAX_TAIL_LINES, MIN_TAIL_LINES, type MarketplaceHiring, type MarketplaceOffer, type MarketplaceProfile, type MeetingAnalysis, type MeetingAttendee, type MeetingDetail, type MeetingListParams, type MeetingSummary, type MeetingTranscriptLine, type MissedCallback, type MissedCallbacksResult, type NodeTypeSchema, type Note, type ObjectPagination, type PaginatedResponse, type PaginationMeta$1 as PaginationMeta, type PersonEnrichment, type Persona, type Pipeline, type PipelineStage, type PipelineSuggestion, type QuotableProduct, type QuoteCreateParams, type QuoteDetail, type QuoteLineItem, type QuoteListParams, type QuoteSendParams, type QuoteSettings, type QuoteStatus, type QuoteSummary, type QuoteUpdateParams, type RequestOptions, type ResearchReport, type SchemaVersion, type SchemaVersionStatus, type SearchCompanyItem, type SearchCondition, type SearchContactItem, type SearchFilter, type SearchOperator, type SearchParams, type SearchResults, type SearchSaveParams, type SearchSaveResult, type Sequence, type SequenceActionResult, type SequenceAnalytics, type SequenceChannelConfig, type SequenceContactItem, type SequenceContactsParams, type SequenceCreateParams, type SequenceCreateResult, type SequenceDetail, type SequenceKind, type SequenceListItem, type SequenceListParams, type SequencePreview, type SequencePreviewChannel, type SequencePreviewStep, type SequenceStepConfig, type SequenceStepInputType, type SequenceStepType, type SequenceStepUpdateParams, type SequenceUpdateParams, type SetFieldValueParams, type Skill, type SkillCreateAPIParams, type SkillCreateLLMParams, type SkillInputField, type SkillListParams, type SkillTemplate, type SkillType, type SkillUpdateAPIParams, type SkillUpdateLLMParams, type Snippet, type SourceProvider, type StageCreateParams, type StagePipeline, type StagePipelineCreateParams, type StagePipelineStage, type StagePipelineUpdateParams, type StageUpdateParams, type Task, type TaskCreateParams, type TaskListParams, type TaskUpdateParams, type TimeSlot, type TokenManager, type TrackProperties, type UpdateCustomObject, type UpdateCustomObjectAttribute, type VisitorCompany, type VisitorScore, type VoicePagination, type WebhookEvent, type WebhookEventPayload, WebhookSignatureError, type Workflow, type WorkflowConfig, type WorkflowConnection, type WorkflowCreateParams, type WorkflowExecution, type WorkflowListParams, type WorkflowNode, type WorkflowUpdateParams, backoffDelayMs, constructEvent, createAppPlatformClient, createAppRequester, createGraph8AppClient, createGraph8ServiceClient, createTokenManager, exchangeBrowserToken, exchangeServiceToken, g8, isRetryableStatus, paginate, parseRetryAfter, request };