@graph8/sdk 0.251.0 → 0.262.0

package/docs/api/programmaticPages.md

@@ -0,0 +1,626 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.programmaticPages`: Programmatic Pages
+
+15 operations (6 read, 6 write, 1 destructive, 2 external).
+
+No hand-written client covers this area. Call it through `g8.api.programmaticPages.*` 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: [programmaticPages.d.ts](programmaticPages.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`createProgrammaticCampaign`](#op-createprogrammaticcampaign) | `POST /api/v1/programmatic-campaigns` | write | `campaigns:write` | Create Programmatic Campaign |
+| [`deleteProgrammaticCampaign`](#op-deleteprogrammaticcampaign) | `DELETE /api/v1/programmatic-campaigns/{campaign_id}` | destructive | `campaigns:delete` | Delete Programmatic Campaign |
+| [`getProgrammaticCampaign`](#op-getprogrammaticcampaign) | `GET /api/v1/programmatic-campaigns/{campaign_id}` | read | `campaigns:read` | Get Programmatic Campaign |
+| [`getProgrammaticCampaignVariables`](#op-getprogrammaticcampaignvariables) | `GET /api/v1/programmatic-campaigns/{campaign_id}/variables` | read | `campaigns:read` | Get Programmatic Campaign Variables |
+| [`getProgrammaticGenerationStatus`](#op-getprogrammaticgenerationstatus) | `GET /api/v1/programmatic-campaigns/{campaign_id}/status` | read | `campaigns:read` | Get Programmatic Generation Status |
+| [`getProgrammaticWorkspace`](#op-getprogrammaticworkspace) | `GET /api/v1/programmatic-campaigns/{campaign_id}/workspace` | read | `campaigns:read` | Get Programmatic Workspace |
+| [`importProgrammaticSitemap`](#op-importprogrammaticsitemap) | `POST /api/v1/programmatic-campaigns/{campaign_id}/imports/sitemap` | write | `campaigns:write` | Import Programmatic Sitemap |
+| [`listProgrammaticCampaigns`](#op-listprogrammaticcampaigns) | `GET /api/v1/programmatic-campaigns` | read | `campaigns:read` | List Programmatic Campaigns |
+| [`listProgrammaticGeneratedPages`](#op-listprogrammaticgeneratedpages) | `GET /api/v1/programmatic-campaigns/{campaign_id}/pages` | read | `campaigns:read` | List Programmatic Generated Pages |
+| [`previewProgrammaticPage`](#op-previewprogrammaticpage) | `POST /api/v1/programmatic-campaigns/{campaign_id}/preview` | write | `campaigns:write` | Preview Programmatic Page |
+| [`runProgrammaticBulkPageAction`](#op-runprogrammaticbulkpageaction) | `POST /api/v1/programmatic-campaigns/{campaign_id}/pages/actions` | external | `campaigns:run` | Run Programmatic Bulk Page Action |
+| [`runProgrammaticPageAction`](#op-runprogrammaticpageaction) | `POST /api/v1/programmatic-campaigns/{campaign_id}/pages/{page_id}/actions` | external | `campaigns:run` | Run Programmatic Page Action |
+| [`startProgrammaticGeneration`](#op-startprogrammaticgeneration) | `POST /api/v1/programmatic-campaigns/{campaign_id}/generate` | write | `campaigns:write` | Start Programmatic Generation |
+| [`updateProgrammaticCampaign`](#op-updateprogrammaticcampaign) | `PATCH /api/v1/programmatic-campaigns/{campaign_id}` | write | `campaigns:write` | Update Programmatic Campaign |
+| [`updateProgrammaticWorkspace`](#op-updateprogrammaticworkspace) | `PATCH /api/v1/programmatic-campaigns/{campaign_id}/workspace` | write | `campaigns:write` | Update Programmatic Workspace |
+
+---
+
+<a id="op-createprogrammaticcampaign"></a>
+
+### `g8.api.programmaticPages.createProgrammaticCampaign(input)`
+
+**Create Programmatic Campaign**
+
+- HTTP: `POST /api/v1/programmatic-campaigns`
+- operationId: `create_programmatic_campaign_programmatic_campaigns_post` (also callable as `g8.api.call("create_programmatic_campaign_programmatic_campaigns_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Create a programmatic campaign from a template page and a source. FREE.
+
+Nothing is generated yet - `POST /{id}/preview` renders one row, and
+`POST /{id}/generate` renders them all. `created_by` is the key's principal.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `CreateProgrammaticCampaignRequest` | yes | Request body; fields below. |
+
+Body fields (`CreateProgrammaticCampaignRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.name` | `string` | yes |  |
+| `body.template_page_id` | `string` | yes | A landing page with HTML, from `GET /landing-pages`. |
+| `body.data_source_id` | `string \| null` | no |  |
+| `body.data_source_name` | `string \| null` | no |  |
+| `body.data_source_type` | `"list" \| "workbench" \| "csv" \| "seo_import"` | no | default `"list"` |
+| `body.list_id` | `integer \| null` | no |  |
+| `body.settings` | `Record<string, unknown> \| null` | no |  |
+| `body.slug_template` | `string` | no | default `"{{company}}-{{first_name}}"` |
+| `body.variable_config` | `Array<Record<string, unknown>> \| null` | no |  |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.programmaticPages.createProgrammaticCampaign({ body: { name: "Example", template_page_id: "id" } });
+```
+
+---
+
+<a id="op-deleteprogrammaticcampaign"></a>
+
+### `g8.api.programmaticPages.deleteProgrammaticCampaign(input)`
+
+**Delete Programmatic Campaign**
+
+- HTTP: `DELETE /api/v1/programmatic-campaigns/{campaign_id}`
+- operationId: `delete_programmatic_campaign_programmatic_campaigns__campaign_id__delete` (also callable as `g8.api.call("delete_programmatic_campaign_programmatic_campaigns__campaign_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `campaigns:delete`
+
+Delete the campaign and its generated pages.
+
+Spends nothing.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Programmatic campaign id. |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `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.programmaticPages.deleteProgrammaticCampaign({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-getprogrammaticcampaign"></a>
+
+### `g8.api.programmaticPages.getProgrammaticCampaign(input)`
+
+**Get Programmatic Campaign**
+
+- HTTP: `GET /api/v1/programmatic-campaigns/{campaign_id}`
+- operationId: `get_programmatic_campaign_programmatic_campaigns__campaign_id__get` (also callable as `g8.api.call("get_programmatic_campaign_programmatic_campaigns__campaign_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+One programmatic campaign. FREE.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Programmatic campaign id. |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.programmaticPages.getProgrammaticCampaign({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-getprogrammaticcampaignvariables"></a>
+
+### `g8.api.programmaticPages.getProgrammaticCampaignVariables(input)`
+
+**Get Programmatic Campaign Variables**
+
+- HTTP: `GET /api/v1/programmatic-campaigns/{campaign_id}/variables`
+- operationId: `get_programmatic_campaign_variables_programmatic_campaigns__campaign_id__variables_get` (also callable as `g8.api.call("get_programmatic_campaign_variables_programmatic_campaigns__campaign_id__variables_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+The template's `{{variables}}` and the source columns they can bind to. FREE.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Programmatic campaign id. |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.programmaticPages.getProgrammaticCampaignVariables({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-getprogrammaticgenerationstatus"></a>
+
+### `g8.api.programmaticPages.getProgrammaticGenerationStatus(input)`
+
+**Get Programmatic Generation Status**
+
+- HTTP: `GET /api/v1/programmatic-campaigns/{campaign_id}/status`
+- operationId: `get_programmatic_generation_status_programmatic_campaigns__campaign_id__status_get` (also callable as `g8.api.call("get_programmatic_generation_status_programmatic_campaigns__campaign_id__status_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Generation progress: pages generated, failed, total. FREE - the poll target.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Programmatic campaign id. |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.programmaticPages.getProgrammaticGenerationStatus({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-getprogrammaticworkspace"></a>
+
+### `g8.api.programmaticPages.getProgrammaticWorkspace(input)`
+
+**Get Programmatic Workspace**
+
+- HTTP: `GET /api/v1/programmatic-campaigns/{campaign_id}/workspace`
+- operationId: `get_programmatic_workspace_programmatic_campaigns__campaign_id__workspace_get` (also callable as `g8.api.call("get_programmatic_workspace_programmatic_campaigns__campaign_id__workspace_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+The full workspace: source, template settings, lifecycle state, page summary,
+and the valid row and bulk actions. FREE.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Programmatic campaign id. |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.programmaticPages.getProgrammaticWorkspace({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-importprogrammaticsitemap"></a>
+
+### `g8.api.programmaticPages.importProgrammaticSitemap(input)`
+
+**Import Programmatic Sitemap**
+
+- HTTP: `POST /api/v1/programmatic-campaigns/{campaign_id}/imports/sitemap`
+- operationId: `import_programmatic_sitemap_programmatic_campaigns__campaign_id__imports_sitemap_post` (also callable as `g8.api.call("import_programmatic_sitemap_programmatic_campaigns__campaign_id__imports_sitemap_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Make an existing sitemap the campaign's data source. FREE.
+
+Up to `max_urls` URLs become rows of a new source table; `fetch_pages`
+also fetches each page. REPLACES the campaign's current source.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Programmatic campaign id. |
+| `body` | `ProgrammaticSitemapImportRequest` | yes | Request body; fields below. |
+
+Body fields (`ProgrammaticSitemapImportRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.sitemap_url` | `string` | yes |  |
+| `body.fetch_pages` | `boolean` | no | default `false` |
+| `body.max_urls` | `integer` | no | default `250` |
+| `body.source_name` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.programmaticPages.importProgrammaticSitemap({
+  path: { campaign_id: "id" },
+  body: { sitemap_url: "https://example.com" },
+});
+```
+
+---
+
+<a id="op-listprogrammaticcampaigns"></a>
+
+### `g8.api.programmaticPages.listProgrammaticCampaigns(input?)`
+
+**List Programmatic Campaigns**
+
+- HTTP: `GET /api/v1/programmatic-campaigns`
+- operationId: `list_programmatic_campaigns_programmatic_campaigns_get` (also callable as `g8.api.call("list_programmatic_campaigns_programmatic_campaigns_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Every programmatic campaign in the org, with its generation counters. FREE.
+
+**Input**: none.
+
+**Returns** `ApiResponse_StudioContentListPayload_`: the envelope `{ data: StudioContentListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`StudioContentListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.programmaticPages.listProgrammaticCampaigns();
+```
+
+---
+
+<a id="op-listprogrammaticgeneratedpages"></a>
+
+### `g8.api.programmaticPages.listProgrammaticGeneratedPages(input)`
+
+**List Programmatic Generated Pages**
+
+- HTTP: `GET /api/v1/programmatic-campaigns/{campaign_id}/pages`
+- operationId: `list_programmatic_generated_pages_programmatic_campaigns__campaign_id__pages_get` (also callable as `g8.api.call("list_programmatic_generated_pages_programmatic_campaigns__campaign_id__pages_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+The generated pages, a page of results at a time. FREE.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Programmatic campaign id. |
+| `query.offset` | `integer` | no | default `0` |
+| `query.limit` | `integer` | no | default `50` |
+
+**Returns** `ApiResponse_StudioContentListPayload_`: the envelope `{ data: StudioContentListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`StudioContentListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.programmaticPages.listProgrammaticGeneratedPages({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-previewprogrammaticpage"></a>
+
+### `g8.api.programmaticPages.previewProgrammaticPage(input)`
+
+**Preview Programmatic Page**
+
+- HTTP: `POST /api/v1/programmatic-campaigns/{campaign_id}/preview`
+- operationId: `preview_programmatic_page_programmatic_campaigns__campaign_id__preview_post` (also callable as `g8.api.call("preview_programmatic_page_programmatic_campaigns__campaign_id__preview_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Render ONE page for one source row, without saving it. FREE.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Programmatic campaign id. |
+| `body` | `ProgrammaticPreviewRequest` | yes | Request body; fields below. |
+
+Body fields (`ProgrammaticPreviewRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.contact_id` | `integer \| null` | no |  |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.programmaticPages.previewProgrammaticPage({ path: { campaign_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-runprogrammaticbulkpageaction"></a>
+
+### `g8.api.programmaticPages.runProgrammaticBulkPageAction(input)`
+
+**Run Programmatic Bulk Page Action**
+
+- HTTP: `POST /api/v1/programmatic-campaigns/{campaign_id}/pages/actions`
+- operationId: `run_programmatic_bulk_page_action_programmatic_campaigns__campaign_id__pages_actions_post` (also callable as `g8.api.call("run_programmatic_bulk_page_action_programmatic_campaigns__campaign_id__pages_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: `campaigns:run`
+
+Run a lifecycle action on selected pages - or deploy. CAN CHANGE THE LIVE SITE.
+
+`deploy_pending_changes`, `republish_all`, `rollback_publish` and
+`unpublish_selected` change what real visitors see; `delete_selected`
+removes pages. `export_urls` only reads.
+
+Spends nothing.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Programmatic campaign id. |
+| `body` | `ProgrammaticBulkPageActionRequest` | yes | Request body; fields below. |
+
+Body fields (`ProgrammaticBulkPageActionRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.action` | `"mark_ready_to_deploy_selected" \| "unpublish_selected" \| "mark_for_regeneration_selected" \| "deploy_pending_changes" \| "republish_all" \| "rollback_publish" \| "queue_search_console" \| "delete_selected" \| …` | yes |  |
+| `body.page_ids` | `Array<string> \| null` | no |  |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `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.programmaticPages.runProgrammaticBulkPageAction({
+  path: { campaign_id: "id" },
+  body: { action: "mark_ready_to_deploy_selected" },
+});
+```
+
+---
+
+<a id="op-runprogrammaticpageaction"></a>
+
+### `g8.api.programmaticPages.runProgrammaticPageAction(input)`
+
+**Run Programmatic Page Action**
+
+- HTTP: `POST /api/v1/programmatic-campaigns/{campaign_id}/pages/{page_id}/actions`
+- operationId: `run_programmatic_page_action_programmatic_campaigns__campaign_id__pages__page_id__actions_post` (also callable as `g8.api.call("run_programmatic_page_action_programmatic_campaigns__campaign_id__pages__page_id__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: `campaigns:run`
+
+Run a lifecycle action on one page. `unpublish` takes it OFF the live site.
+
+`override` replaces the page's rendered HTML with `html_output` (sanitised by
+the app); `reset_override` returns it to the template.
+
+Spends nothing.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Programmatic campaign id. |
+| `path.page_id` | `string` | yes | Generated page id, from `GET .../pages`. |
+| `body` | `ProgrammaticPageActionRequest` | yes | Request body; fields below. |
+
+Body fields (`ProgrammaticPageActionRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.action` | `"mark_ready_to_deploy" \| "unpublish" \| "mark_for_regeneration" \| "override" \| "reset_override" \| "publish" \| "regenerate"` | yes |  |
+| `body.html_output` | `string \| null` | no |  |
+| `body.manual_override` | `Record<string, unknown> \| null` | no |  |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `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.programmaticPages.runProgrammaticPageAction({
+  path: { campaign_id: "id", page_id: "id" },
+  body: { action: "mark_ready_to_deploy" },
+});
+```
+
+---
+
+<a id="op-startprogrammaticgeneration"></a>
+
+### `g8.api.programmaticPages.startProgrammaticGeneration(input)`
+
+**Start Programmatic Generation**
+
+- HTTP: `POST /api/v1/programmatic-campaigns/{campaign_id}/generate`
+- operationId: `start_programmatic_generation_programmatic_campaigns__campaign_id__generate_post` (also callable as `g8.api.call("start_programmatic_generation_programmatic_campaigns__campaign_id__generate_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Render every page, one per source row, in the background. FREE - no model runs.
+
+Pages are generated as drafts; nothing goes live until a deploy action.
+400 if a run is already in progress or the source is empty. Poll
+`GET /{campaign_id}/status`.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Programmatic campaign id. |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.programmaticPages.startProgrammaticGeneration({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-updateprogrammaticcampaign"></a>
+
+### `g8.api.programmaticPages.updateProgrammaticCampaign(input)`
+
+**Update Programmatic Campaign**
+
+- HTTP: `PATCH /api/v1/programmatic-campaigns/{campaign_id}`
+- operationId: `update_programmatic_campaign_programmatic_campaigns__campaign_id__patch` (also callable as `g8.api.call("update_programmatic_campaign_programmatic_campaigns__campaign_id__patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Partial update. FREE. A source or template change marks the pages stale.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Programmatic campaign id. |
+| `body` | `UpdateProgrammaticCampaignRequest` | yes | Request body; fields below. |
+
+Body fields (`UpdateProgrammaticCampaignRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.data_source_id` | `string \| null` | no |  |
+| `body.data_source_name` | `string \| null` | no |  |
+| `body.data_source_type` | `"list" \| "workbench" \| "csv" \| "seo_import" \| null` | no |  |
+| `body.list_id` | `integer \| null` | no |  |
+| `body.name` | `string \| null` | no |  |
+| `body.settings` | `Record<string, unknown> \| null` | no |  |
+| `body.slug_template` | `string \| null` | no |  |
+| `body.variable_config` | `Array<Record<string, unknown>> \| null` | no |  |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.programmaticPages.updateProgrammaticCampaign({ path: { campaign_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-updateprogrammaticworkspace"></a>
+
+### `g8.api.programmaticPages.updateProgrammaticWorkspace(input)`
+
+**Update Programmatic Workspace**
+
+- HTTP: `PATCH /api/v1/programmatic-campaigns/{campaign_id}/workspace`
+- operationId: `update_programmatic_workspace_programmatic_campaigns__campaign_id__workspace_patch` (also callable as `g8.api.call("update_programmatic_workspace_programmatic_campaigns__campaign_id__workspace_patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Update workspace settings - source, SEO, linking, deployment, regeneration. FREE.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Programmatic campaign id. |
+| `body` | `ProgrammaticWorkspaceUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`ProgrammaticWorkspaceUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.data_source_id` | `string \| null` | no |  |
+| `body.data_source_name` | `string \| null` | no |  |
+| `body.data_source_type` | `"list" \| "workbench" \| "csv" \| "seo_import" \| null` | no |  |
+| `body.list_id` | `integer \| null` | no |  |
+| `body.settings` | `Record<string, unknown> \| null` | no |  |
+| `body.slug_template` | `string \| null` | no |  |
+| `body.variable_config` | `Array<Record<string, unknown>> \| null` | no |  |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.programmaticPages.updateProgrammaticWorkspace({ path: { campaign_id: "id" }, body: {} });
+```