@graph8/sdk 0.251.0 → 0.262.0

package/docs/api/integrations.md

@@ -0,0 +1,3791 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.integrations`: Integrations
+
+83 operations (39 read, 5 destructive, 39 external).
+
+No hand-written client covers this area. Call it through `g8.api.integrations.*` 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: [integrations.d.ts](integrations.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`batchCreateCrmContacts`](#op-batchcreatecrmcontacts) | `POST /api/v1/integrations/crm/connections/{connection_id}/batch/contacts` | external | `integrations:run` | Batch Create Crm Contacts |
+| [`batchUpdateCrmContacts`](#op-batchupdatecrmcontacts) | `PUT /api/v1/integrations/crm/connections/{connection_id}/batch/contacts` | external | `integrations:run` | Batch Update Crm Contacts |
+| [`cancelMigration`](#op-cancelmigration) | `POST /api/v1/integrations/migrations/{migration_id}/cancel` | destructive | `integrations:delete` | Cancel Migration |
+| [`confirmMigration`](#op-confirmmigration) | `POST /api/v1/integrations/migrations/{migration_id}/confirm` | external | `integrations:run` | Confirm Migration |
+| [`connectSugarcrm`](#op-connectsugarcrm) | `POST /api/v1/integrations/sugarcrm/connect` | external | `integrations:run` | Connect Sugarcrm |
+| [`createConnectionSessionToken`](#op-createconnectionsessiontoken) | `POST /api/v1/integrations/connections/session-token` | external | `integrations:run` | Create Connection Session Token |
+| [`createCrmCompany`](#op-createcrmcompany) | `POST /api/v1/integrations/crm/connections/{connection_id}/companies` | external | `integrations:run` | Create Crm Company |
+| [`createCrmContact`](#op-createcrmcontact) | `POST /api/v1/integrations/crm/connections/{connection_id}/contacts` | external | `integrations:run` | Create Crm Contact |
+| [`createCrmDeal`](#op-createcrmdeal) | `POST /api/v1/integrations/crm/connections/{connection_id}/deals` | external | `integrations:run` | Create Crm Deal |
+| [`createCrmLead`](#op-createcrmlead) | `POST /api/v1/integrations/crm/connections/{connection_id}/leads` | external | `integrations:run` | Create Crm Lead |
+| [`createCrmMeeting`](#op-createcrmmeeting) | `POST /api/v1/integrations/crm/meetings` | external | `integrations:run` | Create Crm Meeting |
+| [`createGoogleConversionAction`](#op-creategoogleconversionaction) | `POST /api/v1/audience-syncs/google/conversion-actions` | external | `integrations:run` | Create Google Conversion Action |
+| [`createVideoUploadUrl`](#op-createvideouploadurl) | `POST /api/v1/audience-syncs/google/video-assets/upload-urls` | external | `integrations:run` | Create Video Upload Url |
+| [`deleteConnection`](#op-deleteconnection) | `DELETE /api/v1/integrations/connections/{connection_id}` | destructive | `integrations:delete` | Delete Connection |
+| [`deleteCrmContact`](#op-deletecrmcontact) | `DELETE /api/v1/integrations/crm/connections/{connection_id}/contacts/{contact_id}` | destructive | `integrations:delete` | Delete Crm Contact |
+| [`discardDraftSyncConfig`](#op-discarddraftsyncconfig) | `DELETE /api/v1/audience-syncs/{config_id}/draft` | destructive | `integrations:delete` | Discard Draft Sync Config |
+| [`disconnectSugarcrm`](#op-disconnectsugarcrm) | `DELETE /api/v1/integrations/sugarcrm` | destructive | `integrations:delete` | Disconnect Sugarcrm |
+| [`discoverCrmFields`](#op-discovercrmfields) | `GET /api/v1/integrations/crm/fields` | read | `integrations:read` | Discover Crm Fields |
+| [`findCrmUserByEmail`](#op-findcrmuserbyemail) | `GET /api/v1/integrations/crm/users/by-email` | read | `integrations:read` | Find Crm User By Email |
+| [`getAdAnalyticsSummary`](#op-getadanalyticssummary) | `GET /api/v1/audience-syncs/analytics/summary` | read | `integrations:read` | Get Ad Analytics Summary |
+| [`getAdDailyTrend`](#op-getaddailytrend) | `GET /api/v1/audience-syncs/analytics/daily-trend` | read | `integrations:read` | Get Ad Daily Trend |
+| [`getCrmCompany`](#op-getcrmcompany) | `GET /api/v1/integrations/crm/connections/{connection_id}/companies/{company_id}` | read | `integrations:read` | Get Crm Company |
+| [`getCrmConnection`](#op-getcrmconnection) | `GET /api/v1/integrations/crm/connections/{connection_id}` | read | `integrations:read` | Get Crm Connection |
+| [`getCrmConnectionMetadata`](#op-getcrmconnectionmetadata) | `GET /api/v1/integrations/crm/connections/{connection_id}/metadata` | read | `integrations:read` | Get Crm Connection Metadata |
+| [`getCrmConnectionStatus`](#op-getcrmconnectionstatus) | `GET /api/v1/integrations/crm/connections/{connection_id}/status` | read | `integrations:read` | Get Crm Connection Status |
+| [`getCrmContact`](#op-getcrmcontact) | `GET /api/v1/integrations/crm/connections/{connection_id}/contacts/{contact_id}` | read | `integrations:read` | Get Crm Contact |
+| [`getCrmDeal`](#op-getcrmdeal) | `GET /api/v1/integrations/crm/connections/{connection_id}/deals/{deal_id}` | read | `integrations:read` | Get Crm Deal |
+| [`getCrmLead`](#op-getcrmlead) | `GET /api/v1/integrations/crm/connections/{connection_id}/leads/{lead_id}` | read | `integrations:read` | Get Crm Lead |
+| [`getGoogleConversionTracking`](#op-getgoogleconversiontracking) | `GET /api/v1/audience-syncs/google/conversion-tracking` | read | `integrations:read` | Get Google Conversion Tracking |
+| [`getLastCompletedMigration`](#op-getlastcompletedmigration) | `GET /api/v1/integrations/connections/{connection_id}/last-migration` | read | `integrations:read` | Get Last Completed Migration |
+| [`getMigrationStatus`](#op-getmigrationstatus) | `GET /api/v1/integrations/migrations/{migration_id}` | read | `integrations:read` | Get Migration Status |
+| [`getOrCreateCrmAudience`](#op-getorcreatecrmaudience) | `POST /api/v1/integrations/crm-sync/audiences` | external | `integrations:run` | Get Or Create Crm Audience |
+| [`getOrCreateCrmList`](#op-getorcreatecrmlist) | `POST /api/v1/integrations/crm/lists` | external | `integrations:run` | Get Or Create Crm List |
+| [`getSyncConfigAnalytics`](#op-getsyncconfiganalytics) | `GET /api/v1/audience-syncs/{config_id}/analytics` | read | `integrations:read` | Get Sync Config Analytics |
+| [`getSyncJob`](#op-getsyncjob) | `GET /api/v1/integrations/crm-sync/jobs/{job_id}` | read | `integrations:read` | Get Sync Job |
+| [`getSyncSegmentStatus`](#op-getsyncsegmentstatus) | `GET /api/v1/audience-syncs/{config_id}/segment-status` | read | `integrations:read` | Get Sync Segment Status |
+| [`getVideoAsset`](#op-getvideoasset) | `GET /api/v1/audience-syncs/google/video-assets/{asset_id}` | read | `integrations:read` | Get Video Asset |
+| [`listAdAccountHealth`](#op-listadaccounthealth) | `GET /api/v1/audience-syncs/account-health` | read | `integrations:read` | List Ad Account Health |
+| [`listAdAccounts`](#op-listadaccounts) | `GET /api/v1/audience-syncs/accounts` | read | `integrations:read` | List Ad Accounts |
+| [`listAdPlatforms`](#op-listadplatforms) | `GET /api/v1/audience-syncs/platforms` | read | `integrations:read` | List Ad Platforms |
+| [`listCompanyActivitiesByGraph8Id`](#op-listcompanyactivitiesbygraph8id) | `GET /api/v1/integrations/crm/company-activities` | read | `integrations:read` | List Company Activities By Graph8 Id |
+| [`listConnections`](#op-listconnections) | `GET /api/v1/integrations/connections` | read | `integrations:read` | List Connections |
+| [`listContactActivitiesByGraph8Id`](#op-listcontactactivitiesbygraph8id) | `GET /api/v1/integrations/crm/contact-activities` | read | `integrations:read` | List Contact Activities By Graph8 Id |
+| [`listCrmActivities`](#op-listcrmactivities) | `GET /api/v1/integrations/crm/activities` | read | `integrations:read` | List Crm Activities |
+| [`listCrmCompanies`](#op-listcrmcompanies) | `GET /api/v1/integrations/crm/connections/{connection_id}/companies` | read | `integrations:read` | List Crm Companies |
+| [`listCrmContactActivities`](#op-listcrmcontactactivities) | `GET /api/v1/integrations/crm/connections/{connection_id}/contacts/{contact_id}/activities` | read | `integrations:read` | List Crm Contact Activities |
+| [`listCrmContacts`](#op-listcrmcontacts) | `GET /api/v1/integrations/crm/connections/{connection_id}/contacts` | read | `integrations:read` | List Crm Contacts |
+| [`listCrmDeals`](#op-listcrmdeals) | `GET /api/v1/integrations/crm/connections/{connection_id}/deals` | read | `integrations:read` | List Crm Deals |
+| [`listCrmLeads`](#op-listcrmleads) | `GET /api/v1/integrations/crm/connections/{connection_id}/leads` | read | `integrations:read` | List Crm Leads |
+| [`listCrmLists`](#op-listcrmlists) | `GET /api/v1/integrations/crm/lists` | read | `integrations:read` | List Crm Lists |
+| [`listCrmMeetings`](#op-listcrmmeetings) | `GET /api/v1/integrations/crm/meetings` | read | `integrations:read` | List Crm Meetings |
+| [`listCrmUsers`](#op-listcrmusers) | `GET /api/v1/integrations/crm/users` | read | `integrations:read` | List Crm Users |
+| [`listLeadStatuses`](#op-listleadstatuses) | `GET /api/v1/integrations/crm-sync/leads/statuses` | read | `integrations:read` | List Lead Statuses |
+| [`listMappableGraph8Fields`](#op-listmappablegraph8fields) | `GET /api/v1/integrations/crm/fields/mappable` | read | `integrations:read` | List Mappable Graph8 Fields |
+| [`listVideoAssets`](#op-listvideoassets) | `GET /api/v1/audience-syncs/google/video-assets` | read | `integrations:read` | List Video Assets |
+| [`lookupCrmContactsByEmail`](#op-lookupcrmcontactsbyemail) | `POST /api/v1/integrations/crm/connections/{connection_id}/batch/contacts/lookup-by-email` | read | `integrations:read` | Lookup Crm Contacts By Email |
+| [`modifyCrmListMemberships`](#op-modifycrmlistmemberships) | `POST /api/v1/integrations/crm/lists/memberships` | external | `integrations:run` | Modify Crm List Memberships |
+| [`previewLeadPush`](#op-previewleadpush) | `GET /api/v1/integrations/crm-sync/leads/push-preview` | read | `integrations:read` | Preview Lead Push |
+| [`pullAllContacts`](#op-pullallcontacts) | `POST /api/v1/integrations/crm-sync/contacts/pull` | external | `integrations:run` | Pull All Contacts |
+| [`pullAllDeals`](#op-pullalldeals) | `POST /api/v1/integrations/crm-sync/deals/pull` | external | `integrations:run` | Pull All Deals |
+| [`pullAllLeads`](#op-pullallleads) | `POST /api/v1/integrations/crm-sync/leads/pull` | external | `integrations:run` | Pull All Leads |
+| [`pullCrmList`](#op-pullcrmlist) | `POST /api/v1/integrations/crm-sync/pull` | external | `integrations:run` | Pull Crm List |
+| [`pushAllContacts`](#op-pushallcontacts) | `POST /api/v1/integrations/crm-sync/contacts/push` | external | `integrations:run` | Push All Contacts |
+| [`pushAllDeals`](#op-pushalldeals) | `POST /api/v1/integrations/crm-sync/deals/push` | external | `integrations:run` | Push All Deals |
+| [`pushAllLeads`](#op-pushallleads) | `POST /api/v1/integrations/crm-sync/leads/push` | external | `integrations:run` | Push All Leads |
+| [`pushAudience`](#op-pushaudience) | `POST /api/v1/integrations/crm-sync/push` | external | `integrations:run` | Push Audience |
+| [`reconnectSugarcrm`](#op-reconnectsugarcrm) | `POST /api/v1/integrations/sugarcrm/reconnect` | external | `integrations:run` | Reconnect Sugarcrm |
+| [`registerUploadedVideoAsset`](#op-registeruploadedvideoasset) | `POST /api/v1/audience-syncs/google/video-assets/uploads` | external | `integrations:run` | Register Uploaded Video Asset |
+| [`registerVideoAssetFromLibrary`](#op-registervideoassetfromlibrary) | `POST /api/v1/audience-syncs/google/video-assets/library` | external | `integrations:run` | Register Video Asset From Library |
+| [`registerVideoAssetFromLink`](#op-registervideoassetfromlink) | `POST /api/v1/audience-syncs/google/video-assets/links` | external | `integrations:run` | Register Video Asset From Link |
+| [`saveConnection`](#op-saveconnection) | `POST /api/v1/integrations/connections` | external | `integrations:run` | Save Connection |
+| [`setPullSyncEnabled`](#op-setpullsyncenabled) | `PUT /api/v1/integrations/crm-sync/pull-enabled` | external | `integrations:run` | Set Pull Sync Enabled |
+| [`setPushSyncEnabled`](#op-setpushsyncenabled) | `PUT /api/v1/integrations/crm-sync/push-enabled` | external | `integrations:run` | Set Push Sync Enabled |
+| [`startDeltaSync`](#op-startdeltasync) | `POST /api/v1/integrations/migrations/delta-sync` | external | `integrations:run` | Start Delta Sync |
+| [`startLeadPreview`](#op-startleadpreview) | `POST /api/v1/integrations/crm-sync/leads/previews` | external | `integrations:run` | Start Lead Preview |
+| [`startMigrationDiscovery`](#op-startmigrationdiscovery) | `POST /api/v1/integrations/migrations/discovery` | external | `integrations:run` | Start Migration Discovery |
+| [`updateCrmCompany`](#op-updatecrmcompany) | `PUT /api/v1/integrations/crm/connections/{connection_id}/companies/{company_id}` | external | `integrations:run` | Update Crm Company |
+| [`updateCrmContact`](#op-updatecrmcontact) | `PUT /api/v1/integrations/crm/connections/{connection_id}/contacts/{contact_id}` | external | `integrations:run` | Update Crm Contact |
+| [`updateCrmDeal`](#op-updatecrmdeal) | `PUT /api/v1/integrations/crm/connections/{connection_id}/deals/{deal_id}` | external | `integrations:run` | Update Crm Deal |
+| [`updateCrmLead`](#op-updatecrmlead) | `PUT /api/v1/integrations/crm/connections/{connection_id}/leads/{lead_id}` | external | `integrations:run` | Update Crm Lead |
+| [`updateCrmMeeting`](#op-updatecrmmeeting) | `PATCH /api/v1/integrations/crm/meetings/{event_id}` | external | `integrations:run` | Update Crm Meeting |
+| [`uploadGoogleConversions`](#op-uploadgoogleconversions) | `POST /api/v1/audience-syncs/google/conversions` | external | `integrations:run` | Upload Google Conversions |
+| [`validateSugarcrm`](#op-validatesugarcrm) | `POST /api/v1/integrations/sugarcrm/validate` | read | `integrations:read` | Validate Sugarcrm |
+
+---
+
+<a id="op-batchcreatecrmcontacts"></a>
+
+### `g8.api.integrations.batchCreateCrmContacts(input)`
+
+**Batch Create Crm Contacts**
+
+- HTTP: `POST /api/v1/integrations/crm/connections/{connection_id}/batch/contacts`
+- operationId: `batch_create_crm_contacts_integrations_crm_connections__connection_id__batch_contacts_post` (also callable as `g8.api.call("batch_create_crm_contacts_integrations_crm_connections__connection_id__batch_contacts_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Create many contacts in one provider round trip.
+
+PARTIAL SUCCESS IS POSSIBLE. The response carries per-record outcomes;
+a 201 does not mean every record landed. Read them before retrying, or a
+retry duplicates the ones that succeeded.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `body` | `BatchContactsRequest` | yes | Request body; fields below. |
+
+Body fields (`BatchContactsRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.contacts` | `Array<BatchContactRequest>` | yes | min items 1 |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.batchCreateCrmContacts({
+  path: { connection_id: "id" },
+  body: { contacts: [{ email: "jane@acme.com" }] },
+});
+```
+
+---
+
+<a id="op-batchupdatecrmcontacts"></a>
+
+### `g8.api.integrations.batchUpdateCrmContacts(input)`
+
+**Batch Update Crm Contacts**
+
+- HTTP: `PUT /api/v1/integrations/crm/connections/{connection_id}/batch/contacts`
+- operationId: `batch_update_crm_contacts_integrations_crm_connections__connection_id__batch_contacts_put` (also callable as `g8.api.call("batch_update_crm_contacts_integrations_crm_connections__connection_id__batch_contacts_put", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Update many contacts in one provider round trip.
+
+Each entry needs `crm_id` - on this path it identifies the record to
+update, and an entry without one cannot be matched. Partial success is
+possible here too.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `body` | `BatchContactsRequest` | yes | Request body; fields below. |
+
+Body fields (`BatchContactsRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.contacts` | `Array<BatchContactRequest>` | yes | min items 1 |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.batchUpdateCrmContacts({
+  path: { connection_id: "id" },
+  body: { contacts: [{ email: "jane@acme.com" }] },
+});
+```
+
+---
+
+<a id="op-cancelmigration"></a>
+
+### `g8.api.integrations.cancelMigration(input)`
+
+**Cancel Migration**
+
+- HTTP: `POST /api/v1/integrations/migrations/{migration_id}/cancel`
+- operationId: `cancel_migration_integrations_migrations__migration_id__cancel_post` (also callable as `g8.api.call("cancel_migration_integrations_migrations__migration_id__cancel_post", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `integrations:delete`
+
+Stop a running migration.
+
+Records already imported STAY - this stops the import, it does not undo
+it. The status goes to `cancelling` rather than `cancelled`, because work
+already in flight has to finish first.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.migration_id` | `string` | yes | Migration id. |
+
+**Returns** `ApiResponse_ConnectionPayload_`: the envelope `{ data: ConnectionPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.integrations.cancelMigration({ path: { migration_id: "id" } });
+```
+
+---
+
+<a id="op-confirmmigration"></a>
+
+### `g8.api.integrations.confirmMigration(input)`
+
+**Confirm Migration**
+
+- HTTP: `POST /api/v1/integrations/migrations/{migration_id}/confirm`
+- operationId: `confirm_migration_integrations_migrations__migration_id__confirm_post` (also callable as `g8.api.call("confirm_migration_integrations_migrations__migration_id__confirm_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Accept the discovery and START IMPORTING. Records begin landing.
+
+A migration cannot be un-run - only cancelled part-way, leaving whatever
+already arrived. Read the status first: its `warnings` are the things
+discovery could not resolve on its own.
+
+An empty body accepts the discovery as proposed, which is the point of
+previewing it. Org admin, matching the app.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.migration_id` | `string` | yes | Migration id from discovery. |
+| `body` | `ConfirmMigrationRequest` | no | Request body; fields below. |
+
+Body fields (`ConfirmMigrationRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.field_mappings_override` | `Record<string, Array<Record<string, unknown>>> \| null` | no | Per entity type, the mappings to use instead of the discovered ones. Omit to accept what discovery proposed. |
+| `body.selected_list_ids` | `Array<string> \| null` | no | Import only these CRM lists. Omit to take every discovered list. |
+
+**Returns** `ApiResponse_ConnectionPayload_`: the envelope `{ data: ConnectionPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.confirmMigration({ path: { migration_id: "id" } });
+```
+
+---
+
+<a id="op-connectsugarcrm"></a>
+
+### `g8.api.integrations.connectSugarcrm(input)`
+
+**Connect Sugarcrm**
+
+- HTTP: `POST /api/v1/integrations/sugarcrm/connect`
+- operationId: `connect_sugarcrm_integrations_sugarcrm_connect_post` (also callable as `g8.api.call("connect_sugarcrm_integrations_sugarcrm_connect_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Connect SugarCRM. REACHES YOUR SUGARCRM to authenticate first.
+
+409 when a SugarCRM connection already exists - rotate its credentials
+with `/sugarcrm/reconnect` instead. 400 for an instance URL that does not
+resolve to a public host, 401 when SugarCRM rejects the credentials.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `SugarCrmConnectRequest` | yes | Request body; fields below. |
+
+Body fields (`SugarCrmConnectRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.instance_url` | `string` | yes | Your SugarCRM instance, e.g. https://acme.sugarondemand.com. |
+| `body.password` | `string` | yes |  |
+| `body.username` | `string` | yes |  |
+| `body.client_id` | `string` | no | OAuth client id configured in SugarCRM. default `"sugar"` |
+| `body.client_secret` | `string` | no | OAuth client secret, if your client id has one. default `""` |
+
+**Returns** `ApiResponse_IntegrationOpPayload_`: the envelope `{ data: IntegrationOpPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.connectSugarcrm({
+  body: {
+    instance_url: "https://example.com",
+    password: "example",
+    username: "Example",
+  },
+});
+```
+
+---
+
+<a id="op-createconnectionsessiontoken"></a>
+
+### `g8.api.integrations.createConnectionSessionToken(input?)`
+
+**Create Connection Session Token**
+
+- HTTP: `POST /api/v1/integrations/connections/session-token`
+- operationId: `create_connection_session_token_integrations_connections_session_token_post` (also callable as `g8.api.call("create_connection_session_token_integrations_connections_session_token_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Mint a short-lived token for the hosted OAuth flow.
+
+The token is what a browser hands to the connection provider to run the
+consent screen; this call does not connect anything by itself. The result
+of that flow comes back to `POST /integrations/connections`.
+
+The body is optional - omit it to take the app's default provider.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `SessionTokenRequest \| null` | no | Request body; fields below. |
+
+Body fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.provider` | `string \| null` | no | Stable graph8 provider name. |
+| `body.provider_config_key` | `string \| null` | no | Provider config key on the connection provider. |
+
+**Returns** `ApiResponse_ConnectionPayload_`: the envelope `{ data: ConnectionPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.createConnectionSessionToken();
+```
+
+---
+
+<a id="op-createcrmcompany"></a>
+
+### `g8.api.integrations.createCrmCompany(input)`
+
+**Create Crm Company**
+
+- HTTP: `POST /api/v1/integrations/crm/connections/{connection_id}/companies`
+- operationId: `create_crm_company_integrations_crm_connections__connection_id__companies_post` (also callable as `g8.api.call("create_crm_company_integrations_crm_connections__connection_id__companies_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Create a company IN THE CUSTOMER'S CRM.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `body` | `CrmCompanyCreateRequest` | yes | Request body; fields below. |
+
+Body fields (`CrmCompanyCreateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.name` | `string` | yes |  |
+| `body.address` | `CrmAddress \| null` | no |  |
+| `body.annual_revenue` | `number \| null` | no |  |
+| `body.custom_fields` | `Array<CrmCustomField>` | no |  |
+| `body.domain` | `string \| null` | no |  |
+| `body.employee_count` | `integer \| null` | no |  |
+| `body.industry` | `string \| null` | no |  |
+| `body.phone` | `string \| null` | no |  |
+| `body.website` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.createCrmCompany({ path: { connection_id: "id" }, body: { name: "Example" } });
+```
+
+---
+
+<a id="op-createcrmcontact"></a>
+
+### `g8.api.integrations.createCrmContact(input)`
+
+**Create Crm Contact**
+
+- HTTP: `POST /api/v1/integrations/crm/connections/{connection_id}/contacts`
+- operationId: `create_crm_contact_integrations_crm_connections__connection_id__contacts_post` (also callable as `g8.api.call("create_crm_contact_integrations_crm_connections__connection_id__contacts_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Create a contact IN THE CUSTOMER'S CRM. This writes to their system.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `body` | `CrmContactCreateRequest` | yes | Request body; fields below. |
+
+Body fields (`CrmContactCreateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.address` | `CrmAddress \| null` | no |  |
+| `body.company_id` | `string \| null` | no | The CRM's company id, not graph8's. |
+| `body.company_name` | `string \| null` | no |  |
+| `body.custom_fields` | `Array<CrmCustomField>` | no |  |
+| `body.emails` | `Array<CrmEmail>` | no |  |
+| `body.first_name` | `string \| null` | no |  |
+| `body.last_name` | `string \| null` | no |  |
+| `body.name` | `string \| null` | no |  |
+| `body.phones` | `Array<CrmPhone>` | no |  |
+| `body.source` | `string \| null` | no |  |
+| `body.tags` | `Array<string>` | no |  |
+| `body.title` | `string \| null` | no |  |
+| `body.user_id` | `string \| null` | no | CRM owner. See `GET /integrations/crm/users`. |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.createCrmContact({ path: { connection_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-createcrmdeal"></a>
+
+### `g8.api.integrations.createCrmDeal(input)`
+
+**Create Crm Deal**
+
+- HTTP: `POST /api/v1/integrations/crm/connections/{connection_id}/deals`
+- operationId: `create_crm_deal_integrations_crm_connections__connection_id__deals_post` (also callable as `g8.api.call("create_crm_deal_integrations_crm_connections__connection_id__deals_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Create a deal IN THE CUSTOMER'S CRM.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `body` | `CrmDealCreateRequest` | yes | Request body; fields below. |
+
+Body fields (`CrmDealCreateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.name` | `string` | yes |  |
+| `body.amount` | `number \| null` | no |  |
+| `body.close_date` | `string \| null` | no | ISO 8601 date. |
+| `body.company_id` | `string \| null` | no |  |
+| `body.contact_id` | `string \| null` | no |  |
+| `body.custom_fields` | `Array<CrmCustomField>` | no |  |
+| `body.description` | `string \| null` | no |  |
+| `body.probability` | `number \| null` | no |  |
+| `body.stage` | `string \| null` | no | Provider's pipeline stage. Omit to take the provider's default stage. |
+| `body.type` | `string \| null` | no |  |
+| `body.user_id` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.createCrmDeal({ path: { connection_id: "id" }, body: { name: "Example" } });
+```
+
+---
+
+<a id="op-createcrmlead"></a>
+
+### `g8.api.integrations.createCrmLead(input)`
+
+**Create Crm Lead**
+
+- HTTP: `POST /api/v1/integrations/crm/connections/{connection_id}/leads`
+- operationId: `create_crm_lead_integrations_crm_connections__connection_id__leads_post` (also callable as `g8.api.call("create_crm_lead_integrations_crm_connections__connection_id__leads_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Create a Lead IN THE CUSTOMER'S SALESFORCE.
+
+`last_name` and `company` are required by Salesforce itself. `status` is an
+OPEN picklist - read the valid values from
+`GET /integrations/crm-sync/leads/statuses` first, because an invented one
+is stored rather than refused.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `body` | `LeadCreateRequest` | yes | Request body; fields below. |
+
+Body fields (`LeadCreateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.company` | `string` | yes |  |
+| `body.last_name` | `string` | yes |  |
+| `body.address` | `CrmAddress \| null` | no |  |
+| `body.annual_revenue` | `number \| null` | no |  |
+| `body.custom_fields` | `Array<CrmCustomField>` | no |  |
+| `body.email` | `string \| null` | no |  |
+| `body.employee_count` | `integer \| null` | no |  |
+| `body.first_name` | `string \| null` | no |  |
+| `body.industry` | `string \| null` | no |  |
+| `body.lead_source` | `string \| null` | no |  |
+| `body.phone` | `string \| null` | no |  |
+| `body.status` | `string \| null` | no | Salesforce `Lead.Status` API name. Read the valid values from `GET /integrations/crm-sync/leads/statuses` - it is an OPEN picklist, so an invented value silently becomes a real status. |
+| `body.title` | `string \| null` | no |  |
+| `body.user_id` | `string \| null` | no |  |
+| `body.website` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.createCrmLead({
+  path: { connection_id: "id" },
+  body: { company: "example", last_name: "Example" },
+});
+```
+
+---
+
+<a id="op-createcrmmeeting"></a>
+
+### `g8.api.integrations.createCrmMeeting(input)`
+
+**Create Crm Meeting**
+
+- HTTP: `POST /api/v1/integrations/crm/meetings`
+- operationId: `create_crm_meeting_integrations_crm_meetings_post` (also callable as `g8.api.call("create_crm_meeting_integrations_crm_meetings_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Create a meeting on the CRM's calendar and associate it with records.
+
+This does not send an invitation - it records the meeting on the CRM
+object. `/appointments/*` is the surface that books with a person.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.connection_id` | `string` | yes |  |
+| `body` | `CreateMeetingRequest` | yes | Request body; fields below. |
+
+Body fields (`CreateMeetingRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.company_ids` | `Array<string> \| null` | no |  |
+| `body.contact_ids` | `Array<string> \| null` | no | CRM contact ids to associate. |
+| `body.deal_ids` | `Array<string> \| null` | no |  |
+| `body.description` | `string \| null` | no |  |
+| `body.end_at` | `string \| null` | no | ISO 8601. |
+| `body.location` | `string \| null` | no |  |
+| `body.start_at` | `string \| null` | no | ISO 8601. |
+| `body.title` | `string \| null` | no |  |
+| `body.user_id` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.createCrmMeeting({ query: { connection_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-creategoogleconversionaction"></a>
+
+### `g8.api.integrations.createGoogleConversionAction(input?)`
+
+**Create Google Conversion Action**
+
+- HTTP: `POST /api/v1/audience-syncs/google/conversion-actions`
+- operationId: `create_google_conversion_action_audience_syncs_google_conversion_actions_post` (also callable as `g8.api.call("create_google_conversion_action_audience_syncs_google_conversion_actions_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Create a conversion action ON THE CUSTOMER'S GOOGLE ADS ACCOUNT.
+
+IDEMPOTENT: an action with the same name is reused rather than duplicated,
+so this is safe to call before every launch. An empty body provisions the
+default primary landing-page action - the same one a Demand Gen or
+Performance Max launch provisions for itself.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.ad_account_id` | `string \| null` | no |  |
+| `body` | `CreateConversionActionRequest \| null` | no | Request body; fields below. |
+
+Body fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.category` | `string` | no | default `"DEFAULT"` |
+| `body.name` | `string` | no | default `"graph8 Landing Page Conversions"`, max length 200 |
+| `body.primary_for_goal` | `boolean` | no | default `true` |
+
+**Returns** `ApiResponse_AdPayload_`: the envelope `{ data: AdPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.createGoogleConversionAction();
+```
+
+---
+
+<a id="op-createvideouploadurl"></a>
+
+### `g8.api.integrations.createVideoUploadUrl(input)`
+
+**Create Video Upload Url**
+
+- HTTP: `POST /api/v1/audience-syncs/google/video-assets/upload-urls`
+- operationId: `create_video_upload_url_audience_syncs_google_video_assets_upload_urls_post` (also callable as `g8.api.call("create_video_upload_url_audience_syncs_google_video_assets_upload_urls_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Step 1 of 2 of a video upload: a presigned PUT for the file itself.
+
+PUT the bytes to the returned URL - straight to storage, not through graph8
+- with exactly `size_bytes` of body and the `content_type` given here; both
+are signed into the URL and a mismatch is refused. Then register the
+returned `key` with `POST /audience-syncs/google/video-assets/uploads`.
+
+503 when upload storage is not configured. Rate limited to 20 per minute
+per org.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `CreateVideoUploadUrlRequest` | yes | Request body; fields below. |
+
+Body fields (`CreateVideoUploadUrlRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.content_type` | `string` | yes | video/mp4 \| video/quicktime \| video/webm max length 100 |
+| `body.size_bytes` | `integer` | yes | Exact file size — signed into the PUT; a different body length is refused > 0 |
+
+**Returns** `ApiResponse_AdPayload_`: the envelope `{ data: AdPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.createVideoUploadUrl({ body: { content_type: "example", size_bytes: 1 } });
+```
+
+---
+
+<a id="op-deleteconnection"></a>
+
+### `g8.api.integrations.deleteConnection(input)`
+
+**Delete Connection**
+
+- HTTP: `DELETE /api/v1/integrations/connections/{connection_id}`
+- operationId: `delete_connection_integrations_connections__connection_id__delete` (also callable as `g8.api.call("delete_connection_integrations_connections__connection_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `integrations:delete`
+
+Disconnect a CRM.
+
+Anything already synced STAYS - this removes the connection, not the
+records that came through it. Any sync configured against this connection
+stops working, so check `/integrations/crm-sync/push-enabled` first if a
+continuous sync is running.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | Connection id. |
+| `query.provider_config_key` | `string` | yes | Provider config key, e.g. `hubspot` or `salesforce`. REQUIRED: the same connection id can exist under more than one provider config, so the key is what identifies which one to remove. |
+
+**Returns** `ApiResponse_ConnectionPayload_`: the envelope `{ data: ConnectionPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.integrations.deleteConnection({
+  path: { connection_id: "id" },
+  query: { provider_config_key: "example" },
+});
+```
+
+---
+
+<a id="op-deletecrmcontact"></a>
+
+### `g8.api.integrations.deleteCrmContact(input)`
+
+**Delete Crm Contact**
+
+- HTTP: `DELETE /api/v1/integrations/crm/connections/{connection_id}/contacts/{contact_id}`
+- operationId: `delete_crm_contact_integrations_crm_connections__connection_id__contacts__contact_id__delete` (also callable as `g8.api.call("delete_crm_contact_integrations_crm_connections__connection_id__contacts__contact_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `integrations:delete`
+
+Delete a contact from the CUSTOMER'S CRM.
+
+Whether this is reversible is the provider's decision, not graph8's -
+HubSpot moves the record to its recycling bin, Salesforce to its recycle
+bin, and both expire. Treat it as permanent.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `path.contact_id` | `string` | yes |  |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.integrations.deleteCrmContact({ path: { connection_id: "id", contact_id: "id" } });
+```
+
+---
+
+<a id="op-discarddraftsyncconfig"></a>
+
+### `g8.api.integrations.discardDraftSyncConfig(input)`
+
+**Discard Draft Sync Config**
+
+- HTTP: `DELETE /api/v1/audience-syncs/{config_id}/draft`
+- operationId: `discard_draft_sync_config_audience_syncs__config_id__draft_delete` (also callable as `g8.api.call("discard_draft_sync_config_audience_syncs__config_id__draft_delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `integrations:delete`
+
+Throw away a sync config that was never launched.
+
+REFUSED with a 409 once any campaign on it has a platform id - at that
+point there is live platform state that discarding would orphan. Use
+`DELETE /audience-syncs/{config_id}` for a config that has launched.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.config_id` | `integer` | yes | The sync config's id. |
+
+**Returns** `ApiResponse_AdPayload_`: the envelope `{ data: AdPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.integrations.discardDraftSyncConfig({ path: { config_id: 123 } });
+```
+
+---
+
+<a id="op-disconnectsugarcrm"></a>
+
+### `g8.api.integrations.disconnectSugarcrm(input?)`
+
+**Disconnect Sugarcrm**
+
+- HTTP: `DELETE /api/v1/integrations/sugarcrm`
+- operationId: `disconnect_sugarcrm_integrations_sugarcrm_delete` (also callable as `g8.api.call("disconnect_sugarcrm_integrations_sugarcrm_delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `integrations:delete`
+
+Disconnect SugarCRM: drop its tokens and remove the connection.
+
+Records already synced into graph8 stay. Sync to and from SugarCRM stops.
+
+**Input**: none.
+
+**Returns** `ApiResponse_IntegrationOpPayload_`: the envelope `{ data: IntegrationOpPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.integrations.disconnectSugarcrm();
+```
+
+---
+
+<a id="op-discovercrmfields"></a>
+
+### `g8.api.integrations.discoverCrmFields(input)`
+
+**Discover Crm Fields**
+
+- HTTP: `GET /api/v1/integrations/crm/fields`
+- operationId: `discover_crm_fields_integrations_crm_fields_get` (also callable as `g8.api.call("discover_crm_fields_integrations_crm_fields_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+The CRM's own fields for one object, including its custom ones.
+
+This is where a valid `custom_fields[].field_name` comes from. The provider
+rejects a name it does not have, so read this before writing one.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.connection_id` | `string` | yes |  |
+| `query.entity_type` | `"contacts" \| "companies" \| "deals" \| "leads" \| "meetings" \| "tasks" \| "activities"` | no | Which CRM object to describe. `meetings`/`tasks` are Salesforce's Event/Task and `activities` is Pipedrive's; other providers fall back to contacts for an object they do not model. default `"contacts"` |
+
+**Returns** `ApiResponse_CrmCollection_`: the envelope `{ data: CrmCollection, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`CrmCollection` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.discoverCrmFields({ query: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-findcrmuserbyemail"></a>
+
+### `g8.api.integrations.findCrmUserByEmail(input)`
+
+**Find Crm User By Email**
+
+- HTTP: `GET /api/v1/integrations/crm/users/by-email`
+- operationId: `find_crm_user_by_email_integrations_crm_users_by_email_get` (also callable as `g8.api.call("find_crm_user_by_email_integrations_crm_users_by_email_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+Resolve one CRM user by email, for setting record ownership.
+
+Returns a LIST, not one user: a CRM can hold more than one user against an
+address, and picking one here would hide that from the caller.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.connection_id` | `string` | yes |  |
+| `query.email` | `string` | yes | The user's address in the CRM. |
+
+**Returns** `ApiResponse_CrmCollection_`: the envelope `{ data: CrmCollection, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`CrmCollection` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.findCrmUserByEmail({ query: { connection_id: "id", email: "jane@acme.com" } });
+```
+
+---
+
+<a id="op-getadanalyticssummary"></a>
+
+### `g8.api.integrations.getAdAnalyticsSummary(input?)`
+
+**Get Ad Analytics Summary**
+
+- HTTP: `GET /api/v1/audience-syncs/analytics/summary`
+- operationId: `get_ad_analytics_summary_audience_syncs_analytics_summary_get` (also callable as `g8.api.call("get_ad_analytics_summary_audience_syncs_analytics_summary_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+Spend, impressions, clicks and conversions across every ad account.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.days` | `integer` | no | Days to look back. default `30` |
+| `query.platform` | `"meta" \| "linkedin" \| "google" \| "x" \| null` | no | One platform. Omit for all. |
+| `query.ad_account_id` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_AdPayload_`: the envelope `{ data: AdPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.getAdAnalyticsSummary();
+```
+
+---
+
+<a id="op-getaddailytrend"></a>
+
+### `g8.api.integrations.getAdDailyTrend(input?)`
+
+**Get Ad Daily Trend**
+
+- HTTP: `GET /api/v1/audience-syncs/analytics/daily-trend`
+- operationId: `get_ad_daily_trend_audience_syncs_analytics_daily_trend_get` (also callable as `g8.api.call("get_ad_daily_trend_audience_syncs_analytics_daily_trend_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+The same numbers, one row per day.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.days` | `integer` | no | Days to look back. default `30` |
+| `query.platform` | `"meta" \| "linkedin" \| "google" \| "x" \| null` | no | One platform. Omit for all. |
+| `query.sync_config_id` | `integer \| null` | no | Scope to one sync config. |
+| `query.ad_account_id` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_AdPayload_`: the envelope `{ data: AdPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.getAdDailyTrend();
+```
+
+---
+
+<a id="op-getcrmcompany"></a>
+
+### `g8.api.integrations.getCrmCompany(input)`
+
+**Get Crm Company**
+
+- HTTP: `GET /api/v1/integrations/crm/connections/{connection_id}/companies/{company_id}`
+- operationId: `get_crm_company_integrations_crm_connections__connection_id__companies__company_id__get` (also callable as `g8.api.call("get_crm_company_integrations_crm_connections__connection_id__companies__company_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+One company, as the CRM holds it.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `path.company_id` | `string` | yes | The CRM's company id, not graph8's. |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.getCrmCompany({ path: { connection_id: "id", company_id: "id" } });
+```
+
+---
+
+<a id="op-getcrmconnection"></a>
+
+### `g8.api.integrations.getCrmConnection(input)`
+
+**Get Crm Connection**
+
+- HTTP: `GET /api/v1/integrations/crm/connections/{connection_id}`
+- operationId: `get_crm_connection_integrations_crm_connections__connection_id__get` (also callable as `g8.api.call("get_crm_connection_integrations_crm_connections__connection_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+What this connection is: which provider, which account, what it can do.
+
+Read this first - the provider decides which of the routes below exist.
+Leads are Salesforce-only; list membership differs per provider.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.getCrmConnection({ path: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-getcrmconnectionmetadata"></a>
+
+### `g8.api.integrations.getCrmConnectionMetadata(input)`
+
+**Get Crm Connection Metadata**
+
+- HTTP: `GET /api/v1/integrations/crm/connections/{connection_id}/metadata`
+- operationId: `get_crm_connection_metadata_integrations_crm_connections__connection_id__metadata_get` (also callable as `g8.api.call("get_crm_connection_metadata_integrations_crm_connections__connection_id__metadata_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+Who connected this integration, and when.
+
+Carries no credential - the token itself is never returned by this or any
+other route on this surface.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `query.crm_type` | `"hubspot" \| "salesforce" \| "pipedrive" \| "sugarcrm" \| "stripe" \| "zoho-crm" \| "freshworks" \| "facebook-ads" \| …` | yes | The provider this connection belongs to. A mismatch is a 404. |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.getCrmConnectionMetadata({ path: { connection_id: "id" }, query: { crm_type: "hubspot" } });
+```
+
+---
+
+<a id="op-getcrmconnectionstatus"></a>
+
+### `g8.api.integrations.getCrmConnectionStatus(input)`
+
+**Get Crm Connection Status**
+
+- HTTP: `GET /api/v1/integrations/crm/connections/{connection_id}/status`
+- operationId: `get_crm_connection_status_integrations_crm_connections__connection_id__status_get` (also callable as `g8.api.call("get_crm_connection_status_integrations_crm_connections__connection_id__status_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+Is this connection working right now.
+
+Distinct from `GET /connections/{id}`: that describes the connection, this
+one actually reaches the provider and reports whether the credentials still
+answer.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.getCrmConnectionStatus({ path: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-getcrmcontact"></a>
+
+### `g8.api.integrations.getCrmContact(input)`
+
+**Get Crm Contact**
+
+- HTTP: `GET /api/v1/integrations/crm/connections/{connection_id}/contacts/{contact_id}`
+- operationId: `get_crm_contact_integrations_crm_connections__connection_id__contacts__contact_id__get` (also callable as `g8.api.call("get_crm_contact_integrations_crm_connections__connection_id__contacts__contact_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+One contact, as the CRM holds it.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `path.contact_id` | `string` | yes | The CRM's contact id, not graph8's. |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.getCrmContact({ path: { connection_id: "id", contact_id: "id" } });
+```
+
+---
+
+<a id="op-getcrmdeal"></a>
+
+### `g8.api.integrations.getCrmDeal(input)`
+
+**Get Crm Deal**
+
+- HTTP: `GET /api/v1/integrations/crm/connections/{connection_id}/deals/{deal_id}`
+- operationId: `get_crm_deal_integrations_crm_connections__connection_id__deals__deal_id__get` (also callable as `g8.api.call("get_crm_deal_integrations_crm_connections__connection_id__deals__deal_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+One deal, as the CRM holds it.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `path.deal_id` | `string` | yes | The CRM's deal id, not graph8's. |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.getCrmDeal({ path: { connection_id: "id", deal_id: "id" } });
+```
+
+---
+
+<a id="op-getcrmlead"></a>
+
+### `g8.api.integrations.getCrmLead(input)`
+
+**Get Crm Lead**
+
+- HTTP: `GET /api/v1/integrations/crm/connections/{connection_id}/leads/{lead_id}`
+- operationId: `get_crm_lead_integrations_crm_connections__connection_id__leads__lead_id__get` (also callable as `g8.api.call("get_crm_lead_integrations_crm_connections__connection_id__leads__lead_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+One lead, as the CRM holds it.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `path.lead_id` | `string` | yes | The CRM's lead id. |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.getCrmLead({ path: { connection_id: "id", lead_id: "id" } });
+```
+
+---
+
+<a id="op-getgoogleconversiontracking"></a>
+
+### `g8.api.integrations.getGoogleConversionTracking(input?)`
+
+**Get Google Conversion Tracking**
+
+- HTTP: `GET /api/v1/audience-syncs/google/conversion-tracking`
+- operationId: `get_google_conversion_tracking_audience_syncs_google_conversion_tracking_get` (also callable as `g8.api.call("get_google_conversion_tracking_audience_syncs_google_conversion_tracking_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+Whether this Google Ads account has any active conversion action.
+
+With none, Smart Bidding has nothing to optimise towards and a Demand Gen
+or Performance Max campaign spends without learning. A live Google read.
+
+An `ad_account_id` the org does not own is a 403, not an empty result.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.ad_account_id` | `string \| null` | no | A Google Ads customer id. Omit to use the org's own. |
+
+**Returns** `ApiResponse_AdPayload_`: the envelope `{ data: AdPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.getGoogleConversionTracking();
+```
+
+---
+
+<a id="op-getlastcompletedmigration"></a>
+
+### `g8.api.integrations.getLastCompletedMigration(input)`
+
+**Get Last Completed Migration**
+
+- HTTP: `GET /api/v1/integrations/connections/{connection_id}/last-migration`
+- operationId: `get_last_completed_migration_integrations_connections__connection_id__last_migration_get` (also callable as `g8.api.call("get_last_completed_migration_integrations_connections__connection_id__last_migration_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+The most recent COMPLETED migration from this connection, or
+`migration: null` if there has never been one.
+
+A later cancelled or failed run does not hide it: once a connection has
+been migrated successfully, a delta sync stays available.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | CRM connection id. |
+
+**Returns** `ApiResponse_IntegrationOpPayload_`: the envelope `{ data: IntegrationOpPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.getLastCompletedMigration({ path: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-getmigrationstatus"></a>
+
+### `g8.api.integrations.getMigrationStatus(input)`
+
+**Get Migration Status**
+
+- HTTP: `GET /api/v1/integrations/migrations/{migration_id}`
+- operationId: `get_migration_status_integrations_migrations__migration_id__get` (also callable as `g8.api.call("get_migration_status_integrations_migrations__migration_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+Where the migration is, and what discovery found.
+
+NOT admin-gated, matching the app: reading progress is not the privileged
+part, starting the import is.
+
+Open-shaped, and deliberately: the payload carries a per-entity progress
+map, the discovered fields, the proposed mappings, the pipelines and a
+WARNINGS list. A dropped warning reads as "nothing went wrong".
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.migration_id` | `string` | yes | Migration id. |
+
+**Returns** `ApiResponse_ConnectionPayload_`: the envelope `{ data: ConnectionPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.getMigrationStatus({ path: { migration_id: "id" } });
+```
+
+---
+
+<a id="op-getorcreatecrmaudience"></a>
+
+### `g8.api.integrations.getOrCreateCrmAudience(input)`
+
+**Get Or Create Crm Audience**
+
+- HTTP: `POST /api/v1/integrations/crm-sync/audiences`
+- operationId: `get_or_create_crm_audience_integrations_crm_sync_audiences_post` (also callable as `g8.api.call("get_or_create_crm_audience_integrations_crm_sync_audiences_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Get, or create, the graph8 audience a CRM import lands in.
+
+IDEMPOTENT BY TITLE. Calling twice with the same `list_name` returns the
+same audience with `created: false` rather than making a second one, which
+is what makes it safe to call before every import. That is the difference
+from `POST /lists`, which always creates - and it is why this exists
+separately rather than being folded into it.
+
+The audience is tagged with the CRM provider and the connection it came
+from, so a later sync can tell CRM-imported rows from graph8-native ones.
+
+200, not 201: most calls return a list that already existed.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `CrmAudienceRequest` | yes | Request body; fields below. |
+
+Body fields (`CrmAudienceRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.connection_id` | `string` | yes | The CRM connection this audience is for. Its provider is recorded on the audience as the source and as a `crm-import` tag, which is what lets a later sync tell CRM-imported rows from graph8-native ones. |
+| `body.list_name` | `string` | yes | Audience title. Matched exactly; reused when it exists. |
+| `body.entity_type` | `string \| null` | no | `contacts`, `companies`, `deals` or `leads`. Singular forms are accepted and pluralised by the app; anything unrecognised falls back to `contacts`. Omit for `contacts`. |
+
+**Returns** `ApiResponse_CrmAudienceResponse_`: the envelope `{ data: CrmAudienceResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`CrmAudienceResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `audience_id` | `integer \| null` | no |  |
+| `created` | `boolean \| null` | no | True only when THIS call created the audience; false when it already existed. |
+| `source` | `string \| null` | no |  |
+| `title` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.getOrCreateCrmAudience({ body: { connection_id: "id", list_name: "Example" } });
+```
+
+---
+
+<a id="op-getorcreatecrmlist"></a>
+
+### `g8.api.integrations.getOrCreateCrmList(input)`
+
+**Get Or Create Crm List**
+
+- HTTP: `POST /api/v1/integrations/crm/lists`
+- operationId: `get_or_create_crm_list_integrations_crm_lists_post` (also callable as `g8.api.call("get_or_create_crm_list_integrations_crm_lists_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Get, or create, a list IN THE CUSTOMER'S CRM, matched by name.
+
+IDEMPOTENT: calling twice with the same name returns the existing list
+rather than making a second one, which is what makes it safe to call before
+every membership change. 200, not 201, because most calls return a list
+that already existed.
+
+The app takes these three as query parameters on a POST; they are a body
+here, because a POST carrying its arguments in the query string is not a
+shape to put in a public contract.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `GetOrCreateCrmListRequest` | yes | Request body; fields below. |
+
+Body fields (`GetOrCreateCrmListRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.connection_id` | `string` | yes |  |
+| `body.name` | `string` | yes | List name. Matched in the CRM; created when absent. |
+| `body.entity_type` | `"contacts" \| "companies" \| "deals" \| "leads" \| null` | no | Which object the list holds. Omit for `contacts`. |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.getOrCreateCrmList({ body: { connection_id: "id", name: "Example" } });
+```
+
+---
+
+<a id="op-getsyncconfiganalytics"></a>
+
+### `g8.api.integrations.getSyncConfigAnalytics(input)`
+
+**Get Sync Config Analytics**
+
+- HTTP: `GET /api/v1/audience-syncs/{config_id}/analytics`
+- operationId: `get_sync_config_analytics_audience_syncs__config_id__analytics_get` (also callable as `g8.api.call("get_sync_config_analytics_audience_syncs__config_id__analytics_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+What the campaigns behind ONE sync config produced.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.config_id` | `integer` | yes | The sync config's id. |
+| `query.days` | `integer` | no | Days to look back. default `30` |
+
+**Returns** `ApiResponse_AdPayload_`: the envelope `{ data: AdPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.getSyncConfigAnalytics({ path: { config_id: 123 } });
+```
+
+---
+
+<a id="op-getsyncjob"></a>
+
+### `g8.api.integrations.getSyncJob(input)`
+
+**Get Sync Job**
+
+- HTTP: `GET /api/v1/integrations/crm-sync/jobs/{job_id}`
+- operationId: `get_sync_job_integrations_crm_sync_jobs__job_id__get` (also callable as `g8.api.call("get_sync_job_integrations_crm_sync_jobs__job_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+How a bulk job is going.
+
+Open-shaped: the payload carries per-provider progress detail that differs
+between CRMs and grows with them, so pinning it would drop whatever a
+provider reported that we had not caught up on.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.job_id` | `string` | yes | Job id returned by a push or pull. |
+
+**Returns** `ApiResponse_SyncJobResponse_`: the envelope `{ data: SyncJobResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SyncJobResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `job_id` | `string \| null` | no |  |
+| `status` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.getSyncJob({ path: { job_id: "id" } });
+```
+
+---
+
+<a id="op-getsyncsegmentstatus"></a>
+
+### `g8.api.integrations.getSyncSegmentStatus(input)`
+
+**Get Sync Segment Status**
+
+- HTTP: `GET /api/v1/audience-syncs/{config_id}/segment-status`
+- operationId: `get_sync_segment_status_audience_syncs__config_id__segment_status_get` (also callable as `g8.api.call("get_sync_segment_status_audience_syncs__config_id__segment_status_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+Whether the platform has finished BUILDING the audience.
+
+A LIVE platform read, unlike `/account-health`. Matched audiences are not
+usable the moment they are uploaded - the platform matches and sizes them
+first, and a campaign pointed at one that is still building serves nothing.
+This is the endpoint that explains that silence.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.config_id` | `integer` | yes | The sync config's id. |
+
+**Returns** `ApiResponse_AdPayload_`: the envelope `{ data: AdPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.getSyncSegmentStatus({ path: { config_id: 123 } });
+```
+
+---
+
+<a id="op-getvideoasset"></a>
+
+### `g8.api.integrations.getVideoAsset(input)`
+
+**Get Video Asset**
+
+- HTTP: `GET /api/v1/audience-syncs/google/video-assets/{asset_id}`
+- operationId: `get_video_asset_audience_syncs_google_video_assets__asset_id__get` (also callable as `g8.api.call("get_video_asset_audience_syncs_google_video_assets__asset_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+One video asset, including how far its upload to YouTube has got.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.asset_id` | `integer` | yes | The video asset's id. |
+
+**Returns** `ApiResponse_AdPayload_`: the envelope `{ data: AdPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.getVideoAsset({ path: { asset_id: 123 } });
+```
+
+---
+
+<a id="op-listadaccounthealth"></a>
+
+### `g8.api.integrations.listAdAccountHealth(input?)`
+
+**List Ad Account Health**
+
+- HTTP: `GET /api/v1/audience-syncs/account-health`
+- operationId: `list_ad_account_health_audience_syncs_account_health_get` (also callable as `g8.api.call("list_ad_account_health_audience_syncs_account_health_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+Whether each connected ad account is still authorised and usable.
+
+Reads the verdict the hourly poller recorded; it deliberately makes NO live
+platform call, so it is cheap enough to poll and can be up to an hour
+stale. This is the endpoint that answers "why did my sync stop working" -
+usually a revoked token or a suspended account.
+
+**Input**: none.
+
+**Returns** `ApiResponse_AdCollection_`: the envelope `{ data: AdCollection, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`AdCollection` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.listAdAccountHealth();
+```
+
+---
+
+<a id="op-listadaccounts"></a>
+
+### `g8.api.integrations.listAdAccounts(input?)`
+
+**List Ad Accounts**
+
+- HTTP: `GET /api/v1/audience-syncs/accounts`
+- operationId: `list_ad_accounts_audience_syncs_accounts_get` (also callable as `g8.api.call("list_ad_accounts_audience_syncs_accounts_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+Ad accounts this org can sync audiences into.
+
+One row per connected account across Google, Meta, LinkedIn and X. The
+`ad_account_id` values here are what a sync config targets.
+
+**Input**: none.
+
+**Returns** `ApiResponse_AdCollection_`: the envelope `{ data: AdCollection, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`AdCollection` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.listAdAccounts();
+```
+
+---
+
+<a id="op-listadplatforms"></a>
+
+### `g8.api.integrations.listAdPlatforms(input?)`
+
+**List Ad Platforms**
+
+- HTTP: `GET /api/v1/audience-syncs/platforms`
+- operationId: `list_ad_platforms_audience_syncs_platforms_get` (also callable as `g8.api.call("list_ad_platforms_audience_syncs_platforms_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+Which ad platforms are connected, and how many syncs each carries.
+
+Reads graph8's own integration rows rather than calling any platform, so a
+platform can read "connected" here and still be unhealthy - check
+`/account-health` for that.
+
+**Input**: none.
+
+**Returns** `ApiResponse_AdCollection_`: the envelope `{ data: AdCollection, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`AdCollection` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.listAdPlatforms();
+```
+
+---
+
+<a id="op-listcompanyactivitiesbygraph8id"></a>
+
+### `g8.api.integrations.listCompanyActivitiesByGraph8Id(input)`
+
+**List Company Activities By Graph8 Id**
+
+- HTTP: `GET /api/v1/integrations/crm/company-activities`
+- operationId: `list_company_activities_by_graph8_id_integrations_crm_company_activities_get` (also callable as `g8.api.call("list_company_activities_by_graph8_id_integrations_crm_company_activities_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+One company's merged timeline, by GRAPH8 company id.
+
+Row visibility follows the key's own company scope.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.company_id` | `integer` | yes | graph8 `mashup_companies.id`. |
+| `query.activity_types` | `string \| null` | no | Comma-separated activity types. |
+| `query.source` | `string \| null` | no | `manual` or `crm`. |
+| `query.limit` | `integer` | no | default `50` |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.listCompanyActivitiesByGraph8Id({ query: { company_id: 123 } });
+```
+
+---
+
+<a id="op-listconnections"></a>
+
+### `g8.api.integrations.listConnections(input?)`
+
+**List Connections**
+
+- HTTP: `GET /api/v1/integrations/connections`
+- operationId: `list_connections_integrations_connections_get` (also callable as `g8.api.call("list_connections_integrations_connections_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+Every CRM connection this org has.
+
+The source of the `connection_id` every operation on
+`/integrations/crm-sync` takes.
+
+**Input**: none.
+
+**Returns** `ApiResponse_ConnectionListPayload_`: the envelope `{ data: ConnectionListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`ConnectionListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.listConnections();
+```
+
+---
+
+<a id="op-listcontactactivitiesbygraph8id"></a>
+
+### `g8.api.integrations.listContactActivitiesByGraph8Id(input)`
+
+**List Contact Activities By Graph8 Id**
+
+- HTTP: `GET /api/v1/integrations/crm/contact-activities`
+- operationId: `list_contact_activities_by_graph8_id_integrations_crm_contact_activities_get` (also callable as `g8.api.call("list_contact_activities_by_graph8_id_integrations_crm_contact_activities_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+One contact's merged timeline, by GRAPH8 contact id.
+
+Row visibility follows the key's own contact scope - the same filter the
+browser applies, resolved from the key rather than from a session.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.contact_id` | `integer` | yes | graph8 `mashup_contacts.id`. |
+| `query.connection_id` | `string \| null` | no | Auto-discovered from the org's connections when omitted. |
+| `query.limit` | `integer` | no | default `50` |
+| `query.activity_types` | `string \| null` | no | Comma-separated: `calls,emails,notes,meetings,tasks`. |
+| `query.source` | `string \| null` | no | `manual`, `crm` (any provider), or a provider name. Omit for everything - which is the point of this route: one timeline whether the activity was logged in graph8 or in the CRM. |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.listContactActivitiesByGraph8Id({ query: { contact_id: 123 } });
+```
+
+---
+
+<a id="op-listcrmactivities"></a>
+
+### `g8.api.integrations.listCrmActivities(input)`
+
+**List Crm Activities**
+
+- HTTP: `GET /api/v1/integrations/crm/activities`
+- operationId: `list_crm_activities_integrations_crm_activities_get` (also callable as `g8.api.call("list_crm_activities_integrations_crm_activities_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+Activities across the whole CRM, unscoped to a record.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.connection_id` | `string` | yes |  |
+| `query.type` | `string \| null` | no | One activity type, e.g. `call`. |
+| `query.limit` | `integer` | no | Records per page. default `100` |
+| `query.offset` | `integer` | no | Records to skip. default `0` |
+
+**Returns** `ApiResponse_CrmCollection_`: the envelope `{ data: CrmCollection, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`CrmCollection` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.listCrmActivities({ query: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-listcrmcompanies"></a>
+
+### `g8.api.integrations.listCrmCompanies(input)`
+
+**List Crm Companies**
+
+- HTTP: `GET /api/v1/integrations/crm/connections/{connection_id}/companies`
+- operationId: `list_crm_companies_integrations_crm_connections__connection_id__companies_get` (also callable as `g8.api.call("list_crm_companies_integrations_crm_connections__connection_id__companies_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+Companies (accounts) in the CRM.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `query.limit` | `integer` | no | Records per page. default `100` |
+| `query.offset` | `integer` | no | Records to skip. default `0` |
+
+**Returns** `ApiResponse_CrmCollection_`: the envelope `{ data: CrmCollection, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`CrmCollection` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.listCrmCompanies({ path: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-listcrmcontactactivities"></a>
+
+### `g8.api.integrations.listCrmContactActivities(input)`
+
+**List Crm Contact Activities**
+
+- HTTP: `GET /api/v1/integrations/crm/connections/{connection_id}/contacts/{contact_id}/activities`
+- operationId: `list_crm_contact_activities_integrations_crm_connections__connection_id__contacts__contact_id__activities_get` (also callable as `g8.api.call("list_crm_contact_activities_integrations_crm_connections__connection_id__contacts__contact_id__activities_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+This contact's timeline, read from the CRM by the CRM's own id.
+
+The sibling `GET /integrations/crm/contact-activities` answers the same
+question by GRAPH8 contact id and merges in activity logged in graph8.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `path.contact_id` | `string` | yes | The CRM's contact id. |
+| `query.limit` | `integer` | no | default `50` |
+| `query.activity_types` | `string \| null` | no | Comma-separated: `calls,emails,notes,meetings,tasks`. |
+
+**Returns** `ApiResponse_CrmCollection_`: the envelope `{ data: CrmCollection, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`CrmCollection` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.listCrmContactActivities({ path: { connection_id: "id", contact_id: "id" } });
+```
+
+---
+
+<a id="op-listcrmcontacts"></a>
+
+### `g8.api.integrations.listCrmContacts(input)`
+
+**List Crm Contacts**
+
+- HTTP: `GET /api/v1/integrations/crm/connections/{connection_id}/contacts`
+- operationId: `list_crm_contacts_integrations_crm_connections__connection_id__contacts_get` (also callable as `g8.api.call("list_crm_contacts_integrations_crm_connections__connection_id__contacts_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+Contacts in the CRM.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `query.limit` | `integer` | no | Records per page. default `100` |
+| `query.offset` | `integer` | no | Records to skip. default `0` |
+| `query.updated_gte` | `string (date-time) \| null` | no | ISO 8601 timestamp. Only contacts modified at or after it - the parameter an incremental reader should page on rather than re-reading the whole CRM. |
+| `query.email` | `string \| null` | no | Exact-match filter. |
+| `query.name` | `string \| null` | no |  |
+| `query.company_id` | `string \| null` | no | The CRM's company id. |
+
+**Returns** `ApiResponse_CrmCollection_`: the envelope `{ data: CrmCollection, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`CrmCollection` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.listCrmContacts({ path: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-listcrmdeals"></a>
+
+### `g8.api.integrations.listCrmDeals(input)`
+
+**List Crm Deals**
+
+- HTTP: `GET /api/v1/integrations/crm/connections/{connection_id}/deals`
+- operationId: `list_crm_deals_integrations_crm_connections__connection_id__deals_get` (also callable as `g8.api.call("list_crm_deals_integrations_crm_connections__connection_id__deals_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+Deals (opportunities) in the CRM.
+
+Not graph8 deals. `GET /deals` is those, and the two have different ids.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `query.limit` | `integer` | no | Records per page. default `100` |
+| `query.offset` | `integer` | no | Records to skip. default `0` |
+
+**Returns** `ApiResponse_CrmCollection_`: the envelope `{ data: CrmCollection, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`CrmCollection` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.listCrmDeals({ path: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-listcrmleads"></a>
+
+### `g8.api.integrations.listCrmLeads(input)`
+
+**List Crm Leads**
+
+- HTTP: `GET /api/v1/integrations/crm/connections/{connection_id}/leads`
+- operationId: `list_crm_leads_integrations_crm_connections__connection_id__leads_get` (also callable as `g8.api.call("list_crm_leads_integrations_crm_connections__connection_id__leads_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+Leads in the CRM. Salesforce only.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `query.limit` | `integer` | no | Records per page. default `100` |
+| `query.offset` | `integer` | no | Records to skip. default `0` |
+
+**Returns** `ApiResponse_CrmCollection_`: the envelope `{ data: CrmCollection, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`CrmCollection` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.listCrmLeads({ path: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-listcrmlists"></a>
+
+### `g8.api.integrations.listCrmLists(input)`
+
+**List Crm Lists**
+
+- HTTP: `GET /api/v1/integrations/crm/lists`
+- operationId: `list_crm_lists_integrations_crm_lists_get` (also callable as `g8.api.call("list_crm_lists_integrations_crm_lists_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+Lists in the CRM.
+
+Published as GET although the app spells it POST: every one of its
+parameters is a QUERY parameter and it reads. A POST that takes no body is
+a read wearing the wrong verb, and publishing it that way would put this
+behind a write grant for no reason.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.connection_id` | `string` | yes |  |
+| `query.query` | `string \| null` | no | Filter by list name. |
+| `query.limit` | `integer` | no | default `50` |
+| `query.offset` | `integer` | no | default `0` |
+| `query.entity_type` | `"contacts" \| "companies" \| "deals" \| "leads"` | no | Which object the list holds. default `"contacts"` |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.listCrmLists({ query: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-listcrmmeetings"></a>
+
+### `g8.api.integrations.listCrmMeetings(input)`
+
+**List Crm Meetings**
+
+- HTTP: `GET /api/v1/integrations/crm/meetings`
+- operationId: `list_crm_meetings_integrations_crm_meetings_get` (also callable as `g8.api.call("list_crm_meetings_integrations_crm_meetings_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+Meetings on the CRM's calendar object.
+
+Not graph8 appointments - `/appointments/*` is those.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.connection_id` | `string` | yes |  |
+| `query.limit` | `integer` | no | Records per page. default `100` |
+| `query.offset` | `integer` | no | Records to skip. default `0` |
+
+**Returns** `ApiResponse_CrmCollection_`: the envelope `{ data: CrmCollection, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`CrmCollection` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.listCrmMeetings({ query: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-listcrmusers"></a>
+
+### `g8.api.integrations.listCrmUsers(input)`
+
+**List Crm Users**
+
+- HTTP: `GET /api/v1/integrations/crm/users`
+- operationId: `list_crm_users_integrations_crm_users_get` (also callable as `g8.api.call("list_crm_users_integrations_crm_users_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+The CRM's own users - the ids that `user_id` on a create or update means.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.connection_id` | `string` | yes | The CRM connection to act through. |
+
+**Returns** `ApiResponse_CrmCollection_`: the envelope `{ data: CrmCollection, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`CrmCollection` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.listCrmUsers({ query: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-listleadstatuses"></a>
+
+### `g8.api.integrations.listLeadStatuses(input)`
+
+**List Lead Statuses**
+
+- HTTP: `GET /api/v1/integrations/crm-sync/leads/statuses`
+- operationId: `list_lead_statuses_integrations_crm_sync_leads_statuses_get` (also callable as `g8.api.call("list_lead_statuses_integrations_crm_sync_leads_statuses_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+The org's Salesforce `Lead.Status` picklist, minus the converted ones.
+
+Read this before setting `status_qualified` / `status_unqualified` on a
+push. `Lead.Status` is an OPEN picklist: Salesforce stores whatever the API
+sends, so a typo does not fail - it creates a new status nobody meant to
+have. Converted statuses are filtered out because setting one through a
+push would silently convert the lead.
+
+Salesforce only. Any other provider is a 400.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.connection_id` | `string` | yes | A Salesforce connection. |
+
+**Returns** `ApiResponse_LeadStatusesResponse_`: the envelope `{ data: LeadStatusesResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`LeadStatusesResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `default` | `string \| null` | no | The status Salesforce marks as the org default, when one exists. |
+| `statuses` | `Array<Record<string, unknown>>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.listLeadStatuses({ query: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-listmappablegraph8fields"></a>
+
+### `g8.api.integrations.listMappableGraph8Fields(input?)`
+
+**List Mappable Graph8 Fields**
+
+- HTTP: `GET /api/v1/integrations/crm/fields/mappable`
+- operationId: `list_mappable_graph8_fields_integrations_crm_fields_mappable_get` (also callable as `g8.api.call("list_mappable_graph8_fields_integrations_crm_fields_mappable_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+The GRAPH8-side fields a CRM field can be mapped onto.
+
+The other half of `GET /integrations/crm/fields`: that one describes the
+customer's CRM, this one describes graph8. A field mapping is a pair drawn
+from the two, so both have to be readable for one to be buildable.
+
+`activities` is accepted here and not by `/fields` - it is a graph8-side
+object that has no single CRM counterpart.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.object_type` | `"contacts" \| "companies" \| "deals" \| "leads" \| "activities"` | no | Which graph8 object. default `"contacts"` |
+
+**Returns** `ApiResponse_CrmCollection_`: the envelope `{ data: CrmCollection, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`CrmCollection` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.listMappableGraph8Fields();
+```
+
+---
+
+<a id="op-listvideoassets"></a>
+
+### `g8.api.integrations.listVideoAssets(input?)`
+
+**List Video Assets**
+
+- HTTP: `GET /api/v1/audience-syncs/google/video-assets`
+- operationId: `list_video_assets_audience_syncs_google_video_assets_get` (also callable as `g8.api.call("list_video_assets_audience_syncs_google_video_assets_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+Videos registered for use in Google Video campaigns.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.source` | `"link" \| "upload" \| "studio" \| null` | no | Omit for every source. |
+
+**Returns** `ApiResponse_AdCollection_`: the envelope `{ data: AdCollection, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`AdCollection` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.listVideoAssets();
+```
+
+---
+
+<a id="op-lookupcrmcontactsbyemail"></a>
+
+### `g8.api.integrations.lookupCrmContactsByEmail(input)`
+
+**Lookup Crm Contacts By Email**
+
+- HTTP: `POST /api/v1/integrations/crm/connections/{connection_id}/batch/contacts/lookup-by-email`
+- operationId: `lookup_crm_contacts_by_email_integrations_crm_connections__connection_id__batch_contacts_lookup_by_email_post` (also callable as `g8.api.call("lookup_crm_contacts_by_email_integrations_crm_connections__connection_id__batch_contacts_lookup_by_email_post", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+Find existing CRM contacts by email address. READS ONLY.
+
+POST because a list of emails is a body, not because it changes anything -
+and it is tiered `read` for that reason, so a key granted "read my CRM" can
+call it. This is the de-duplication check to run BEFORE a create.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `body` | `BatchGetByEmailRequest` | yes | Request body; fields below. |
+
+Body fields (`BatchGetByEmailRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.emails` | `Array<string>` | yes | min items 1 |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.lookupCrmContactsByEmail({ path: { connection_id: "id" }, body: { emails: ["jane@acme.com"] } });
+```
+
+---
+
+<a id="op-modifycrmlistmemberships"></a>
+
+### `g8.api.integrations.modifyCrmListMemberships(input)`
+
+**Modify Crm List Memberships**
+
+- HTTP: `POST /api/v1/integrations/crm/lists/memberships`
+- operationId: `modify_crm_list_memberships_integrations_crm_lists_memberships_post` (also callable as `g8.api.call("modify_crm_list_memberships_integrations_crm_lists_memberships_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Add and remove contacts from ONE CRM list, in a single call.
+
+Both directions are applied in the same request, so this is not two calls
+pretending to be one - and repeating the same body is idempotent on the
+provider side. Membership drives who receives the customer's CRM-side
+marketing, which is why it is admin-gated.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.connection_id` | `string` | yes |  |
+| `body` | `ModifyListMembershipsRequest` | yes | Request body; fields below. |
+
+Body fields (`ModifyListMembershipsRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.list_id` | `string` | yes | The CRM's list id. |
+| `body.add_contact_ids` | `Array<string>` | no |  |
+| `body.remove_contact_ids` | `Array<string>` | no |  |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.modifyCrmListMemberships({ query: { connection_id: "id" }, body: { list_id: "id" } });
+```
+
+---
+
+<a id="op-previewleadpush"></a>
+
+### `g8.api.integrations.previewLeadPush(input)`
+
+**Preview Lead Push**
+
+- HTTP: `GET /api/v1/integrations/crm-sync/leads/push-preview`
+- operationId: `preview_lead_push_integrations_crm_sync_leads_push_preview_get` (also callable as `g8.api.call("preview_lead_push_integrations_crm_sync_leads_push_preview_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+What a lead push would do, computed NOW and returned inline.
+
+Nothing is written to the CRM. The asynchronous twin,
+`POST /integrations/crm-sync/leads/previews`, queues the same work and
+returns a job id instead - use that one for a population large enough that
+the inline version would time out.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.connection_id` | `string` | yes | A Salesforce connection. |
+| `query.source_mode` | `"all_qualified" \| "saved_segment" \| "segments_union" \| "all_contacts"` | no | Which population to preview. `saved_segment` requires `audience_id`; `segments_union` requires `audience_ids`. default `"all_qualified"` |
+| `query.audience_id` | `integer \| null` | no | Required for `saved_segment`. |
+| `query.audience_ids` | `Array<integer> \| null` | no | Required for `segments_union`. |
+| `query.limit` | `integer` | no | Ceiling on rows inspected. default `10000` |
+| `query.status_qualified` | `string \| null` | no |  |
+| `query.status_unqualified` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_LeadPreviewResponse_`: the envelope `{ data: LeadPreviewResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.previewLeadPush({ query: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-pullallcontacts"></a>
+
+### `g8.api.integrations.pullAllContacts(input)`
+
+**Pull All Contacts**
+
+- HTTP: `POST /api/v1/integrations/crm-sync/contacts/pull`
+- operationId: `pull_all_contacts_integrations_crm_sync_contacts_pull_post` (also callable as `g8.api.call("pull_all_contacts_integrations_crm_sync_contacts_pull_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Pull every CRM contact into graph8.
+
+`enrich_from_graph8` SPENDS ENRICHMENT CREDIT when on. Omit it to take the
+app's default rather than turning a spend on by accident.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `PullAllContactsRequest` | yes | Request body; fields below. |
+
+Body fields (`PullAllContactsRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.connection_id` | `string` | yes | Which CRM connection to run against. |
+| `body.chunk_size` | `integer \| null` | no | Records per batch. min 1 |
+| `body.enrich_from_graph8` | `boolean \| null` | no | Fill missing fields from the graph8 index as rows arrive. Omit to take the app's default - this SPENDS enrichment credit when on. |
+| `body.entity_type` | `string \| null` | no | default `"contacts"` |
+| `body.limit` | `integer \| null` | no | Ceiling on records processed. OMIT to take the app's own default (5,000 pulling, 10,000 pushing) rather than freezing a copy of it here. min 1 |
+| `body.list_id` | `integer \| null` | no | graph8 audience list to land in. |
+| `body.max_parallel` | `integer \| null` | no | Concurrent batches. min 1 |
+
+**Returns** `ApiResponse_SyncJobResponse_`: the envelope `{ data: SyncJobResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SyncJobResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `job_id` | `string \| null` | no |  |
+| `status` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.pullAllContacts({ body: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-pullalldeals"></a>
+
+### `g8.api.integrations.pullAllDeals(input)`
+
+**Pull All Deals**
+
+- HTTP: `POST /api/v1/integrations/crm-sync/deals/pull`
+- operationId: `pull_all_deals_integrations_crm_sync_deals_pull_post` (also callable as `g8.api.call("pull_all_deals_integrations_crm_sync_deals_pull_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Pull CRM opportunities into graph8 as deals.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `PullAllDealsRequest` | yes | Request body; fields below. |
+
+Body fields (`PullAllDealsRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.connection_id` | `string` | yes |  |
+| `body.chunk_size` | `integer \| null` | no | min 1 |
+| `body.crm_list_id` | `string \| null` | no |  |
+| `body.crm_list_title` | `string \| null` | no |  |
+| `body.limit` | `integer \| null` | no | min 1 |
+| `body.list_id` | `integer \| null` | no |  |
+
+**Returns** `ApiResponse_SyncJobResponse_`: the envelope `{ data: SyncJobResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SyncJobResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `job_id` | `string \| null` | no |  |
+| `status` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.pullAllDeals({ body: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-pullallleads"></a>
+
+### `g8.api.integrations.pullAllLeads(input)`
+
+**Pull All Leads**
+
+- HTTP: `POST /api/v1/integrations/crm-sync/leads/pull`
+- operationId: `pull_all_leads_integrations_crm_sync_leads_pull_post` (also callable as `g8.api.call("pull_all_leads_integrations_crm_sync_leads_pull_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Pull Salesforce Leads into graph8.
+
+A body carrying only `connection_id` runs the org's SAVED `pull.leads`
+settings rather than pulling everything. Any other field overrides those
+settings for this run only.
+
+`enrich_from_graph8` SPENDS ENRICHMENT CREDIT when on. Omit it to take the
+app's default rather than turning a spend on by accident.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `PullAllLeadsRequest` | yes | Request body; fields below. |
+
+Body fields (`PullAllLeadsRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.connection_id` | `string` | yes | Which CRM connection to pull from. |
+| `body.campaign_ids` | `Array<string> \| null` | no | Salesforce Campaign ids to pull members of. |
+| `body.chunk_size` | `integer \| null` | no | Records per batch. min 1 |
+| `body.enrich_from_graph8` | `boolean \| null` | no | Fill missing fields from the graph8 index as rows arrive. This SPENDS ENRICHMENT CREDIT when on. Omit to take the app's default rather than turning a spend on by accident. |
+| `body.include_converted` | `boolean \| null` | no | Include leads Salesforce has already converted to a Contact. |
+| `body.limit` | `integer \| null` | no | Ceiling on records pulled. min 1 |
+| `body.list_id` | `integer \| null` | no | graph8 audience to land the leads in. |
+| `body.max_parallel` | `integer \| null` | no | Concurrent batches. min 1 |
+| `body.source_mode` | `"all_leads" \| "campaigns" \| null` | no | `campaigns` restricts the pull to `campaign_ids`. Omit for the saved setting. |
+| `body.suppress_from_optouts` | `boolean \| null` | no | Skip leads that appear on an opt-out list. |
+
+**Returns** `ApiResponse_SyncJobResponse_`: the envelope `{ data: SyncJobResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SyncJobResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `job_id` | `string \| null` | no |  |
+| `status` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.pullAllLeads({ body: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-pullcrmlist"></a>
+
+### `g8.api.integrations.pullCrmList(input)`
+
+**Pull Crm List**
+
+- HTTP: `POST /api/v1/integrations/crm-sync/pull`
+- operationId: `pull_crm_list_integrations_crm_sync_pull_post` (also callable as `g8.api.call("pull_crm_list_integrations_crm_sync_pull_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Pull ONE CRM list rather than everything.
+
+`crm_list_id` is REQUIRED - without it there is no list to pull, and
+defaulting to "everything" is the opposite of what a narrow endpoint is
+for.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `PullCrmListRequest` | yes | Request body; fields below. |
+
+Body fields (`PullCrmListRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.connection_id` | `string` | yes |  |
+| `body.crm_list_id` | `string` | yes | REQUIRED - the CRM list to pull. |
+| `body.auto_create_audience` | `boolean \| null` | no | Create a matching graph8 audience if none is given. |
+| `body.enrich_from_graph8` | `boolean \| null` | no | SPENDS enrichment credit when on. |
+| `body.entity_type` | `string \| null` | no |  |
+| `body.graph8_list_id` | `integer \| null` | no |  |
+| `body.limit` | `integer \| null` | no | min 1 |
+| `body.reconcile` | `boolean \| null` | no |  |
+
+**Returns** `ApiResponse_SyncJobResponse_`: the envelope `{ data: SyncJobResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SyncJobResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `job_id` | `string \| null` | no |  |
+| `status` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.pullCrmList({ body: { connection_id: "id", crm_list_id: "id" } });
+```
+
+---
+
+<a id="op-pushallcontacts"></a>
+
+### `g8.api.integrations.pushAllContacts(input)`
+
+**Push All Contacts**
+
+- HTTP: `POST /api/v1/integrations/crm-sync/contacts/push`
+- operationId: `push_all_contacts_integrations_crm_sync_contacts_push_post` (also callable as `g8.api.call("push_all_contacts_integrations_crm_sync_contacts_push_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Push every graph8 contact into the CRM. THIS WRITES TO THEIR SYSTEM.
+
+Returns a job - the work happens in the background. Poll `/jobs/{job_id}`.
+Omit `limit` to take the app's default (10,000) rather than a number frozen
+into this contract.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `PushAllContactsRequest` | yes | Request body; fields below. |
+
+Body fields (`PushAllContactsRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.connection_id` | `string` | yes | Which CRM connection to run against. |
+| `body.chunk_size` | `integer \| null` | no | Records per batch. min 1 |
+| `body.crm_list_id` | `string \| null` | no | Target list in the CRM. |
+| `body.entity_type` | `string \| null` | no | default `"contacts"` |
+| `body.file_import_threshold` | `integer \| null` | no |  |
+| `body.limit` | `integer \| null` | no | Ceiling on records processed. OMIT to take the app's own default (5,000 pulling, 10,000 pushing) rather than freezing a copy of it here. min 1 |
+| `body.max_parallel` | `integer \| null` | no | Concurrent batches. min 1 |
+| `body.sync_list_mode` | `string \| null` | no |  |
+| `body.use_file_import` | `boolean \| null` | no | Use the provider's bulk file import instead of the API. |
+
+**Returns** `ApiResponse_SyncJobResponse_`: the envelope `{ data: SyncJobResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SyncJobResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `job_id` | `string \| null` | no |  |
+| `status` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.pushAllContacts({ body: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-pushalldeals"></a>
+
+### `g8.api.integrations.pushAllDeals(input)`
+
+**Push All Deals**
+
+- HTTP: `POST /api/v1/integrations/crm-sync/deals/push`
+- operationId: `push_all_deals_integrations_crm_sync_deals_push_post` (also callable as `g8.api.call("push_all_deals_integrations_crm_sync_deals_push_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Push graph8 deals into the CRM as opportunities.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `PushAllDealsRequest` | yes | Request body; fields below. |
+
+Body fields (`PushAllDealsRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.connection_id` | `string` | yes |  |
+| `body.chunk_size` | `integer \| null` | no | min 1 |
+| `body.crm_list_id` | `string \| null` | no |  |
+| `body.limit` | `integer \| null` | no | min 1 |
+| `body.list_id` | `integer \| null` | no |  |
+| `body.sync_list_mode` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_SyncJobResponse_`: the envelope `{ data: SyncJobResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SyncJobResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `job_id` | `string \| null` | no |  |
+| `status` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.pushAllDeals({ body: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-pushallleads"></a>
+
+### `g8.api.integrations.pushAllLeads(input)`
+
+**Push All Leads**
+
+- HTTP: `POST /api/v1/integrations/crm-sync/leads/push`
+- operationId: `push_all_leads_integrations_crm_sync_leads_push_post` (also callable as `g8.api.call("push_all_leads_integrations_crm_sync_leads_push_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Push graph8 people into Salesforce as Leads. THIS WRITES TO THEIR SYSTEM.
+
+Returns a job - the work happens in the background. Poll
+`GET /integrations/crm-sync/jobs/{job_id}`.
+
+Over the app's population threshold the JOB is refused unless
+`large_population_confirmed` is true - the request itself is still a 202,
+and the refusal is what the job's status reports. Run
+`POST /integrations/crm-sync/leads/previews` first to learn the count you
+would be acknowledging.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `PushAllLeadsRequest` | yes | Request body; fields below. |
+
+Body fields (`PushAllLeadsRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.connection_id` | `string` | yes | Which CRM connection to push into. |
+| `body.audience_id` | `integer \| null` | no | graph8 audience for `saved_segment`. |
+| `body.audience_ids` | `Array<integer> \| null` | no | graph8 audiences for `segments_union`. |
+| `body.auto_assign_on_create` | `boolean \| null` | no | Run Salesforce's assignment rules on each created lead. |
+| `body.chunk_size` | `integer \| null` | no | Records per batch. min 1 |
+| `body.crm_list_id` | `string \| null` | no | Target list in the CRM. |
+| `body.file_import_threshold` | `integer \| null` | no | Record count above which the file import is used. min 1 |
+| `body.large_population_confirmed` | `boolean \| null` | no | Acknowledge that this job covers a population large enough that the app asks first. Leave unset to keep that refusal in place; set true ONLY when you have read the preview's record count and accept it. This is a safety interlock, not a tuning option - the records land in the customer's Salesforce and cannot be un-pushed. |
+| `body.lead_id` | `integer \| null` | no | Push a single graph8 lead row. |
+| `body.limit` | `integer \| null` | no | Ceiling on records pushed. Omit for the app's default. min 1 |
+| `body.max_parallel` | `integer \| null` | no | Concurrent batches. min 1 |
+| `body.salesforce_campaign_id` | `string \| null` | no | Add every pushed lead to this Salesforce Campaign as a CampaignMember. |
+| `body.source_mode` | `"all_qualified" \| "saved_segment" \| "segments_union" \| "all_contacts" \| null` | no | Which population to push. `saved_segment` REQUIRES `audience_id`; `segments_union` REQUIRES `audience_ids`. Omit for the app's default (`all_qualified`). |
+| `body.status_qualified` | `string \| null` | no | Salesforce `Lead.Status` API name to set on qualified leads. Read the valid values from `/integrations/crm-sync/leads/statuses` - Lead.Status is an OPEN picklist, so Salesforce stores whatever is sent and an invented value silently becomes a real status. |
+| `body.status_unqualified` | `string \| null` | no | Salesforce `Lead.Status` API name for unqualified leads. |
+| `body.sync_list_mode` | `"no_list" \| "new_list" \| "existing_list" \| null` | no | `no_list` (the app's default), `new_list` or `existing_list`. Sending `crm_list_id` with no mode implies `existing_list`. |
+| `body.use_file_import` | `boolean \| null` | no | Use the provider's bulk file import instead of the API. |
+
+**Returns** `ApiResponse_SyncJobResponse_`: the envelope `{ data: SyncJobResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SyncJobResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `job_id` | `string \| null` | no |  |
+| `status` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.pushAllLeads({ body: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-pushaudience"></a>
+
+### `g8.api.integrations.pushAudience(input)`
+
+**Push Audience**
+
+- HTTP: `POST /api/v1/integrations/crm-sync/push`
+- operationId: `push_audience_integrations_crm_sync_push_post` (also callable as `g8.api.call("push_audience_integrations_crm_sync_push_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Push ONE audience rather than everything.
+
+The narrow version of `/contacts/push`, and the one to reach for first: it
+bounds what lands in the customer's CRM to a list they chose.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `PushAudienceRequest` | yes | Request body; fields below. |
+
+Body fields (`PushAudienceRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.connection_id` | `string` | yes | Which CRM connection to run against. |
+| `body.audience_id` | `integer \| null` | no | graph8 audience to push. |
+| `body.chunk_size` | `integer \| null` | no | Records per batch. min 1 |
+| `body.crm_list_id` | `string \| null` | no |  |
+| `body.entity_type` | `string \| null` | no |  |
+| `body.file_import_threshold` | `integer \| null` | no |  |
+| `body.limit` | `integer \| null` | no | Ceiling on records processed. OMIT to take the app's own default (5,000 pulling, 10,000 pushing) rather than freezing a copy of it here. min 1 |
+| `body.max_parallel` | `integer \| null` | no | Concurrent batches. min 1 |
+| `body.reconcile` | `boolean \| null` | no | Reconcile against what is already in the CRM first. |
+| `body.use_file_import` | `boolean \| null` | no |  |
+
+**Returns** `ApiResponse_SyncJobResponse_`: the envelope `{ data: SyncJobResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SyncJobResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `job_id` | `string \| null` | no |  |
+| `status` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.pushAudience({ body: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-reconnectsugarcrm"></a>
+
+### `g8.api.integrations.reconnectSugarcrm(input)`
+
+**Reconnect Sugarcrm**
+
+- HTTP: `POST /api/v1/integrations/sugarcrm/reconnect`
+- operationId: `reconnect_sugarcrm_integrations_sugarcrm_reconnect_post` (also callable as `g8.api.call("reconnect_sugarcrm_integrations_sugarcrm_reconnect_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Replace the stored SugarCRM credentials (or connect, if none exist).
+
+Authenticates with the NEW credentials before saving them, so a typo
+leaves the working connection in place.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `SugarCrmConnectRequest` | yes | Request body; fields below. |
+
+Body fields (`SugarCrmConnectRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.instance_url` | `string` | yes | Your SugarCRM instance, e.g. https://acme.sugarondemand.com. |
+| `body.password` | `string` | yes |  |
+| `body.username` | `string` | yes |  |
+| `body.client_id` | `string` | no | OAuth client id configured in SugarCRM. default `"sugar"` |
+| `body.client_secret` | `string` | no | OAuth client secret, if your client id has one. default `""` |
+
+**Returns** `ApiResponse_IntegrationOpPayload_`: the envelope `{ data: IntegrationOpPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.reconnectSugarcrm({
+  body: {
+    instance_url: "https://example.com",
+    password: "example",
+    username: "Example",
+  },
+});
+```
+
+---
+
+<a id="op-registeruploadedvideoasset"></a>
+
+### `g8.api.integrations.registerUploadedVideoAsset(input)`
+
+**Register Uploaded Video Asset**
+
+- HTTP: `POST /api/v1/audience-syncs/google/video-assets/uploads`
+- operationId: `register_uploaded_video_asset_audience_syncs_google_video_assets_uploads_post` (also callable as `g8.api.call("register_uploaded_video_asset_audience_syncs_google_video_assets_uploads_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Step 2 of 2: register the uploaded file for the YouTube upload worker.
+
+The object is re-checked server-side (size and type) before it is queued.
+202: YouTube processing happens afterwards - poll
+`GET /audience-syncs/google/video-assets/{asset_id}` until it is usable.
+Rate limited to 30 per minute per org.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `RegisterVideoAssetRequest` | yes | Request body; fields below. |
+
+Body fields (`RegisterVideoAssetRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.key` | `string` | yes | min length 1, max length 512 |
+| `body.duration_s` | `integer \| null` | no | min 0 |
+| `body.height` | `integer \| null` | no | min 0 |
+| `body.source` | `string` | no | upload \| studio default `"upload"` |
+| `body.title` | `string \| null` | no | default `""`, max length 255 |
+| `body.width` | `integer \| null` | no | min 0 |
+
+**Returns** `ApiResponse_AdPayload_`: the envelope `{ data: AdPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.registerUploadedVideoAsset({ body: { key: "example" } });
+```
+
+---
+
+<a id="op-registervideoassetfromlibrary"></a>
+
+### `g8.api.integrations.registerVideoAssetFromLibrary(input)`
+
+**Register Video Asset From Library**
+
+- HTTP: `POST /api/v1/audience-syncs/google/video-assets/library`
+- operationId: `register_video_asset_from_library_audience_syncs_google_video_assets_library_post` (also callable as `g8.api.call("register_video_asset_from_library_audience_syncs_google_video_assets_library_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Queue a Studio library video for upload to YouTube.
+
+202: the upload to YouTube happens in a worker afterwards, so the asset is
+not usable in a campaign the moment this returns. Poll
+`GET /audience-syncs/google/video-assets/{asset_id}`.
+
+Rate limited to 30 per minute per org by the app's own limiter.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `RegisterLibraryVideoAssetRequest` | yes | Request body; fields below. |
+
+Body fields (`RegisterLibraryVideoAssetRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.org_video_id` | `string` | yes | min length 1, max length 64 |
+
+**Returns** `ApiResponse_AdPayload_`: the envelope `{ data: AdPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.registerVideoAssetFromLibrary({ body: { org_video_id: "id" } });
+```
+
+---
+
+<a id="op-registervideoassetfromlink"></a>
+
+### `g8.api.integrations.registerVideoAssetFromLink(input)`
+
+**Register Video Asset From Link**
+
+- HTTP: `POST /api/v1/audience-syncs/google/video-assets/links`
+- operationId: `register_video_asset_from_link_audience_syncs_google_video_assets_links_post` (also callable as `g8.api.call("register_video_asset_from_link_audience_syncs_google_video_assets_links_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Register a YouTube video by URL.
+
+The URL is validated against YouTube, so a private or deleted video is
+refused here rather than at launch. Rate limited to 20 per minute per org
+by the app's own limiter, per org - over it, a 429.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `CreateVideoAssetFromLinkRequest` | yes | Request body; fields below. |
+
+Body fields (`CreateVideoAssetFromLinkRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.url` | `string` | yes | min length 1, max length 2000 |
+
+**Returns** `ApiResponse_AdPayload_`: the envelope `{ data: AdPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.registerVideoAssetFromLink({ body: { url: "https://example.com" } });
+```
+
+---
+
+<a id="op-saveconnection"></a>
+
+### `g8.api.integrations.saveConnection(input)`
+
+**Save Connection**
+
+- HTTP: `POST /api/v1/integrations/connections`
+- operationId: `save_connection_integrations_connections_post` (also callable as `g8.api.call("save_connection_integrations_connections_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Record a connection the OAuth flow has already established.
+
+This does NOT perform the handshake - the hosted flow does, and this stores
+its result. `connection_id` is the id that flow returned, not one you
+choose.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `SaveConnectionRequest` | yes | Request body; fields below. |
+
+Body fields (`SaveConnectionRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.connection_id` | `string` | yes | The id the OAuth flow returned. |
+| `body.provider` | `string` | yes | Stable graph8 provider name. |
+| `body.provider_config_key` | `string` | yes | Provider config key. |
+| `body.connection_config` | `Record<string, string>` | no | Provider-specific configuration captured during the flow. |
+
+**Returns** `ApiResponse_ConnectionPayload_`: the envelope `{ data: ConnectionPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.saveConnection({
+  body: {
+    connection_id: "id",
+    provider: "example",
+    provider_config_key: "example",
+  },
+});
+```
+
+---
+
+<a id="op-setpullsyncenabled"></a>
+
+### `g8.api.integrations.setPullSyncEnabled(input)`
+
+**Set Pull Sync Enabled**
+
+- HTTP: `PUT /api/v1/integrations/crm-sync/pull-enabled`
+- operationId: `set_pull_sync_enabled_integrations_crm_sync_pull_enabled_put` (also callable as `g8.api.call("set_pull_sync_enabled_integrations_crm_sync_pull_enabled_put", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Turn continuous PULL on or off for a connection.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `SyncEnabledRequest` | yes | Request body; fields below. |
+
+Body fields (`SyncEnabledRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.connection_id` | `string` | yes | Which CRM connection. |
+| `body.enabled` | `boolean` | yes | Explicit, not a toggle - a retried request is then idempotent. |
+
+**Returns** `ApiResponse_SyncJobResponse_`: the envelope `{ data: SyncJobResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SyncJobResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `job_id` | `string \| null` | no |  |
+| `status` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.setPullSyncEnabled({ body: { connection_id: "id", enabled: true } });
+```
+
+---
+
+<a id="op-setpushsyncenabled"></a>
+
+### `g8.api.integrations.setPushSyncEnabled(input)`
+
+**Set Push Sync Enabled**
+
+- HTTP: `PUT /api/v1/integrations/crm-sync/push-enabled`
+- operationId: `set_push_sync_enabled_integrations_crm_sync_push_enabled_put` (also callable as `g8.api.call("set_push_sync_enabled_integrations_crm_sync_push_enabled_put", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Turn continuous PUSH on or off for a connection.
+
+`enabled` is explicit rather than a toggle, so a retried request is
+idempotent instead of flipping the state back.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `SyncEnabledRequest` | yes | Request body; fields below. |
+
+Body fields (`SyncEnabledRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.connection_id` | `string` | yes | Which CRM connection. |
+| `body.enabled` | `boolean` | yes | Explicit, not a toggle - a retried request is then idempotent. |
+
+**Returns** `ApiResponse_SyncJobResponse_`: the envelope `{ data: SyncJobResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SyncJobResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `job_id` | `string \| null` | no |  |
+| `status` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.setPushSyncEnabled({ body: { connection_id: "id", enabled: true } });
+```
+
+---
+
+<a id="op-startdeltasync"></a>
+
+### `g8.api.integrations.startDeltaSync(input)`
+
+**Start Delta Sync**
+
+- HTTP: `POST /api/v1/integrations/migrations/delta-sync`
+- operationId: `start_delta_sync_integrations_migrations_delta_sync_post` (also callable as `g8.api.call("start_delta_sync_integrations_migrations_delta_sync_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Import only what changed since a watermark.
+
+OMIT `since` unless you have a reason: the app picks the last successful
+watermark, which is both what you usually want and safer than guessing.
+The response echoes back the watermark actually used, so read it rather
+than assuming yours was accepted.
+
+Org admin, matching the app.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `DeltaSyncRequest` | yes | Request body; fields below. |
+
+Body fields (`DeltaSyncRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.connection_id` | `string` | yes |  |
+| `body.entity_types` | `Array<string> \| null` | no | Limit to these entity types. Omit for all. |
+| `body.recover_missing` | `boolean` | no | Also re-fetch records the previous run should have imported and did not. Slower, and the reason to use it is a suspected gap rather than routine. default `false` |
+| `body.since` | `string \| null` | no | ISO 8601 timestamp. Omit and the app picks the last successful watermark - which is usually what you want, and always safer than guessing one. |
+
+**Returns** `ApiResponse_ConnectionPayload_`: the envelope `{ data: ConnectionPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.startDeltaSync({ body: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-startleadpreview"></a>
+
+### `g8.api.integrations.startLeadPreview(input)`
+
+**Start Lead Preview**
+
+- HTTP: `POST /api/v1/integrations/crm-sync/leads/previews`
+- operationId: `start_lead_preview_integrations_crm_sync_leads_previews_post` (also callable as `g8.api.call("start_lead_preview_integrations_crm_sync_leads_previews_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Queue a readiness preview and return a job id immediately.
+
+Nothing is written to the CRM. Poll
+`GET /integrations/crm-sync/jobs/{job_id}` for the result, which carries
+the record count `large_population_confirmed` exists to acknowledge.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `LeadPreviewRequest` | yes | Request body; fields below. |
+
+Body fields (`LeadPreviewRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.connection_id` | `string` | yes | Which CRM connection to preview against. |
+| `body.audience_id` | `integer \| null` | no |  |
+| `body.audience_ids` | `Array<integer> \| null` | no |  |
+| `body.large_population_confirmed` | `boolean \| null` | no | Acknowledge that this job covers a population large enough that the app asks first. Leave unset to keep that refusal in place; set true ONLY when you have read the preview's record count and accept it. This is a safety interlock, not a tuning option - the records land in the customer's Salesforce and cannot be un-pushed. |
+| `body.page_size` | `integer \| null` | no | Rows scanned per page while previewing. Omit for the app's default. min 100, max 10000 |
+| `body.source_mode` | `"all_qualified" \| "saved_segment" \| "segments_union" \| "all_contacts" \| null` | no | Which population to preview. `saved_segment` REQUIRES `audience_id`; `segments_union` REQUIRES `audience_ids`. |
+| `body.status_qualified` | `string \| null` | no |  |
+| `body.status_unqualified` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_SyncJobResponse_`: the envelope `{ data: SyncJobResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SyncJobResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `job_id` | `string \| null` | no |  |
+| `status` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.startLeadPreview({ body: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-startmigrationdiscovery"></a>
+
+### `g8.api.integrations.startMigrationDiscovery(input)`
+
+**Start Migration Discovery**
+
+- HTTP: `POST /api/v1/integrations/migrations/discovery`
+- operationId: `start_migration_discovery_integrations_migrations_discovery_post` (also callable as `g8.api.call("start_migration_discovery_integrations_migrations_discovery_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Look at what is in the CRM. WRITES NOTHING to graph8.
+
+Counts records, reads the field and pipeline shape, and proposes mappings.
+Poll `GET /integrations/migrations/{migration_id}` for the result, then
+accept it with `/confirm`.
+
+Org admin, matching the app.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `StartDiscoveryRequest` | yes | Request body; fields below. |
+
+Body fields (`StartDiscoveryRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.connection_id` | `string` | yes |  |
+| `body.crm_type` | `string` | no | Which CRM. The app's default is `hubspot`. default `"hubspot"` |
+
+**Returns** `ApiResponse_ConnectionPayload_`: the envelope `{ data: ConnectionPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.startMigrationDiscovery({ body: { connection_id: "id" } });
+```
+
+---
+
+<a id="op-updatecrmcompany"></a>
+
+### `g8.api.integrations.updateCrmCompany(input)`
+
+**Update Crm Company**
+
+- HTTP: `PUT /api/v1/integrations/crm/connections/{connection_id}/companies/{company_id}`
+- operationId: `update_crm_company_integrations_crm_connections__connection_id__companies__company_id__put` (also callable as `g8.api.call("update_crm_company_integrations_crm_connections__connection_id__companies__company_id__put", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Partially update a CRM company. Omitted fields are left alone.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `path.company_id` | `string` | yes |  |
+| `body` | `CrmCompanyUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`CrmCompanyUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.address` | `CrmAddress \| null` | no |  |
+| `body.annual_revenue` | `number \| null` | no |  |
+| `body.custom_fields` | `Array<CrmCustomField> \| null` | no |  |
+| `body.domain` | `string \| null` | no |  |
+| `body.employee_count` | `integer \| null` | no |  |
+| `body.industry` | `string \| null` | no |  |
+| `body.name` | `string \| null` | no |  |
+| `body.phone` | `string \| null` | no |  |
+| `body.website` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.updateCrmCompany({ path: { connection_id: "id", company_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-updatecrmcontact"></a>
+
+### `g8.api.integrations.updateCrmContact(input)`
+
+**Update Crm Contact**
+
+- HTTP: `PUT /api/v1/integrations/crm/connections/{connection_id}/contacts/{contact_id}`
+- operationId: `update_crm_contact_integrations_crm_connections__connection_id__contacts__contact_id__put` (also callable as `g8.api.call("update_crm_contact_integrations_crm_connections__connection_id__contacts__contact_id__put", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Partially update a CRM contact. Omitted fields are left alone.
+
+Sending `emails: []` REPLACES the addresses with none; omitting `emails`
+leaves them. The difference is the reason this is not a PATCH-shaped
+merge - the app's model distinguishes "absent" from "empty" and so does
+this one.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `path.contact_id` | `string` | yes |  |
+| `body` | `CrmContactUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`CrmContactUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.address` | `CrmAddress \| null` | no |  |
+| `body.company_id` | `string \| null` | no |  |
+| `body.company_name` | `string \| null` | no |  |
+| `body.custom_fields` | `Array<CrmCustomField> \| null` | no |  |
+| `body.emails` | `Array<CrmEmail> \| null` | no |  |
+| `body.first_name` | `string \| null` | no |  |
+| `body.is_active` | `boolean \| null` | no |  |
+| `body.last_name` | `string \| null` | no |  |
+| `body.name` | `string \| null` | no |  |
+| `body.phones` | `Array<CrmPhone> \| null` | no |  |
+| `body.tags` | `Array<string> \| null` | no |  |
+| `body.title` | `string \| null` | no |  |
+| `body.user_id` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.updateCrmContact({ path: { connection_id: "id", contact_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-updatecrmdeal"></a>
+
+### `g8.api.integrations.updateCrmDeal(input)`
+
+**Update Crm Deal**
+
+- HTTP: `PUT /api/v1/integrations/crm/connections/{connection_id}/deals/{deal_id}`
+- operationId: `update_crm_deal_integrations_crm_connections__connection_id__deals__deal_id__put` (also callable as `g8.api.call("update_crm_deal_integrations_crm_connections__connection_id__deals__deal_id__put", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Partially update a CRM deal. Omitted fields are left alone.
+
+Moving `stage` is what closes a deal in most CRMs, and it can fire that
+provider's own workflows and notifications.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `path.deal_id` | `string` | yes |  |
+| `body` | `CrmDealUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`CrmDealUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.amount` | `number \| null` | no |  |
+| `body.close_date` | `string \| null` | no |  |
+| `body.company_id` | `string \| null` | no |  |
+| `body.contact_id` | `string \| null` | no |  |
+| `body.custom_fields` | `Array<CrmCustomField> \| null` | no |  |
+| `body.description` | `string \| null` | no |  |
+| `body.name` | `string \| null` | no |  |
+| `body.probability` | `number \| null` | no |  |
+| `body.stage` | `string \| null` | no |  |
+| `body.type` | `string \| null` | no |  |
+| `body.user_id` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.updateCrmDeal({ path: { connection_id: "id", deal_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-updatecrmlead"></a>
+
+### `g8.api.integrations.updateCrmLead(input)`
+
+**Update Crm Lead**
+
+- HTTP: `PUT /api/v1/integrations/crm/connections/{connection_id}/leads/{lead_id}`
+- operationId: `update_crm_lead_integrations_crm_connections__connection_id__leads__lead_id__put` (also callable as `g8.api.call("update_crm_lead_integrations_crm_connections__connection_id__leads__lead_id__put", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Partially update a Salesforce Lead. Omitted fields are left alone.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.connection_id` | `string` | yes | The CRM connection to act through. |
+| `path.lead_id` | `string` | yes |  |
+| `body` | `LeadUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`LeadUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.address` | `CrmAddress \| null` | no |  |
+| `body.annual_revenue` | `number \| null` | no |  |
+| `body.company` | `string \| null` | no |  |
+| `body.custom_fields` | `Array<CrmCustomField> \| null` | no |  |
+| `body.email` | `string \| null` | no |  |
+| `body.employee_count` | `integer \| null` | no |  |
+| `body.first_name` | `string \| null` | no |  |
+| `body.industry` | `string \| null` | no |  |
+| `body.last_name` | `string \| null` | no |  |
+| `body.lead_source` | `string \| null` | no |  |
+| `body.phone` | `string \| null` | no |  |
+| `body.status` | `string \| null` | no |  |
+| `body.title` | `string \| null` | no |  |
+| `body.user_id` | `string \| null` | no |  |
+| `body.website` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.updateCrmLead({ path: { connection_id: "id", lead_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-updatecrmmeeting"></a>
+
+### `g8.api.integrations.updateCrmMeeting(input)`
+
+**Update Crm Meeting**
+
+- HTTP: `PATCH /api/v1/integrations/crm/meetings/{event_id}`
+- operationId: `update_crm_meeting_integrations_crm_meetings__event_id__patch` (also callable as `g8.api.call("update_crm_meeting_integrations_crm_meetings__event_id__patch", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Partially update a CRM meeting.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.event_id` | `string` | yes | The CRM's event id. |
+| `query.connection_id` | `string` | yes |  |
+| `body` | `UpdateMeetingRequest` | yes | Request body; fields below. |
+
+Body fields (`UpdateMeetingRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.company_ids` | `Array<string> \| null` | no |  |
+| `body.contact_ids` | `Array<string> \| null` | no |  |
+| `body.deal_ids` | `Array<string> \| null` | no |  |
+| `body.description` | `string \| null` | no |  |
+| `body.end_at` | `string \| null` | no |  |
+| `body.location` | `string \| null` | no |  |
+| `body.start_at` | `string \| null` | no |  |
+| `body.title` | `string \| null` | no |  |
+| `body.user_id` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_CrmPayload_`: the envelope `{ data: CrmPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.updateCrmMeeting({ path: { event_id: "id" }, query: { connection_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-uploadgoogleconversions"></a>
+
+### `g8.api.integrations.uploadGoogleConversions(input?)`
+
+**Upload Google Conversions**
+
+- HTTP: `POST /api/v1/audience-syncs/google/conversions`
+- operationId: `upload_google_conversions_audience_syncs_google_conversions_post` (also callable as `g8.api.call("upload_google_conversions_audience_syncs_google_conversions_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Upload offline conversions to Google Ads.
+
+IRREVERSIBLE once `dry_run=false`: a conversion recorded against the wrong
+action cannot be unrecorded, and Smart Bidding immediately starts
+optimising the customer's budget against it. The safe default and the
+`validate_only` middle step are both preserved from the app rather than
+flattened into "do the thing".
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.ad_account_id` | `string \| null` | no |  |
+| `query.dry_run` | `boolean` | no | TRUE BY DEFAULT, and deliberately. The batch is built and NOTHING is sent to Google. Read the result, then send `false`. default `true` |
+| `query.validate_only` | `boolean` | no | With `dry_run=false`, ask Google to VALIDATE the batch without recording it. The middle step between a local preview and a real upload - it catches what only Google can tell you. default `false` |
+| `query.limit` | `integer` | no | Conversions per call. default `200` |
+
+**Returns** `ApiResponse_AdPayload_`: the envelope `{ data: AdPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.integrations.uploadGoogleConversions();
+```
+
+---
+
+<a id="op-validatesugarcrm"></a>
+
+### `g8.api.integrations.validateSugarcrm(input?)`
+
+**Validate Sugarcrm**
+
+- HTTP: `POST /api/v1/integrations/sugarcrm/validate`
+- operationId: `validate_sugarcrm_integrations_sugarcrm_validate_post` (also callable as `g8.api.call("validate_sugarcrm_integrations_sugarcrm_validate_post", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+
+Check the stored SugarCRM connection still works, and as whom.
+
+Reads only. `valid: false` means SugarCRM refused the stored credentials;
+404 means there is no SugarCRM connection.
+
+**Input**: none.
+
+**Returns** `ApiResponse_IntegrationOpPayload_`: the envelope `{ data: IntegrationOpPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.integrations.validateSugarcrm();
+```
+
+---
+
+## Referenced types
+
+Named types that appear in the tables above. Full TypeScript definitions: `G8Contract.<Name>` (`import type { G8Contract } from "@graph8/sdk"`).
+
+<a id="type-batchcontactrequest"></a>
+
+### `BatchContactRequest`
+
+One contact in a batch. `crm_id` is only read on the UPDATE path.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `email` | `string` | yes |  |
+| `address` | `CrmAddress \| null` | no |  |
+| `company_id` | `string \| null` | no |  |
+| `company_name` | `string \| null` | no |  |
+| `crm_id` | `string \| null` | no | The record's id in the CRM. Required on update, ignored on create. |
+| `custom_fields` | `Array<CrmCustomField>` | no |  |
+| `first_name` | `string \| null` | no |  |
+| `last_name` | `string \| null` | no |  |
+| `phone` | `string \| null` | no |  |
+| `title` | `string \| null` | no |  |
+| `user_id` | `string \| null` | no |  |
+
+<a id="type-crmaddress"></a>
+
+### `CrmAddress`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `address_type` | `string \| null` | no |  |
+| `city` | `string \| null` | no |  |
+| `country` | `string \| null` | no |  |
+| `postal_code` | `string \| null` | no |  |
+| `state` | `string \| null` | no |  |
+| `street` | `string \| null` | no |  |
+| `street2` | `string \| null` | no |  |
+
+<a id="type-crmcustomfield"></a>
+
+### `CrmCustomField`
+
+One provider-side custom field. `field_name` is the CRM's API name, not its label. Read the valid names from `GET /integrations/crm/fields`; a name the provider does not have is rejected by the provider, not here.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `field_name` | `string` | yes |  |
+| `field_value` | `unknown` | yes | Required, but may be null - which is how a custom field is cleared. |
+| `field_type` | `string \| null` | no |  |
+
+<a id="type-crmemail"></a>
+
+### `CrmEmail`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `email` | `string` | yes |  |
+| `email_type` | `string \| null` | no | Provider's own label, e.g. `work`. Passed through unchanged. |
+
+<a id="type-crmphone"></a>
+
+### `CrmPhone`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `phone` | `string` | yes |  |
+| `phone_type` | `string \| null` | no |  |