@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/audienceSyncs.d.ts

@@ -0,0 +1,259 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.audienceSyncs` (Audience Syncs): 8 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"create_audience_sync_audience_syncs_post">;
+ *
+ * Reference with examples: audienceSyncs.md
+ */
+/* eslint-disable */
+
+/** `g8.api.audienceSyncs.<member>` -> the operationId it calls. */
+export interface AudienceSyncsMembers {
+  createAudienceSync: "create_audience_sync_audience_syncs_post";
+  deleteAudienceSync: "delete_audience_sync_audience_syncs__config_id__delete";
+  getAudienceSync: "get_audience_sync_audience_syncs__config_id__get";
+  listAudienceSyncs: "list_audience_syncs_audience_syncs_get";
+  listSyncErrors: "list_sync_errors_audience_syncs__config_id__errors_get";
+  listSyncRuns: "list_sync_runs_audience_syncs__config_id__runs_get";
+  triggerAudienceSync: "trigger_audience_sync_audience_syncs__config_id__trigger_post";
+  updateAudienceSync: "update_audience_sync_audience_syncs__config_id__patch";
+}
+
+/** Input and output of every `g8.api.audienceSyncs` operation, keyed by operationId. */
+export interface AudienceSyncsOperations {
+  /**
+   * POST /audience-syncs
+   * Create Audience Sync
+   * tier: external · scope: integrations:run
+   */
+  create_audience_sync_audience_syncs_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: AudienceSyncCreateRequest;
+  };
+    output: ApiResponse_AudienceSyncConfigResponse_;
+  };
+  /**
+   * DELETE /audience-syncs/{config_id}
+   * Delete Audience Sync
+   * tier: destructive · scope: integrations:delete
+   */
+  delete_audience_sync_audience_syncs__config_id__delete: {
+    input: {
+    path: {
+      /** Sync config ID */
+      config_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * GET /audience-syncs/{config_id}
+   * Get Audience Sync
+   * tier: read · scope: integrations:read
+   */
+  get_audience_sync_audience_syncs__config_id__get: {
+    input: {
+    path: {
+      /** Sync config ID */
+      config_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_AudienceSyncConfigResponse_;
+  };
+  /**
+   * GET /audience-syncs
+   * List Audience Syncs
+   * tier: read · scope: integrations:read
+   */
+  list_audience_syncs_audience_syncs_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_list_AudienceSyncConfigResponse__;
+  };
+  /**
+   * GET /audience-syncs/{config_id}/errors
+   * List Sync Errors
+   * tier: read · scope: integrations:read
+   */
+  list_sync_errors_audience_syncs__config_id__errors_get: {
+    input: {
+    path: {
+      /** Sync config ID */
+      config_id: number;
+    };
+    query?: {
+      /** Max errors to return */
+      limit?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_list_SyncErrorResponse__;
+  };
+  /**
+   * GET /audience-syncs/{config_id}/runs
+   * List Sync Runs
+   * tier: billable · scope: integrations:run
+   */
+  list_sync_runs_audience_syncs__config_id__runs_get: {
+    input: {
+    path: {
+      /** Sync config ID */
+      config_id: number;
+    };
+    query?: {
+      /** Max runs to return */
+      limit?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_list_SyncRunResponse__;
+  };
+  /**
+   * POST /audience-syncs/{config_id}/trigger
+   * Trigger Audience Sync
+   * tier: external · scope: integrations:run
+   */
+  trigger_audience_sync_audience_syncs__config_id__trigger_post: {
+    input: {
+    path: {
+      /** Sync config ID */
+      config_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * PATCH /audience-syncs/{config_id}
+   * Update Audience Sync
+   * tier: external · scope: integrations:run
+   */
+  update_audience_sync_audience_syncs__config_id__patch: {
+    input: {
+    path: {
+      /** Sync config ID */
+      config_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: AudienceSyncUpdateRequest;
+  };
+    output: ApiResponse_AudienceSyncConfigResponse_;
+  };
+}
+
+// 11 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_AudienceSyncConfigResponse_ {
+  data: AudienceSyncConfigResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_dict_ {
+  data: Record<string, unknown>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_list_AudienceSyncConfigResponse__ {
+  data: Array<AudienceSyncConfigResponse>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_list_SyncErrorResponse__ {
+  data: Array<SyncErrorResponse>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_list_SyncRunResponse__ {
+  data: Array<SyncRunResponse>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface AudienceSyncConfigResponse {
+  audience_id: number;
+  created_at?: string | null;
+  id: number;
+  is_active?: boolean;
+  last_sync_at?: string | null;
+  mode?: string;
+  platform: string;
+  platform_audience_name?: string | null;
+  refresh_cadence_hours?: number;
+  status?: string | null;
+}
+
+export interface AudienceSyncCreateRequest {
+  /** Audience list ID */
+  audience_id: number;
+  /** Sync mode: mirror | append_only */
+  mode?: string;
+  /** Ad platform: meta | linkedin | google | x */
+  platform: string;
+  platform_audience_name?: string | null;
+  /** Platform-specific config (OAuth creds) */
+  platform_config?: Record<string, unknown>;
+  refresh_cadence_hours?: number;
+  suppression_list_ids?: Array<number>;
+}
+
+export interface AudienceSyncUpdateRequest {
+  is_active?: boolean | null;
+  /** Sync mode: mirror | append_only */
+  mode?: string | null;
+  refresh_cadence_hours?: number | null;
+  suppression_list_ids?: Array<number> | null;
+}
+
+export interface PaginationMeta {
+  /** Whether there are more pages */
+  has_next: boolean;
+  /** Items per page */
+  limit: number;
+  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
+  next_cursor?: string | null;
+  /** Current page number (1-indexed) */
+  page: number;
+  /** Total number of items */
+  total: number;
+}
+
+export interface SyncErrorResponse {
+  details?: Record<string, unknown> | null;
+  error_message?: string | null;
+  id: number;
+  started_at?: string | null;
+}
+
+export interface SyncRunResponse {
+  error_message?: string | null;
+  finished_at?: string | null;
+  id: number;
+  members_added?: number | null;
+  members_removed?: number | null;
+  started_at?: string | null;
+  status?: string | null;
+  total_members?: number | null;
+}

package/docs/api/audienceSyncs.md

@@ -0,0 +1,395 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.audienceSyncs`: Audience Syncs
+
+8 operations (3 read, 1 destructive, 1 billable, 3 external).
+
+8 of these also have a hand-written method (`g8.audiences`), marked **★** below. Prefer the hand-written method when one exists: it unwraps the `data` envelope and takes friendlier arguments. See [../sdk-clients.md](../sdk-clients.md).
+
+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: [audienceSyncs.d.ts](audienceSyncs.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`createAudienceSync`](#op-createaudiencesync) ★ | `POST /api/v1/audience-syncs` | external | `integrations:run` | Create Audience Sync |
+| [`deleteAudienceSync`](#op-deleteaudiencesync) ★ | `DELETE /api/v1/audience-syncs/{config_id}` | destructive | `integrations:delete` | Delete Audience Sync |
+| [`getAudienceSync`](#op-getaudiencesync) ★ | `GET /api/v1/audience-syncs/{config_id}` | read | `integrations:read` | Get Audience Sync |
+| [`listAudienceSyncs`](#op-listaudiencesyncs) ★ | `GET /api/v1/audience-syncs` | read | `integrations:read` | List Audience Syncs |
+| [`listSyncErrors`](#op-listsyncerrors) ★ | `GET /api/v1/audience-syncs/{config_id}/errors` | read | `integrations:read` | List Sync Errors |
+| [`listSyncRuns`](#op-listsyncruns) ★ | `GET /api/v1/audience-syncs/{config_id}/runs` | billable | `integrations:run` | List Sync Runs |
+| [`triggerAudienceSync`](#op-triggeraudiencesync) ★ | `POST /api/v1/audience-syncs/{config_id}/trigger` | external | `integrations:run` | Trigger Audience Sync |
+| [`updateAudienceSync`](#op-updateaudiencesync) ★ | `PATCH /api/v1/audience-syncs/{config_id}` | external | `integrations:run` | Update Audience Sync |
+
+---
+
+<a id="op-createaudiencesync"></a>
+
+### `g8.api.audienceSyncs.createAudienceSync(input)`
+
+**Create Audience Sync**
+
+- HTTP: `POST /api/v1/audience-syncs`
+- operationId: `create_audience_sync_audience_syncs_post` (also callable as `g8.api.call("create_audience_sync_audience_syncs_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`
+- ★ Hand-written: [`g8.audiences.create()`](../sdk-clients.md#g8-audiences-create)
+
+Create a new audience sync configuration.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `AudienceSyncCreateRequest` | yes | Request body; fields below. |
+
+Body fields (`AudienceSyncCreateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.audience_id` | `integer` | yes | Audience list ID > 0 |
+| `body.platform` | `string` | yes | Ad platform: meta \| linkedin \| google \| x |
+| `body.mode` | `string` | no | Sync mode: mirror \| append_only default `"mirror"` |
+| `body.platform_audience_name` | `string \| null` | no | max length 255 |
+| `body.platform_config` | `Record<string, unknown>` | no | Platform-specific config (OAuth creds) |
+| `body.refresh_cadence_hours` | `integer` | no | default `24`, min 0, max 720 |
+| `body.suppression_list_ids` | `Array<integer>` | no |  |
+
+**Returns** `ApiResponse_AudienceSyncConfigResponse_`: the envelope `{ data: AudienceSyncConfigResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`AudienceSyncConfigResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `audience_id` | `integer` | yes |  |
+| `id` | `integer` | yes |  |
+| `platform` | `string` | yes |  |
+| `created_at` | `string \| null` | no |  |
+| `is_active` | `boolean` | no | default `true` |
+| `last_sync_at` | `string \| null` | no |  |
+| `mode` | `string` | no | default `"mirror"` |
+| `platform_audience_name` | `string \| null` | no |  |
+| `refresh_cadence_hours` | `integer` | no | default `24` |
+| `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.audienceSyncs.createAudienceSync({ body: { audience_id: 1, platform: "example" } });
+```
+
+---
+
+<a id="op-deleteaudiencesync"></a>
+
+### `g8.api.audienceSyncs.deleteAudienceSync(input)`
+
+**Delete Audience Sync**
+
+- HTTP: `DELETE /api/v1/audience-syncs/{config_id}`
+- operationId: `delete_audience_sync_audience_syncs__config_id__delete` (also callable as `g8.api.call("delete_audience_sync_audience_syncs__config_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `integrations:delete`
+- ★ Hand-written: [`g8.audiences.delete()`](../sdk-clients.md#g8-audiences-delete)
+
+Soft delete a sync configuration.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.config_id` | `integer` | yes | Sync config ID |
+
+**Returns** `ApiResponse_dict_`: the envelope `{ data: Record<string, unknown>, ... }`. `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.audienceSyncs.deleteAudienceSync({ path: { config_id: 123 } });
+```
+
+---
+
+<a id="op-getaudiencesync"></a>
+
+### `g8.api.audienceSyncs.getAudienceSync(input)`
+
+**Get Audience Sync**
+
+- HTTP: `GET /api/v1/audience-syncs/{config_id}`
+- operationId: `get_audience_sync_audience_syncs__config_id__get` (also callable as `g8.api.call("get_audience_sync_audience_syncs__config_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+- ★ Hand-written: [`g8.audiences.get()`](../sdk-clients.md#g8-audiences-get)
+
+Get a sync configuration by ID.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.config_id` | `integer` | yes | Sync config ID |
+
+**Returns** `ApiResponse_AudienceSyncConfigResponse_`: the envelope `{ data: AudienceSyncConfigResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`AudienceSyncConfigResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `audience_id` | `integer` | yes |  |
+| `id` | `integer` | yes |  |
+| `platform` | `string` | yes |  |
+| `created_at` | `string \| null` | no |  |
+| `is_active` | `boolean` | no | default `true` |
+| `last_sync_at` | `string \| null` | no |  |
+| `mode` | `string` | no | default `"mirror"` |
+| `platform_audience_name` | `string \| null` | no |  |
+| `refresh_cadence_hours` | `integer` | no | default `24` |
+| `status` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.audienceSyncs.getAudienceSync({ path: { config_id: 123 } });
+```
+
+---
+
+<a id="op-listaudiencesyncs"></a>
+
+### `g8.api.audienceSyncs.listAudienceSyncs(input?)`
+
+**List Audience Syncs**
+
+- HTTP: `GET /api/v1/audience-syncs`
+- operationId: `list_audience_syncs_audience_syncs_get` (also callable as `g8.api.call("list_audience_syncs_audience_syncs_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+- ★ Hand-written: [`g8.audiences.list()`](../sdk-clients.md#g8-audiences-list)
+
+List all audience sync configurations for the org.
+
+**Input**: none.
+
+**Returns** `ApiResponse_list_AudienceSyncConfigResponse__`: the envelope `{ data: Array<AudienceSyncConfigResponse>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`AudienceSyncConfigResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `audience_id` | `integer` | yes |  |
+| `id` | `integer` | yes |  |
+| `platform` | `string` | yes |  |
+| `created_at` | `string \| null` | no |  |
+| `is_active` | `boolean` | no | default `true` |
+| `last_sync_at` | `string \| null` | no |  |
+| `mode` | `string` | no | default `"mirror"` |
+| `platform_audience_name` | `string \| null` | no |  |
+| `refresh_cadence_hours` | `integer` | no | default `24` |
+| `status` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.audienceSyncs.listAudienceSyncs();
+```
+
+---
+
+<a id="op-listsyncerrors"></a>
+
+### `g8.api.audienceSyncs.listSyncErrors(input)`
+
+**List Sync Errors**
+
+- HTTP: `GET /api/v1/audience-syncs/{config_id}/errors`
+- operationId: `list_sync_errors_audience_syncs__config_id__errors_get` (also callable as `g8.api.call("list_sync_errors_audience_syncs__config_id__errors_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `integrations:read`
+- ★ Hand-written: [`g8.audiences.errors()`](../sdk-clients.md#g8-audiences-errors)
+
+Get sync error logs for a configuration.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.config_id` | `integer` | yes | Sync config ID |
+| `query.limit` | `integer` | no | Max errors to return default `20` |
+
+**Returns** `ApiResponse_list_SyncErrorResponse__`: the envelope `{ data: Array<SyncErrorResponse>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SyncErrorResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `integer` | yes |  |
+| `details` | `Record<string, unknown> \| null` | no |  |
+| `error_message` | `string \| null` | no |  |
+| `started_at` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.audienceSyncs.listSyncErrors({ path: { config_id: 123 } });
+```
+
+---
+
+<a id="op-listsyncruns"></a>
+
+### `g8.api.audienceSyncs.listSyncRuns(input)`
+
+**List Sync Runs**
+
+- HTTP: `GET /api/v1/audience-syncs/{config_id}/runs`
+- operationId: `list_sync_runs_audience_syncs__config_id__runs_get` (also callable as `g8.api.call("list_sync_runs_audience_syncs__config_id__runs_get", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `integrations:run`
+- ★ Hand-written: [`g8.audiences.runs()`](../sdk-clients.md#g8-audiences-runs)
+
+Get sync run history for a configuration.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.config_id` | `integer` | yes | Sync config ID |
+| `query.limit` | `integer` | no | Max runs to return default `20` |
+
+**Returns** `ApiResponse_list_SyncRunResponse__`: the envelope `{ data: Array<SyncRunResponse>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SyncRunResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `integer` | yes |  |
+| `error_message` | `string \| null` | no |  |
+| `finished_at` | `string \| null` | no |  |
+| `members_added` | `integer \| null` | no |  |
+| `members_removed` | `integer \| null` | no |  |
+| `started_at` | `string \| null` | no |  |
+| `status` | `string \| null` | no |  |
+| `total_members` | `integer \| null` | no |  |
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.audienceSyncs.listSyncRuns({ path: { config_id: 123 } });
+```
+
+---
+
+<a id="op-triggeraudiencesync"></a>
+
+### `g8.api.audienceSyncs.triggerAudienceSync(input)`
+
+**Trigger Audience Sync**
+
+- HTTP: `POST /api/v1/audience-syncs/{config_id}/trigger`
+- operationId: `trigger_audience_sync_audience_syncs__config_id__trigger_post` (also callable as `g8.api.call("trigger_audience_sync_audience_syncs__config_id__trigger_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`
+- ★ Hand-written: [`g8.audiences.trigger()`](../sdk-clients.md#g8-audiences-trigger)
+
+Manually trigger an audience sync.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.config_id` | `integer` | yes | Sync config ID |
+
+**Returns** `ApiResponse_dict_`: the envelope `{ data: Record<string, unknown>, ... }`. `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.audienceSyncs.triggerAudienceSync({ path: { config_id: 123 } });
+```
+
+---
+
+<a id="op-updateaudiencesync"></a>
+
+### `g8.api.audienceSyncs.updateAudienceSync(input)`
+
+**Update Audience Sync**
+
+- HTTP: `PATCH /api/v1/audience-syncs/{config_id}`
+- operationId: `update_audience_sync_audience_syncs__config_id__patch` (also callable as `g8.api.call("update_audience_sync_audience_syncs__config_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`
+- ★ Hand-written: [`g8.audiences.update()`](../sdk-clients.md#g8-audiences-update)
+
+Update a sync configuration (partial update).
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.config_id` | `integer` | yes | Sync config ID |
+| `body` | `AudienceSyncUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`AudienceSyncUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.is_active` | `boolean \| null` | no |  |
+| `body.mode` | `string \| null` | no | Sync mode: mirror \| append_only |
+| `body.refresh_cadence_hours` | `integer \| null` | no | min 0, max 720 |
+| `body.suppression_list_ids` | `Array<integer> \| null` | no |  |
+
+**Returns** `ApiResponse_AudienceSyncConfigResponse_`: the envelope `{ data: AudienceSyncConfigResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`AudienceSyncConfigResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `audience_id` | `integer` | yes |  |
+| `id` | `integer` | yes |  |
+| `platform` | `string` | yes |  |
+| `created_at` | `string \| null` | no |  |
+| `is_active` | `boolean` | no | default `true` |
+| `last_sync_at` | `string \| null` | no |  |
+| `mode` | `string` | no | default `"mirror"` |
+| `platform_audience_name` | `string \| null` | no |  |
+| `refresh_cadence_hours` | `integer` | no | default `24` |
+| `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.audienceSyncs.updateAudienceSync({ path: { config_id: 123 }, body: {} });
+```