@graph8/sdk 0.251.0 → 0.262.0

package/docs/api/programmaticPages.d.ts

@@ -0,0 +1,400 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.programmaticPages` (Programmatic Pages): 15 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"create_programmatic_campaign_programmatic_campaigns_post">;
+ *
+ * Reference with examples: programmaticPages.md
+ */
+/* eslint-disable */
+
+/** `g8.api.programmaticPages.<member>` -> the operationId it calls. */
+export interface ProgrammaticPagesMembers {
+  createProgrammaticCampaign: "create_programmatic_campaign_programmatic_campaigns_post";
+  deleteProgrammaticCampaign: "delete_programmatic_campaign_programmatic_campaigns__campaign_id__delete";
+  getProgrammaticCampaign: "get_programmatic_campaign_programmatic_campaigns__campaign_id__get";
+  getProgrammaticCampaignVariables: "get_programmatic_campaign_variables_programmatic_campaigns__campaign_id__variables_get";
+  getProgrammaticGenerationStatus: "get_programmatic_generation_status_programmatic_campaigns__campaign_id__status_get";
+  getProgrammaticWorkspace: "get_programmatic_workspace_programmatic_campaigns__campaign_id__workspace_get";
+  importProgrammaticSitemap: "import_programmatic_sitemap_programmatic_campaigns__campaign_id__imports_sitemap_post";
+  listProgrammaticCampaigns: "list_programmatic_campaigns_programmatic_campaigns_get";
+  listProgrammaticGeneratedPages: "list_programmatic_generated_pages_programmatic_campaigns__campaign_id__pages_get";
+  previewProgrammaticPage: "preview_programmatic_page_programmatic_campaigns__campaign_id__preview_post";
+  runProgrammaticBulkPageAction: "run_programmatic_bulk_page_action_programmatic_campaigns__campaign_id__pages_actions_post";
+  runProgrammaticPageAction: "run_programmatic_page_action_programmatic_campaigns__campaign_id__pages__page_id__actions_post";
+  startProgrammaticGeneration: "start_programmatic_generation_programmatic_campaigns__campaign_id__generate_post";
+  updateProgrammaticCampaign: "update_programmatic_campaign_programmatic_campaigns__campaign_id__patch";
+  updateProgrammaticWorkspace: "update_programmatic_workspace_programmatic_campaigns__campaign_id__workspace_patch";
+}
+
+/** Input and output of every `g8.api.programmaticPages` operation, keyed by operationId. */
+export interface ProgrammaticPagesOperations {
+  /**
+   * POST /programmatic-campaigns
+   * Create Programmatic Campaign
+   * tier: write · scope: campaigns:write
+   */
+  create_programmatic_campaign_programmatic_campaigns_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CreateProgrammaticCampaignRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * DELETE /programmatic-campaigns/{campaign_id}
+   * Delete Programmatic Campaign
+   * tier: destructive · scope: campaigns:delete
+   */
+  delete_programmatic_campaign_programmatic_campaigns__campaign_id__delete: {
+    input: {
+    path: {
+      /** Programmatic campaign id. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * GET /programmatic-campaigns/{campaign_id}
+   * Get Programmatic Campaign
+   * tier: read · scope: campaigns:read
+   */
+  get_programmatic_campaign_programmatic_campaigns__campaign_id__get: {
+    input: {
+    path: {
+      /** Programmatic campaign id. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * GET /programmatic-campaigns/{campaign_id}/variables
+   * Get Programmatic Campaign Variables
+   * tier: read · scope: campaigns:read
+   */
+  get_programmatic_campaign_variables_programmatic_campaigns__campaign_id__variables_get: {
+    input: {
+    path: {
+      /** Programmatic campaign id. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * GET /programmatic-campaigns/{campaign_id}/status
+   * Get Programmatic Generation Status
+   * tier: read · scope: campaigns:read
+   */
+  get_programmatic_generation_status_programmatic_campaigns__campaign_id__status_get: {
+    input: {
+    path: {
+      /** Programmatic campaign id. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * GET /programmatic-campaigns/{campaign_id}/workspace
+   * Get Programmatic Workspace
+   * tier: read · scope: campaigns:read
+   */
+  get_programmatic_workspace_programmatic_campaigns__campaign_id__workspace_get: {
+    input: {
+    path: {
+      /** Programmatic campaign id. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /programmatic-campaigns/{campaign_id}/imports/sitemap
+   * Import Programmatic Sitemap
+   * tier: write · scope: campaigns:write
+   */
+  import_programmatic_sitemap_programmatic_campaigns__campaign_id__imports_sitemap_post: {
+    input: {
+    path: {
+      /** Programmatic campaign id. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ProgrammaticSitemapImportRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * GET /programmatic-campaigns
+   * List Programmatic Campaigns
+   * tier: read · scope: campaigns:read
+   */
+  list_programmatic_campaigns_programmatic_campaigns_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentListPayload_;
+  };
+  /**
+   * GET /programmatic-campaigns/{campaign_id}/pages
+   * List Programmatic Generated Pages
+   * tier: read · scope: campaigns:read
+   */
+  list_programmatic_generated_pages_programmatic_campaigns__campaign_id__pages_get: {
+    input: {
+    path: {
+      /** Programmatic campaign id. */
+      campaign_id: string;
+    };
+    query?: {
+      offset?: number;
+      limit?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentListPayload_;
+  };
+  /**
+   * POST /programmatic-campaigns/{campaign_id}/preview
+   * Preview Programmatic Page
+   * tier: write · scope: campaigns:write
+   */
+  preview_programmatic_page_programmatic_campaigns__campaign_id__preview_post: {
+    input: {
+    path: {
+      /** Programmatic campaign id. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ProgrammaticPreviewRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /programmatic-campaigns/{campaign_id}/pages/actions
+   * Run Programmatic Bulk Page Action
+   * tier: external · scope: campaigns:run
+   */
+  run_programmatic_bulk_page_action_programmatic_campaigns__campaign_id__pages_actions_post: {
+    input: {
+    path: {
+      /** Programmatic campaign id. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ProgrammaticBulkPageActionRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /programmatic-campaigns/{campaign_id}/pages/{page_id}/actions
+   * Run Programmatic Page Action
+   * tier: external · scope: campaigns:run
+   */
+  run_programmatic_page_action_programmatic_campaigns__campaign_id__pages__page_id__actions_post: {
+    input: {
+    path: {
+      /** Programmatic campaign id. */
+      campaign_id: string;
+      /** Generated page id, from `GET .../pages`. */
+      page_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ProgrammaticPageActionRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /programmatic-campaigns/{campaign_id}/generate
+   * Start Programmatic Generation
+   * tier: write · scope: campaigns:write
+   */
+  start_programmatic_generation_programmatic_campaigns__campaign_id__generate_post: {
+    input: {
+    path: {
+      /** Programmatic campaign id. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * PATCH /programmatic-campaigns/{campaign_id}
+   * Update Programmatic Campaign
+   * tier: write · scope: campaigns:write
+   */
+  update_programmatic_campaign_programmatic_campaigns__campaign_id__patch: {
+    input: {
+    path: {
+      /** Programmatic campaign id. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: UpdateProgrammaticCampaignRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * PATCH /programmatic-campaigns/{campaign_id}/workspace
+   * Update Programmatic Workspace
+   * tier: write · scope: campaigns:write
+   */
+  update_programmatic_workspace_programmatic_campaigns__campaign_id__workspace_patch: {
+    input: {
+    path: {
+      /** Programmatic campaign id. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ProgrammaticWorkspaceUpdateRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+}
+
+// 12 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_StudioContentListPayload_ {
+  data: StudioContentListPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_StudioContentPayload_ {
+  data: StudioContentPayload;
+  pagination?: PaginationMeta | null;
+}
+
+/** A template landing page plus a data source: one page per source row. */
+export interface CreateProgrammaticCampaignRequest {
+  data_source_id?: string | null;
+  data_source_name?: string | null;
+  data_source_type?: "list" | "workbench" | "csv" | "seo_import";
+  list_id?: number | null;
+  name: string;
+  settings?: Record<string, unknown> | null;
+  slug_template?: string;
+  /** A landing page with HTML, from `GET /landing-pages`. */
+  template_page_id: string;
+  variable_config?: Array<Record<string, unknown>> | 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;
+}
+
+/** A lifecycle action on many generated pages (or all, for the deploy actions). */
+export interface ProgrammaticBulkPageActionRequest {
+  action: "mark_ready_to_deploy_selected" | "unpublish_selected" | "mark_for_regeneration_selected" | "deploy_pending_changes" | "republish_all" | "rollback_publish" | "queue_search_console" | "delete_selected" | "export_urls" | "publish_selected" | "regenerate_selected";
+  page_ids?: Array<string> | null;
+}
+
+/** A lifecycle action on one generated page. `publish` / `regenerate` are aliases. */
+export interface ProgrammaticPageActionRequest {
+  action: "mark_ready_to_deploy" | "unpublish" | "mark_for_regeneration" | "override" | "reset_override" | "publish" | "regenerate";
+  html_output?: string | null;
+  manual_override?: Record<string, unknown> | null;
+}
+
+/** Render one page. Omit `contact_id` for the source's first row. */
+export interface ProgrammaticPreviewRequest {
+  contact_id?: number | null;
+}
+
+/** Import an existing sitemap as the campaign's data source. */
+export interface ProgrammaticSitemapImportRequest {
+  fetch_pages?: boolean;
+  max_urls?: number;
+  sitemap_url: string;
+  source_name?: string | null;
+}
+
+/** Workspace settings: source, templating, SEO, linking, deployment, regeneration. */
+export interface ProgrammaticWorkspaceUpdateRequest {
+  data_source_id?: string | null;
+  data_source_name?: string | null;
+  data_source_type?: ("list" | "workbench" | "csv" | "seo_import") | null;
+  list_id?: number | null;
+  settings?: Record<string, unknown> | null;
+  slug_template?: string | null;
+  variable_config?: Array<Record<string, unknown>> | null;
+}
+
+/**
+ * A LIST result, open-shaped, with `items` always present.
+ *
+ * The app returns a bare list from some routes and a named key from others
+ * (`pages`, `grids`, `images`, `creatives`, `reports`, `items`). Both are
+ * published: the original key is preserved AND mirrored onto `items`, so a
+ * client can page any Studio collection the same way without a per-route
+ * lookup table.
+ */
+export interface StudioContentListPayload {
+  items?: Array<unknown>;
+  [key: string]: unknown;
+}
+
+/** One Studio object, open-shaped. See the module docstring. */
+export type StudioContentPayload = Record<string, unknown>;
+
+/** Partial update. Changing the source or template marks pages for regeneration. */
+export interface UpdateProgrammaticCampaignRequest {
+  data_source_id?: string | null;
+  data_source_name?: string | null;
+  data_source_type?: ("list" | "workbench" | "csv" | "seo_import") | null;
+  list_id?: number | null;
+  name?: string | null;
+  settings?: Record<string, unknown> | null;
+  slug_template?: string | null;
+  variable_config?: Array<Record<string, unknown>> | null;
+}