@graph8/sdk 0.14.0 → 0.16.0

package/dist/index.d.ts

@@ -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;
@@ -1649,7 +1653,26 @@ interface DealUpdateParams {
     add_contact_ids?: number[];
     /** mashup_contact_ids to unlink. Idempotent. */
     remove_contact_ids?: number[];
+    /**
+     * Buying-committee role per contact on this deal, keyed by
+     * mashup_contact_id. JSON object keys are strings, so the key type is
+     * `string` even though the id is numeric: `{ "5500429": "champion" }`.
+     * `null` clears a contact's role.
+     *
+     * Applies to contacts already linked to the deal, and to contacts linked by
+     * `add_contact_ids` in the same call (roles are applied after the link). An
+     * id that is neither already linked nor being added is rejected with HTTP
+     * 422 naming the id, and the whole update is rolled back. A role outside the
+     * vocabulary is HTTP 422.
+     */
+    contact_roles?: Record<string, DealContactRole | null>;
 }
+/**
+ * Role a contact plays in a deal's buying committee
+ * (`cb_deal_contacts.role`). The same person can hold different roles on
+ * different deals, so this lives on the deal-contact link, not the contact.
+ */
+type DealContactRole = "champion" | "decision_maker" | "influencer" | "blocker" | "coach" | "end_user";
 interface DealListParams {
     page?: number;
     limit?: number;
@@ -1739,6 +1762,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 +1772,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 +1806,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 +1827,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 +1875,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 +1962,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 +1999,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 +2034,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 +2916,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 +2924,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 +2975,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 +4078,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 +4256,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 +5117,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 DealContactRole, 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 };

package/dist/index.js

