@graph8/sdk 0.251.0 → 0.262.0

package/docs/api/gtmCampaigns.md

@@ -0,0 +1,1044 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.gtmCampaigns`: GTM Campaigns
+
+22 operations (9 read, 2 destructive, 11 external).
+
+4 of these also have a hand-written method (`g8.campaigns`), 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: [gtmCampaigns.d.ts](gtmCampaigns.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`attachAudienceToCampaign`](#op-attachaudiencetocampaign) | `PUT /api/v1/campaigns/{campaign_id}/audience` | external | `campaigns:run` | Attach Audience To Campaign |
+| [`createCampaign`](#op-createcampaign) ★ | `POST /api/v1/campaigns` | external | `campaigns:run` | Create Campaign |
+| [`createCampaignDocument`](#op-createcampaigndocument) | `POST /api/v1/campaigns/{campaign_id}/documents` | external | `campaigns:run` | Create Campaign Document |
+| [`createCampaignStep`](#op-createcampaignstep) | `POST /api/v1/campaigns/{campaign_id}/sequence/steps` | external | `campaigns:run` | Create Campaign Step |
+| [`deleteCampaignDocument`](#op-deletecampaigndocument) | `DELETE /api/v1/campaigns/{campaign_id}/documents/{document_id}` | destructive | `campaigns:delete` | Delete Campaign Document |
+| [`deleteCampaignStep`](#op-deletecampaignstep) | `DELETE /api/v1/campaigns/{campaign_id}/sequence/steps/{step_id}` | destructive | `campaigns:delete` | Delete Campaign Step |
+| [`getCampaign`](#op-getcampaign) ★ | `GET /api/v1/campaigns/{campaign_id}` | read | `campaigns:read` | Get Campaign |
+| [`getCampaignDocument`](#op-getcampaigndocument) | `GET /api/v1/campaigns/{campaign_id}/documents/{document_id}` | read | `campaigns:read` | Get Campaign Document |
+| [`getCampaignFull`](#op-getcampaignfull) | `GET /api/v1/campaigns/{campaign_id}/full` | read | `campaigns:read` | Get Campaign Full |
+| [`getCampaignMetrics`](#op-getcampaignmetrics) | `GET /api/v1/campaigns/{campaign_id}/metrics` | read | `campaigns:read` | Get Campaign Metrics |
+| [`getCampaignSequence`](#op-getcampaignsequence) | `GET /api/v1/campaigns/{campaign_id}/sequence` | read | `campaigns:read` | Get Campaign Sequence |
+| [`hideCampaignAdImage`](#op-hidecampaignadimage) | `POST /api/v1/campaigns/{campaign_id}/ad-images/{image_id}/hide` | external | `campaigns:run` | Hide Campaign Ad Image |
+| [`launchCampaign`](#op-launchcampaign) ★ | `POST /api/v1/campaigns/{campaign_id}/launch` | external | `campaigns:launch` | Launch Campaign |
+| [`listCampaignAdImages`](#op-listcampaignadimages) | `GET /api/v1/campaigns/{campaign_id}/ad-images` | read | `campaigns:read` | List Campaign Ad Images |
+| [`listCampaignDocuments`](#op-listcampaigndocuments) | `GET /api/v1/campaigns/{campaign_id}/documents` | read | `campaigns:read` | List Campaign Documents |
+| [`listCampaignIdeas`](#op-listcampaignideas) | `GET /api/v1/campaigns/ideas` | read | `campaigns:read` | List Campaign Ideas |
+| [`listCampaigns`](#op-listcampaigns) ★ | `GET /api/v1/campaigns` | read | `campaigns:read` | List Campaigns |
+| [`patchCampaignFull`](#op-patchcampaignfull) | `PATCH /api/v1/campaigns/{campaign_id}/full` | external | `campaigns:run` | Patch Campaign Full |
+| [`updateCampaign`](#op-updatecampaign) | `PATCH /api/v1/campaigns/{campaign_id}` | external | `campaigns:run` | Update Campaign |
+| [`updateCampaignDocument`](#op-updatecampaigndocument) | `PUT /api/v1/campaigns/{campaign_id}/documents/{document_id}` | external | `campaigns:run` | Update Campaign Document |
+| [`updateCampaignSequence`](#op-updatecampaignsequence) | `PUT /api/v1/campaigns/{campaign_id}/sequence` | external | `campaigns:run` | Update Campaign Sequence |
+| [`updateCampaignStep`](#op-updatecampaignstep) | `PUT /api/v1/campaigns/{campaign_id}/sequence/steps/{step_id}` | external | `campaigns:run` | Update Campaign Step |
+
+---
+
+<a id="op-attachaudiencetocampaign"></a>
+
+### `g8.api.gtmCampaigns.attachAudienceToCampaign(input)`
+
+**Attach Audience To Campaign**
+
+- HTTP: `PUT /api/v1/campaigns/{campaign_id}/audience`
+- operationId: `attach_audience_to_campaign_campaigns__campaign_id__audience_put` (also callable as `g8.api.call("attach_audience_to_campaign_campaigns__campaign_id__audience_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: `campaigns:run`
+
+Attach (or detach) a saved list to a campaign as its audience.
+
+This is the missing link in Daniel's MCP flow: ``find list → create
+campaign → attach audience → launch`` was previously a dead-end because
+no REST/MCP path could set ``cb_campaigns.audience_list_id`` (the FE
+"Attach Audience" dialog only went through an internal route).
+
+Idempotent — setting the same list twice is a 200, no error. Pass
+``list_id=null`` to detach. The launch endpoint reads
+``cb_campaigns.audience_list_id`` when enrolling contacts; without it,
+launch creates a sequence with zero enrollment.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign ID |
+| `body` | `CampaignAttachAudienceRequest` | yes | Request body; fields below. |
+
+Body fields (`CampaignAttachAudienceRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.list_id` | `string \| null` | no | List ID to attach as the campaign's audience. Pass null to detach. The list must already exist in this org (matches audiences.id, the canonical lists table — accepts an integer or its string form). |
+
+**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.gtmCampaigns.attachAudienceToCampaign({ path: { campaign_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-createcampaign"></a>
+
+### `g8.api.gtmCampaigns.createCampaign(input)`
+
+**Create Campaign**
+
+- HTTP: `POST /api/v1/campaigns`
+- operationId: `create_campaign_campaigns_post` (also callable as `g8.api.call("create_campaign_campaigns_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: `campaigns:run`
+- ★ Hand-written: [`g8.campaigns.create()`](../sdk-clients.md#g8-campaigns-create)
+
+Create a new campaign from scratch — full Studio "Convert to Campaign" parity.
+
+The original handler only inserted ``cb_campaigns``. That left two
+Studio-side gaps:
+
+1. Studio's Campaigns workbench (``frontend/features/studio/components/
+   CampaignUnifiedTable.tsx``) filters ``cb_campaign_ideas`` WHERE
+   ``converted_to_campaign=true`` and joins back to ``cb_campaigns`` via
+   ``converted_campaign_id``. With no paired idea row, MCP-created
+   campaigns were invisible in the workbench (only the direct
+   ``/studio?campaignId=...`` URL worked).
+2. No documents were generated, so the campaign sat in "Not Ready" state
+   indefinitely. The launch flow silently produced empty sequences.
+
+This handler now mirrors ``campaign_builder/routers/campaign_conversion.py
+:convert_idea_to_campaign`` end-to-end:
+
+* INSERT cb_campaigns (status=``copy_in_progress`` when generating, else ``draft``)
+* INSERT paired cb_campaign_ideas row with ``source='mcp'``,
+  ``converted_to_campaign=true``, ``converted_campaign_id=<new>``
+* INSERT cb_campaign_metadata with ``total_documents`` calculated from the
+  target channels
+* Scaffold ``sequence`` + ``step_catalog`` stub docs (idempotent)
+* Dispatch ``generate_campaign_files_from_idea.delay(...)`` to Celery
+
+Backwards-compatible: original 7-field callers still work AND see
+byte-for-byte identical behavior because ``auto_generate_documents``
+defaults to ``False``. All Studio-parity behavior (paired idea row,
+metadata row, Celery dispatch, status='copy_in_progress') is opt-in
+via ``auto_generate_documents=True``. The MCP ``g8_gtm_create_campaign``
+tool wrapper sets it to ``True`` so Daniel's GTM agent gets the fix
+without affecting any other direct API caller.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `developer_api__interfaces__v1__gtm_campaigns_router__CampaignCreateRequest` | yes | Request body; fields below. |
+
+Body fields (`developer_api__interfaces__v1__gtm_campaigns_router__CampaignCreateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.name` | `string` | yes | Campaign name max length 255 |
+| `body.audience_list_id` | `string \| null` | no | If provided, attaches this list ID to cb_campaigns.audience_list_id at create time. |
+| `body.auto_generate_documents` | `boolean` | no | When True, dispatches the Celery campaign-content generator asynchronously after creation: the paired cb_campaign_ideas row is inserted (so the FE workbench sees the campaign), cb_campaign_metadata is created, the campaign starts in status='copy_in_progress', and flips to 'active' once docs are ready (~60-90s). Default is False to preserve byte-for-byte backwards compatibility with the original b… default `false` |
+| `body.brief` | `string \| null` | no | Campaign brief |
+| `body.category` | `string` | no | Campaign category default `"Outbound"`, max length 100 |
+| `body.core_concept` | `string \| null` | no | Core concept |
+| `body.execution_targets` | `Array<string> \| null` | no | Execution destinations: sequencer, dialer, or content_only. |
+| `body.goal` | `string \| null` | no | Campaign goal max length 255 |
+| `body.primary_hook` | `string \| null` | no | Primary hook text |
+| `body.secondary_hooks` | `Array<string> \| null` | no | Additional hook variations to seed the campaign idea with. |
+| `body.target_channels` | `Array<string> \| null` | no | Channels the campaign will use, e.g. ['email'], ['email','linkedin']. Drives which copy documents the auto-generator creates. Defaults to ['email']. |
+| `body.target_persona` | `string \| null` | no | Target persona max length 200 |
+
+**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.gtmCampaigns.createCampaign({ body: { name: "Example" } });
+```
+
+---
+
+<a id="op-createcampaigndocument"></a>
+
+### `g8.api.gtmCampaigns.createCampaignDocument(input)`
+
+**Create Campaign Document**
+
+- HTTP: `POST /api/v1/campaigns/{campaign_id}/documents`
+- operationId: `create_campaign_document_campaigns__campaign_id__documents_post` (also callable as `g8.api.call("create_campaign_document_campaigns__campaign_id__documents_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: `campaigns:run`
+
+Create a campaign document with content stored in metadata.
+
+``meta_data`` shape mirrors what the Celery doc-generator writes so the
+FE renders MCP-created docs identically: ``content`` (markdown body),
+``completed`` (mirrors status=='completed' so launch checklist counts
+it), and optional ``structured_data`` (parsed payload, e.g. sequence
+step list).
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign ID |
+| `body` | `CampaignDocumentCreateRequest` | yes | Request body; fields below. |
+
+Body fields (`CampaignDocumentCreateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.display_name` | `string` | yes | Human-readable document name |
+| `body.file_type` | `string` | yes | Document type, for example campaign_brief or sequence |
+| `body.content` | `string` | no | Document content default `""` |
+| `body.folder_path` | `string \| null` | no | Optional folder path |
+| `body.status` | `string` | no | Document status — 'draft' (default) or 'completed' default `"draft"` |
+| `body.structured_data` | `Record<string, unknown> \| null` | no | Optional structured payload (e.g., sequence steps, persona JSON) stored alongside the markdown content at meta_data.structured_data. Mirrors the update path so the MCP create+update flow is symmetric. |
+
+**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.gtmCampaigns.createCampaignDocument({
+  path: { campaign_id: "id" },
+  body: { display_name: "Example", file_type: "example" },
+});
+```
+
+---
+
+<a id="op-createcampaignstep"></a>
+
+### `g8.api.gtmCampaigns.createCampaignStep(input)`
+
+**Create Campaign Step**
+
+- HTTP: `POST /api/v1/campaigns/{campaign_id}/sequence/steps`
+- operationId: `create_campaign_step_campaigns__campaign_id__sequence_steps_post` (also callable as `g8.api.call("create_campaign_step_campaigns__campaign_id__sequence_steps_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: `campaigns:run`
+
+Create a step definition and append it to the campaign sequence.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign ID |
+| `body` | `CreateStepRequest` | yes | Request body; fields below. |
+
+Body fields (`CreateStepRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.channel` | `string` | yes |  |
+| `body.day` | `integer` | yes |  |
+| `body.mode` | `string` | yes |  |
+| `body.name` | `string` | yes |  |
+| `body.angle_id` | `string \| null` | no |  |
+| `body.condition` | `string \| null` | no |  |
+| `body.constraints` | `Record<string, unknown>` | no |  |
+| `body.cta_type` | `string` | no | default `"soft_ask"` |
+| `body.personalization_level` | `string` | no | default `"medium"` |
+| `body.platform` | `string \| null` | no |  |
+| `body.stop_on_reply` | `boolean` | no | default `true` |
+
+**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.gtmCampaigns.createCampaignStep({
+  path: { campaign_id: "id" },
+  body: { channel: "example", day: 1, mode: "example", name: "Example" },
+});
+```
+
+---
+
+<a id="op-deletecampaigndocument"></a>
+
+### `g8.api.gtmCampaigns.deleteCampaignDocument(input)`
+
+**Delete Campaign Document**
+
+- HTTP: `DELETE /api/v1/campaigns/{campaign_id}/documents/{document_id}`
+- operationId: `delete_campaign_document_campaigns__campaign_id__documents__document_id__delete` (also callable as `g8.api.call("delete_campaign_document_campaigns__campaign_id__documents__document_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `campaigns:delete`
+
+Delete a campaign document.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign ID |
+| `path.document_id` | `string` | yes | Document 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.gtmCampaigns.deleteCampaignDocument({ path: { campaign_id: "id", document_id: "id" } });
+```
+
+---
+
+<a id="op-deletecampaignstep"></a>
+
+### `g8.api.gtmCampaigns.deleteCampaignStep(input)`
+
+**Delete Campaign Step**
+
+- HTTP: `DELETE /api/v1/campaigns/{campaign_id}/sequence/steps/{step_id}`
+- operationId: `delete_campaign_step_campaigns__campaign_id__sequence_steps__step_id__delete` (also callable as `g8.api.call("delete_campaign_step_campaigns__campaign_id__sequence_steps__step_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `campaigns:delete`
+
+Remove a sequence step from the catalog and sequence order.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign ID |
+| `path.step_id` | `string` | yes | Step 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.gtmCampaigns.deleteCampaignStep({ path: { campaign_id: "id", step_id: "id" } });
+```
+
+---
+
+<a id="op-getcampaign"></a>
+
+### `g8.api.gtmCampaigns.getCampaign(input)`
+
+**Get Campaign**
+
+- HTTP: `GET /api/v1/campaigns/{campaign_id}`
+- operationId: `get_campaign_campaigns__campaign_id__get` (also callable as `g8.api.call("get_campaign_campaigns__campaign_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+- ★ Hand-written: [`g8.campaigns.get()`](../sdk-clients.md#g8-campaigns-get)
+
+Get details of a specific campaign including generated documents.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign 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
+const result = await g8.api.gtmCampaigns.getCampaign({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-getcampaigndocument"></a>
+
+### `g8.api.gtmCampaigns.getCampaignDocument(input)`
+
+**Get Campaign Document**
+
+- HTTP: `GET /api/v1/campaigns/{campaign_id}/documents/{document_id}`
+- operationId: `get_campaign_document_campaigns__campaign_id__documents__document_id__get` (also callable as `g8.api.call("get_campaign_document_campaigns__campaign_id__documents__document_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Get full content of a specific campaign document.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign ID |
+| `path.document_id` | `string` | yes | Document 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
+const result = await g8.api.gtmCampaigns.getCampaignDocument({ path: { campaign_id: "id", document_id: "id" } });
+```
+
+---
+
+<a id="op-getcampaignfull"></a>
+
+### `g8.api.gtmCampaigns.getCampaignFull(input)`
+
+**Get Campaign Full**
+
+- HTTP: `GET /api/v1/campaigns/{campaign_id}/full`
+- operationId: `get_campaign_full_campaigns__campaign_id__full_get` (also callable as `g8.api.call("get_campaign_full_campaigns__campaign_id__full_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Get the **kitchen-sink** campaign payload in one round trip.
+
+Includes: campaign row, attached audience list summary, ALL documents
+(with content), sequence + step catalog, and linked sequencer sequences
+(so the caller can tell at a glance whether the campaign has been
+launched yet).
+
+Designed for the MCP "load entire campaign for editing" path so agents
+don't have to chain ``GET /campaigns/{id}`` → ``/documents`` → ``/sequence``
+just to see the current state.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign 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
+const result = await g8.api.gtmCampaigns.getCampaignFull({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-getcampaignmetrics"></a>
+
+### `g8.api.gtmCampaigns.getCampaignMetrics(input)`
+
+**Get Campaign Metrics**
+
+- HTTP: `GET /api/v1/campaigns/{campaign_id}/metrics`
+- operationId: `get_campaign_metrics_campaigns__campaign_id__metrics_get` (also callable as `g8.api.call("get_campaign_metrics_campaigns__campaign_id__metrics_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Get campaign execution metrics — sequence status + email sent/replied counts.
+
+Thin wrapper around the existing ``campaigns.metrics`` handler. The
+handler queries ClickHouse for per-sequence event aggregates and joins
+them to the campaign's linked sequences via ``cb_campaign_sequence_links``.
+
+Read-only. Returns the same shape the handler produces. Each campaign carries
+a ``metric_status`` (available | zero | stale | unknown | missing) that
+reconciles the ClickHouse engagement rollup against Postgres send receipts
+(``seqcontactexecutedsteps``): if analytics are unreachable the status is
+``unknown`` (NOT a zero), and if send receipts prove sends the rollup has not
+counted the status is ``stale``. Read ``reconciliation`` and ``measured_range``
+before concluding anything about delivery — never treat a bare zero as an outage.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign ID |
+| `query.days` | `integer` | no | Lookback window in days default `30` |
+
+**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
+const result = await g8.api.gtmCampaigns.getCampaignMetrics({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-getcampaignsequence"></a>
+
+### `g8.api.gtmCampaigns.getCampaignSequence(input)`
+
+**Get Campaign Sequence**
+
+- HTTP: `GET /api/v1/campaigns/{campaign_id}/sequence`
+- operationId: `get_campaign_sequence_campaigns__campaign_id__sequence_get` (also callable as `g8.api.call("get_campaign_sequence_campaigns__campaign_id__sequence_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Get the campaign sequence and step catalog documents.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign 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
+const result = await g8.api.gtmCampaigns.getCampaignSequence({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-hidecampaignadimage"></a>
+
+### `g8.api.gtmCampaigns.hideCampaignAdImage(input)`
+
+**Hide Campaign Ad Image**
+
+- HTTP: `POST /api/v1/campaigns/{campaign_id}/ad-images/{image_id}/hide`
+- operationId: `hide_campaign_ad_image_campaigns__campaign_id__ad_images__image_id__hide_post` (also callable as `g8.api.call("hide_campaign_ad_image_campaigns__campaign_id__ad_images__image_id__hide_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: `campaigns:run`
+
+Mark an ad image as hidden (feedback='down'), so it drops out of the
+MCP App grid and any future listing.
+
+Idempotent: re-posting against an already-hidden image is a no-op, still
+returns 200. Returns 404 only if the image doesn't exist (or doesn't
+belong to the caller's org / this campaign).
+
+This is the interactive action on the `ui://campaigns/ad-images` MCP
+App. The app calls `g8_hide_ad_image` over postMessage; that tool hits
+this endpoint; the response tells the app which image id to drop from
+its local state.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign ID |
+| `path.image_id` | `string` | yes | Ad image ID (cb_website_images.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.gtmCampaigns.hideCampaignAdImage({ path: { campaign_id: "id", image_id: "id" } });
+```
+
+---
+
+<a id="op-launchcampaign"></a>
+
+### `g8.api.gtmCampaigns.launchCampaign(input)`
+
+**Launch Campaign**
+
+- HTTP: `POST /api/v1/campaigns/{campaign_id}/launch`
+- operationId: `launch_campaign_campaigns__campaign_id__launch_post` (also callable as `g8.api.call("launch_campaign_campaigns__campaign_id__launch_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: `campaigns:launch`
+- ★ Hand-written: [`g8.campaigns.launch()`](../sdk-clients.md#g8-campaigns-launch)
+
+Launch a campaign through the canonical Sequencer V2 workflow.
+
+This does two things end-to-end:
+
+1. **Push** the campaign to the sequencer. The bridge loads the campaign's
+   generated documents (email/LinkedIn/phone/SMS copy), transforms them
+   into sequencer steps, and creates a new ``SeqSequence`` row with the
+   campaign content attached. A ``CampaignSequenceLink`` row links the two.
+2. **Run** the sequence through the same V2 workflow used by Sequencer.
+   The response reports ``live`` only after synchronous initialization has
+   completed, or ``scheduling`` with job details for background work.
+
+Idempotency: re-launching a campaign that already has an active sequence
+returns 409 unless ``force`` is implied via a future query-param. This is
+consistent with the UI's bridge/push behaviour.
+
+Pre-flight is mandatory. The deprecated ``validate`` parameter is accepted
+only as ``true``; ``false`` is rejected before any sequence is created.
+
+WARNING: this begins sending real outreach to real contacts.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign ID |
+| `query.validate` | `boolean` | no | Deprecated compatibility parameter. Readiness validation is always enforced; false is rejected before any sequence is created. default `true` |
+| `body` | `CampaignLaunchRequest \| null` | no | Request body; fields below. |
+
+Body fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.appointment_id` | `integer \| null` | no | Calendar event-type ID (from GET /event-types) to attach as the booking link on the sequence. Stamped onto seqsequences.appointment_id. When omitted no booking link is attached and any sequence step referencing `{{booking_link}}` will render the org-default link (or empty). |
+| `body.disable_auto_pick` | `boolean` | no | Deprecated safety escape hatch. Launch now rejects True because a consequential action cannot proceed without an active sender. default `false`, deprecated |
+| `body.schedule_id` | `string \| null` | no | Send-window schedule UUID (from GET /schedules). Stamped onto seqsequences.schedule_id. When omitted the sequencer falls back to its org-default send window. |
+| `body.sender_mailbox_ids` | `Array<integer> \| null` | no | Explicit list of mailbox IDs (from GET /mailboxes) to attach as sequence channels before launch. Each ID must reference a connection_status='active', non-archived mailbox in this org. When omitted, the bridge auto-picks the first active email mailbox (ORDER BY id ASC). If no supported sender is available, launch fails before sequence creation. |
+| `body.textual_agent_name` | `string \| null` | no | Voice-service agent identifier (from GET /agents) used for email / social steps. Stamped onto seqsequences.textual_agent_name. Pass the same value as `voice_agent_name` to use one agent across all channels (the common case — the unified Agent row already bundles persona + voice + phone + the attached appointment event). |
+| `body.voice_agent_name` | `string \| null` | no | Voice-service agent identifier (from GET /agents) used for phone / SMS steps. Stamped onto seqsequences.voice_agent_name. When you want a single agent for all channels, set both this and `textual_agent_name` to the same value. |
+
+**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.gtmCampaigns.launchCampaign({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-listcampaignadimages"></a>
+
+### `g8.api.gtmCampaigns.listCampaignAdImages(input)`
+
+**List Campaign Ad Images**
+
+- HTTP: `GET /api/v1/campaigns/{campaign_id}/ad-images`
+- operationId: `list_campaign_ad_images_campaigns__campaign_id__ad_images_get` (also callable as `g8.api.call("list_campaign_ad_images_campaigns__campaign_id__ad_images_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+List ad image creatives generated for this campaign.
+
+Ad images live in `cb_website_images` with `category='ad'` and a
+`campaign_id` back-reference (the AI generator writes there, NOT into
+`cb_campaign_documents`). This endpoint gives the MCP HTML resource a
+single place to pull the creative grid without reaching into the
+Studio-private `/v1/website-images` path.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign 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
+const result = await g8.api.gtmCampaigns.listCampaignAdImages({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-listcampaigndocuments"></a>
+
+### `g8.api.gtmCampaigns.listCampaignDocuments(input)`
+
+**List Campaign Documents**
+
+- HTTP: `GET /api/v1/campaigns/{campaign_id}/documents`
+- operationId: `list_campaign_documents_campaigns__campaign_id__documents_get` (also callable as `g8.api.call("list_campaign_documents_campaigns__campaign_id__documents_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+List document metadata for a campaign.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign 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
+const result = await g8.api.gtmCampaigns.listCampaignDocuments({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-listcampaignideas"></a>
+
+### `g8.api.gtmCampaigns.listCampaignIdeas(input?)`
+
+**List Campaign Ideas**
+
+- HTTP: `GET /api/v1/campaigns/ideas`
+- operationId: `list_campaign_ideas_campaigns_ideas_get` (also callable as `g8.api.call("list_campaign_ideas_campaigns_ideas_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+List saved campaign ideas for this organization.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.limit` | `integer` | no | Items per page default `50` |
+| `query.favorited` | `boolean \| null` | no | Filter favorited ideas |
+
+**Returns** `ApiResponse_list_dict__`: the envelope `{ data: Array<Record<string, unknown>>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.gtmCampaigns.listCampaignIdeas();
+```
+
+---
+
+<a id="op-listcampaigns"></a>
+
+### `g8.api.gtmCampaigns.listCampaigns(input?)`
+
+**List Campaigns**
+
+- HTTP: `GET /api/v1/campaigns`
+- operationId: `list_campaigns_campaigns_get` (also callable as `g8.api.call("list_campaigns_campaigns_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+- ★ Hand-written: [`g8.campaigns.list()`](../sdk-clients.md#g8-campaigns-list)
+
+List campaigns for this organization.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.page` | `integer` | no | Page number default `1` |
+| `query.limit` | `integer` | no | Items per page default `50` |
+
+**Returns** `ApiResponse_list_dict__`: the envelope `{ data: Array<Record<string, unknown>>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.gtmCampaigns.listCampaigns();
+```
+
+---
+
+<a id="op-patchcampaignfull"></a>
+
+### `g8.api.gtmCampaigns.patchCampaignFull(input)`
+
+**Patch Campaign Full**
+
+- HTTP: `PATCH /api/v1/campaigns/{campaign_id}/full`
+- operationId: `patch_campaign_full_campaigns__campaign_id__full_patch` (also callable as `g8.api.call("patch_campaign_full_campaigns__campaign_id__full_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: `campaigns:run`
+
+Apply a deep-update to a campaign in one round trip.
+
+Behavior:
+    - Campaign fields (name/brief/hook/etc.) update the row when present.
+    - ``audience_list_id`` attaches; ``detach_audience=true`` clears it.
+    - ``documents[*]`` either updates an existing doc by id, or creates a
+      new doc when id is omitted (file_type + display_name required).
+    - ``sequence_steps`` replaces the sequence ordering verbatim
+      (same semantics as PUT /sequence).
+
+Returns the full kitchen-sink payload (same shape as GET /full).
+Backwards-compat: omitting any field is a no-op. Existing single-purpose
+endpoints (PATCH /campaigns/{id}, PUT /audience, PUT /sequence, etc.)
+keep working unchanged.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign ID |
+| `body` | `CampaignFullPatchRequest` | yes | Request body; fields below. |
+
+Body fields (`CampaignFullPatchRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.audience_list_id` | `string \| null` | no | If provided (including empty string treated as detach), updates audience_list_id. Use the dedicated PUT /audience endpoint when you only need to attach. |
+| `body.brief` | `string \| null` | no |  |
+| `body.category` | `string \| null` | no | max length 100 |
+| `body.core_concept` | `string \| null` | no |  |
+| `body.detach_audience` | `boolean` | no | Set true to explicitly DETACH the audience (audience_list_id=NULL). Required because JSON null in audience_list_id is ambiguous (could mean 'no change'). default `false` |
+| `body.documents` | `Array<CampaignFullPatchDocument> \| null` | no | Per-document patches. Existing docs are updated in place (id required); new docs are created when id is omitted and file_type+display_name are present. |
+| `body.goal` | `string \| null` | no | max length 255 |
+| `body.linked_sequence_ids` | `Array<string> \| null` | no | Existing sequence IDs to bind to this campaign. INSERTs rows with status='linked' into cb_campaign_sequence_links. Skips IDs that are already linked (any status). Use for pre-launch wiring of an existing sequence; launch writes its own 'pushed' audit rows. |
+| `body.name` | `string \| null` | no | max length 255 |
+| `body.primary_hook` | `string \| null` | no |  |
+| `body.sequence_steps` | `Array<SequenceStepRef> \| null` | no | If provided, replaces the sequence step ordering (same as PUT /sequence). |
+| `body.target_persona` | `string \| null` | no | max length 200 |
+| `body.unlink_sequence_ids` | `Array<string> \| null` | no | Sequence IDs to UNLINK from this campaign. DELETEs ONLY rows where status='linked'. Launch-audit rows (status='pushed'/'superseded'/'failed') are never touched — those are an immutable historical record. |
+
+**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.gtmCampaigns.patchCampaignFull({ path: { campaign_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-updatecampaign"></a>
+
+### `g8.api.gtmCampaigns.updateCampaign(input)`
+
+**Update Campaign**
+
+- HTTP: `PATCH /api/v1/campaigns/{campaign_id}`
+- operationId: `update_campaign_campaigns__campaign_id__patch` (also callable as `g8.api.call("update_campaign_campaigns__campaign_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: `campaigns:run`
+
+Update campaign content fields (name, brief, hook, persona, etc.).
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign ID |
+| `body` | `developer_api__interfaces__v1__gtm_campaigns_router__CampaignUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`developer_api__interfaces__v1__gtm_campaigns_router__CampaignUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.brief` | `string \| null` | no | Campaign brief |
+| `body.category` | `string \| null` | no | Campaign category max length 100 |
+| `body.core_concept` | `string \| null` | no | Core concept |
+| `body.goal` | `string \| null` | no | Campaign goal max length 255 |
+| `body.name` | `string \| null` | no | Campaign name max length 255 |
+| `body.primary_hook` | `string \| null` | no | Primary hook text |
+| `body.target_persona` | `string \| null` | no | Target persona max length 200 |
+
+**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.gtmCampaigns.updateCampaign({ path: { campaign_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-updatecampaigndocument"></a>
+
+### `g8.api.gtmCampaigns.updateCampaignDocument(input)`
+
+**Update Campaign Document**
+
+- HTTP: `PUT /api/v1/campaigns/{campaign_id}/documents/{document_id}`
+- operationId: `update_campaign_document_campaigns__campaign_id__documents__document_id__put` (also callable as `g8.api.call("update_campaign_document_campaigns__campaign_id__documents__document_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: `campaigns:run`
+
+Update campaign document content and optional structured data.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign ID |
+| `path.document_id` | `string` | yes | Document ID |
+| `body` | `CampaignDocumentUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`CampaignDocumentUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.content` | `string` | no | Document content default `""` |
+| `body.status` | `string \| null` | no | Optional document status |
+| `body.structured_data` | `Record<string, unknown> \| null` | no | Optional structured document data |
+
+**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.gtmCampaigns.updateCampaignDocument({ path: { campaign_id: "id", document_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-updatecampaignsequence"></a>
+
+### `g8.api.gtmCampaigns.updateCampaignSequence(input)`
+
+**Update Campaign Sequence**
+
+- HTTP: `PUT /api/v1/campaigns/{campaign_id}/sequence`
+- operationId: `update_campaign_sequence_campaigns__campaign_id__sequence_put` (also callable as `g8.api.call("update_campaign_sequence_campaigns__campaign_id__sequence_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: `campaigns:run`
+
+Replace the campaign sequence ordering.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign ID |
+| `body` | `developer_api__interfaces__v1__gtm_campaigns_router__UpdateSequenceRequest` | yes | Request body; fields below. |
+
+Body fields (`developer_api__interfaces__v1__gtm_campaigns_router__UpdateSequenceRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.steps` | `Array<SequenceStepRef>` | yes |  |
+
+**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.gtmCampaigns.updateCampaignSequence({
+  path: { campaign_id: "id" },
+  body: { steps: [{ day: 1, step_id: "id" }] },
+});
+```
+
+---
+
+<a id="op-updatecampaignstep"></a>
+
+### `g8.api.gtmCampaigns.updateCampaignStep(input)`
+
+**Update Campaign Step**
+
+- HTTP: `PUT /api/v1/campaigns/{campaign_id}/sequence/steps/{step_id}`
+- operationId: `update_campaign_step_campaigns__campaign_id__sequence_steps__step_id__put` (also callable as `g8.api.call("update_campaign_step_campaigns__campaign_id__sequence_steps__step_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: `campaigns:run`
+
+Update a sequence step definition and optional placement metadata.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign ID |
+| `path.step_id` | `string` | yes | Step ID |
+| `body` | `UpdateStepRequest` | yes | Request body; fields below. |
+
+Body fields (`UpdateStepRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.angle_id` | `string \| null` | no |  |
+| `body.channel` | `string \| null` | no |  |
+| `body.condition` | `string \| null` | no |  |
+| `body.constraints` | `Record<string, unknown> \| null` | no |  |
+| `body.cta_type` | `string \| null` | no |  |
+| `body.day` | `integer \| null` | no |  |
+| `body.do_not_send_rules` | `Array<string> \| null` | no |  |
+| `body.mode` | `string \| null` | no |  |
+| `body.name` | `string \| null` | no |  |
+| `body.personalization_level` | `string \| null` | no |  |
+| `body.platform` | `string \| null` | no |  |
+| `body.stop_on_reply` | `boolean \| null` | no |  |
+
+**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.gtmCampaigns.updateCampaignStep({ path: { campaign_id: "id", step_id: "id" }, body: {} });
+```
+
+---
+
+## Referenced types
+
+Named types that appear in the tables above. Full TypeScript definitions: `G8Contract.<Name>` (`import type { G8Contract } from "@graph8/sdk"`).
+
+<a id="type-campaignfullpatchdocument"></a>
+
+### `CampaignFullPatchDocument`
+
+A single-document patch for `PATCH /campaigns/{id}/full`.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `content` | `string \| null` | no | Plain string content (replaces existing meta_data.content). |
+| `display_name` | `string \| null` | no | Display name (create only) |
+| `file_type` | `string \| null` | no | Required when creating; ignored on update of existing id. |
+| `folder_path` | `string \| null` | no | Folder path (create only) |
+| `id` | `string \| null` | no | Existing document id. When omitted, a new document is created. |
+| `status` | `string \| null` | no | Document status |
+| `structured_data` | `Record<string, unknown> \| null` | no | Optional structured data, merged into meta_data.structured_data. |
+
+<a id="type-sequencestepref"></a>
+
+### `SequenceStepRef`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `day` | `integer` | yes |  |
+| `step_id` | `string` | yes |  |
+| `condition` | `string \| null` | no |  |
+| `stop_on_reply` | `boolean` | no | default `true` |