@@ -891,6 +891,8 @@ var KNOWN_WEBHOOK_EVENTS = [
   "engagement.email_bounced",
   "engagement.email_skipped",
   "engagement.call_dispatched",
+  "engagement.call_connected",
+  "engagement.call_graded",
   "engagement.sms_sent",
   "engagement.sms_replied",
   "engagement.whatsapp_sent",
@@ -901,7 +903,12 @@ var KNOWN_WEBHOOK_EVENTS = [
   "engagement.linkedin_connection_accepted",
   "meeting.booked",
   "meeting.cancelled",
-  "meeting.rescheduled"
+  "meeting.rescheduled",
+  "deal.won",
+  "crm.record.created",
+  "crm.record.updated",
+  "crm.record.archived",
+  "crm.record.restored"
 ];
 var WebhookSignatureError = class extends Error {
   constructor(message) {
@@ -1586,8 +1593,32 @@ var createObjectsClient = (apiKey, apiUrl) => {
   const encode = (value) => encodeURIComponent(value);
   return {
     /** List the custom object types in your workspace. */
-    async list() {
-      return request(baseUrl, "/api/v1/objects", apiKey);
+    async list(params = {}) {
+      const query = params.include_archived ? "?include_archived=true" : "";
+      return request(baseUrl, `/api/v1/objects${query}`, apiKey);
+    },
+    /** Create a native custom object. Requires objects:manage and Admin access. */
+    async create(input) {
+      const resp = await request(baseUrl, "/api/v1/objects", apiKey, {
+        method: "POST",
+        body: input
+      });
+      return resp.data;
+    },
+    /** Rename, archive or restore an object while preserving its slug and data. */
+    async update(objectSlug, input) {
+      const resp = await request(baseUrl, `/api/v1/objects/${encode(objectSlug)}`, apiKey, {
+        method: "PATCH",
+        body: input
+      });
+      return resp.data;
+    },
+    /** Archive the object without deleting records; restore with update({ is_archived: false }). */
+    async archive(objectSlug) {
+      const resp = await request(baseUrl, `/api/v1/objects/${encode(objectSlug)}`, apiKey, {
+        method: "DELETE"
+      });
+      return resp.data;
     },
     /** Fetch one object type by slug. */
     async get(objectSlug) {
@@ -1599,10 +1630,35 @@ var createObjectsClient = (apiKey, apiUrl) => {
       return resp.data ?? resp;
     },
     /** The object's attributes — the schema its records must satisfy. */
-    async listAttributes(objectSlug) {
-      return request(baseUrl, `/api/v1/objects/${encode(objectSlug)}/attributes`, apiKey);
+    async listAttributes(objectSlug, params = {}) {
+      const query = params.include_archived ? "?include_archived=true" : "";
+      return request(baseUrl, `/api/v1/objects/${encode(objectSlug)}/attributes${query}`, apiKey);
     },
-    /** Paginated records with their current values. Archived records are excluded. */
+    /** Create a field using the same schema rules as the customer UI. */
+    async createAttribute(objectSlug, input) {
+      const resp = await request(baseUrl, `/api/v1/objects/${encode(objectSlug)}/attributes`, apiKey, {
+        method: "POST",
+        body: input
+      });
+      return resp.data;
+    },
+    /** Edit or restore a field; its type and slug are immutable. */
+    async updateAttribute(objectSlug, attributeSlug, input) {
+      const resp = await request(baseUrl, `/api/v1/objects/${encode(objectSlug)}/attributes/${encode(attributeSlug)}`, apiKey, {
+        method: "PATCH",
+        body: input
+      });
+      return resp.data;
+    },
+    /** Archive without deleting values; restore with updateAttribute({ is_archived: false }). */
+    async archiveAttribute(objectSlug, attributeSlug) {
+      const resp = await request(baseUrl, `/api/v1/objects/${encode(objectSlug)}/attributes/${encode(attributeSlug)}`, apiKey, {
+        method: "DELETE"
+      });
+      return resp.data;
+    },
+    /** Paginated custom records or canonical deals with current values and revisions.
+     * Deal totals and related references respect current record access. */
     async listRecords(objectSlug, params = {}) {
       const query = {};
       if (params.page != null) query.page = params.page;
@@ -1626,7 +1682,24 @@ var createObjectsClient = (apiKey, apiUrl) => {
       );
       return resp.data ?? resp;
     },
-    /** Fetch one record with its currently active values. */
+    /** Match a unique single-value key, creating or updating while preserving omitted fields. */
+    async upsertRecord(objectSlug, matchingAttribute, values, options = {}) {
+      const resp = await request(
+        baseUrl,
+        `/api/v1/objects/${encode(objectSlug)}/records/upsert`,
+        apiKey,
+        { method: "POST", body: {
+          matching_attribute: matchingAttribute,
+          values,
+          ...options.expectedRevision !== void 0 ? { expected_revision: options.expectedRevision } : {}
+        } }
+      );
+      return resp.data;
+    },
+    /** 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.
+     */
     async getRecord(objectSlug, recordId) {
       const resp = await request(
         baseUrl,
@@ -1640,15 +1713,24 @@ var createObjectsClient = (apiKey, apiUrl) => {
      * 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.
      */
     async updateRecord(objectSlug, recordId, values, options) {
       const resp = await request(
         baseUrl,
         `/api/v1/objects/${encode(objectSlug)}/records/${encode(recordId)}`,
         apiKey,
-        { method: "PATCH", body: { values, ...options?.expectedRevision === void 0 ? {} : { expected_revision: options.expectedRevision } } }
+        {
+          method: "PATCH",
+          body: {
+            values,
+            ...options?.expectedRevision === void 0 ? {} : { expected_revision: options.expectedRevision },
+            ...options?.appendValues === void 0 ? {} : { append_values: options.appendValues },
+            ...options?.removeValues === void 0 ? {} : { remove_values: options.removeValues }
+          }
+        }
       );
       return resp.data ?? resp;
     },
@@ -1687,6 +1769,19 @@ var createObjectsClient = (apiKey, apiUrl) => {
         { query: limit != null ? { limit } : void 0 }
       );
       return resp.data ?? resp;
+    },
+    /** 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.
+     */
+    async changes(objectSlug, recordId, options = {}) {
+      const resp = await request(
+        baseUrl,
+        `/api/v1/objects/${encode(objectSlug)}/records/${encode(recordId)}/changes`,
+        apiKey,
+        { query: options }
+      );
+      return resp.data ?? resp;
     }
   };
 };