@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/campaigns.d.ts

@@ -0,0 +1,721 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.campaigns` (Campaigns): 29 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"accept_audience_pipeline_filters_campaigns__campaign_id__audience_pipeline_accept_filters_post">;
+ *
+ * Reference with examples: campaigns.md
+ */
+/* eslint-disable */
+
+/** `g8.api.campaigns.<member>` -> the operationId it calls. */
+export interface CampaignsMembers {
+  acceptAudiencePipelineFilters: "accept_audience_pipeline_filters_campaigns__campaign_id__audience_pipeline_accept_filters_post";
+  archiveCampaignIdea: "archive_campaign_idea_campaigns_ideas__idea_id__archive_post";
+  createManualCampaignIdea: "create_manual_campaign_idea_campaigns_ideas_manual_post";
+  deleteCampaign: "delete_campaign_campaigns__campaign_id__delete";
+  deleteCampaignIdea: "delete_campaign_idea_campaigns_ideas__idea_id__delete";
+  generateCampaignIdeas: "generate_campaign_ideas_campaigns_generate_ideas_post";
+  generateCampaignIdeasAsync: "generate_campaign_ideas_async_campaigns_generate_ideas_async_post";
+  generateCampaignStepContent: "generate_campaign_step_content_campaigns__campaign_id__sequence_steps__step_id__generate_post";
+  getAudiencePipelineStatus: "get_audience_pipeline_status_campaigns__campaign_id__audience_pipeline_status_get";
+  getAudiencePipelineSuggestedFilters: "get_audience_pipeline_suggested_filters_campaigns__campaign_id__audience_pipeline_suggested_filters_get";
+  getCampaignDashboard: "get_campaign_dashboard_campaigns__campaign_id__dashboard_get";
+  getCampaignGeneratedFile: "get_campaign_generated_file_campaigns__campaign_id__files__file_type__get";
+  getCampaignGenerationOptions: "get_campaign_generation_options_campaigns_generation_options_get";
+  getCampaignGenerationStatus: "get_campaign_generation_status_campaigns__campaign_id__status_get";
+  getCampaignIdeasTaskStatus: "get_campaign_ideas_task_status_campaigns_ideas_status__task_id__get";
+  linkLandingPageToCampaign: "link_landing_page_to_campaign_campaigns__campaign_id__landing_pages_post";
+  listCampaignAudienceListOptions: "list_campaign_audience_list_options_campaigns_audience_lists_options_get";
+  listCampaignGeneratedFiles: "list_campaign_generated_files_campaigns__campaign_id__files_get";
+  listCampaignLandingPages: "list_campaign_landing_pages_campaigns__campaign_id__landing_pages_get";
+  listCampaignsForPicker: "list_campaigns_for_picker_campaigns_picker_get";
+  previewCampaignAudienceProfile: "preview_campaign_audience_profile_campaigns_audience_profile_preview_post";
+  previewCampaignDocumentManifest: "preview_campaign_document_manifest_campaigns_document_manifest_preview_post";
+  recommendCampaignPersonas: "recommend_campaign_personas_campaigns_recommend_personas_post";
+  regenerateCampaignDocument: "regenerate_campaign_document_campaigns__campaign_id__documents__document_id__regenerate_post";
+  suggestCampaignConcepts: "suggest_campaign_concepts_campaigns_suggest_post";
+  toggleCampaignIdeaFavorite: "toggle_campaign_idea_favorite_campaigns_ideas__idea_id__favorite_post";
+  triggerAudiencePipeline: "trigger_audience_pipeline_campaigns__campaign_id__audience_pipeline_trigger_post";
+  unlinkLandingPageFromCampaign: "unlink_landing_page_from_campaign_campaigns__campaign_id__landing_pages__landing_page_id__delete";
+  updateCampaignIdea: "update_campaign_idea_campaigns_ideas__idea_id__patch";
+}
+
+/** Input and output of every `g8.api.campaigns` operation, keyed by operationId. */
+export interface CampaignsOperations {
+  /**
+   * POST /campaigns/{campaign_id}/audience-pipeline/accept-filters
+   * Accept Audience Pipeline Filters
+   * tier: billable · scope: campaigns:run
+   */
+  accept_audience_pipeline_filters_campaigns__campaign_id__audience_pipeline_accept_filters_post: {
+    input: {
+    path: {
+      /** Campaign id or slug; resolved inside the key's organisation. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: AudiencePipelineAcceptFiltersRequest;
+  };
+    output: ApiResponse_AudiencePipelineAcceptResult_;
+  };
+  /**
+   * POST /campaigns/ideas/{idea_id}/archive
+   * Archive Campaign Idea
+   * tier: write · scope: campaigns:write
+   */
+  archive_campaign_idea_campaigns_ideas__idea_id__archive_post: {
+    input: {
+    path: {
+      /** Campaign idea id. */
+      idea_id: string;
+    };
+    query?: {
+      /** Why it was archived. */
+      reason?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /campaigns/ideas/manual
+   * Create Manual Campaign Idea
+   * tier: write · scope: campaigns:write
+   */
+  create_manual_campaign_idea_campaigns_ideas_manual_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: Record<string, unknown>;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * DELETE /campaigns/{campaign_id}
+   * Delete Campaign
+   * tier: destructive · scope: campaigns:delete
+   */
+  delete_campaign_campaigns__campaign_id__delete: {
+    input: {
+    path: {
+      /** Campaign id or slug. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * DELETE /campaigns/ideas/{idea_id}
+   * Delete Campaign Idea
+   * tier: destructive · scope: campaigns:delete
+   */
+  delete_campaign_idea_campaigns_ideas__idea_id__delete: {
+    input: {
+    path: {
+      /** Campaign idea id. */
+      idea_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /campaigns/generate-ideas
+   * Generate Campaign Ideas
+   * tier: billable · scope: campaigns:run
+   */
+  generate_campaign_ideas_campaigns_generate_ideas_post: {
+    input: {
+    query?: {
+      /** How many ideas. Scales the spend. */
+      num_ideas?: number;
+      /** Free-text steer for the generator. */
+      user_direction?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SuggestCampaignsRequest;
+  };
+    output: ApiResponse_StudioContentListPayload_;
+  };
+  /**
+   * POST /campaigns/generate-ideas-async
+   * Generate Campaign Ideas Async
+   * tier: billable · scope: campaigns:run
+   */
+  generate_campaign_ideas_async_campaigns_generate_ideas_async_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: AsyncGenerateIdeasRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /campaigns/{campaign_id}/sequence/steps/{step_id}/generate
+   * Generate Campaign Step Content
+   * tier: billable · scope: campaigns:run
+   */
+  generate_campaign_step_content_campaigns__campaign_id__sequence_steps__step_id__generate_post: {
+    input: {
+    path: {
+      /** Campaign id or slug. */
+      campaign_id: string;
+      /** Sequence step id, from `GET /campaigns/{campaign_id}/sequence`. */
+      step_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * GET /campaigns/{campaign_id}/audience-pipeline/status
+   * Get Audience Pipeline Status
+   * tier: read · scope: campaigns:read
+   */
+  get_audience_pipeline_status_campaigns__campaign_id__audience_pipeline_status_get: {
+    input: {
+    path: {
+      /** Campaign id or slug; resolved inside the key's organisation. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_AudiencePipelineStatus_;
+  };
+  /**
+   * GET /campaigns/{campaign_id}/audience-pipeline/suggested-filters
+   * Get Audience Pipeline Suggested Filters
+   * tier: read · scope: campaigns:read
+   */
+  get_audience_pipeline_suggested_filters_campaigns__campaign_id__audience_pipeline_suggested_filters_get: {
+    input: {
+    path: {
+      /** Campaign id or slug; resolved inside the key's organisation. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_AudiencePipelineSuggestedFilters_;
+  };
+  /**
+   * GET /campaigns/{campaign_id}/dashboard
+   * Get Campaign Dashboard
+   * tier: billable · scope: campaigns:run
+   */
+  get_campaign_dashboard_campaigns__campaign_id__dashboard_get: {
+    input: {
+    path: {
+      /** Campaign id or slug. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * GET /campaigns/{campaign_id}/files/{file_type}
+   * Get Campaign Generated File
+   * tier: read · scope: campaigns:read
+   */
+  get_campaign_generated_file_campaigns__campaign_id__files__file_type__get: {
+    input: {
+    path: {
+      /** Campaign id or slug. */
+      campaign_id: string;
+      /** A file type from `GET /campaigns/{campaign_id}/files`. */
+      file_type: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * GET /campaigns/generation-options
+   * Get Campaign Generation Options
+   * tier: read · scope: campaigns:read
+   */
+  get_campaign_generation_options_campaigns_generation_options_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * GET /campaigns/{campaign_id}/status
+   * Get Campaign Generation Status
+   * tier: read · scope: campaigns:read
+   */
+  get_campaign_generation_status_campaigns__campaign_id__status_get: {
+    input: {
+    path: {
+      /** Campaign id or slug. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * GET /campaigns/ideas/status/{task_id}
+   * Get Campaign Ideas Task Status
+   * tier: read · scope: campaigns:read
+   */
+  get_campaign_ideas_task_status_campaigns_ideas_status__task_id__get: {
+    input: {
+    path: {
+      /** Task id returned by `POST /campaigns/generate-ideas-async`. */
+      task_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /campaigns/{campaign_id}/landing-pages
+   * Link Landing Page To Campaign
+   * tier: write · scope: campaigns:write
+   */
+  link_landing_page_to_campaign_campaigns__campaign_id__landing_pages_post: {
+    input: {
+    path: {
+      /** Campaign id or slug. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: LinkLandingPageRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * GET /campaigns/audience-lists/options
+   * List Campaign Audience List Options
+   * tier: read · scope: campaigns:read
+   */
+  list_campaign_audience_list_options_campaigns_audience_lists_options_get: {
+    input: {
+    query?: {
+      /** Substring match on the list name. */
+      search?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentListPayload_;
+  };
+  /**
+   * GET /campaigns/{campaign_id}/files
+   * List Campaign Generated Files
+   * tier: read · scope: campaigns:read
+   */
+  list_campaign_generated_files_campaigns__campaign_id__files_get: {
+    input: {
+    path: {
+      /** Campaign id or slug. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentListPayload_;
+  };
+  /**
+   * GET /campaigns/{campaign_id}/landing-pages
+   * List Campaign Landing Pages
+   * tier: read · scope: campaigns:read
+   */
+  list_campaign_landing_pages_campaigns__campaign_id__landing_pages_get: {
+    input: {
+    path: {
+      /** Campaign id or slug. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentListPayload_;
+  };
+  /**
+   * GET /campaigns/picker
+   * List Campaigns For Picker
+   * tier: read · scope: campaigns:read
+   */
+  list_campaigns_for_picker_campaigns_picker_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentListPayload_;
+  };
+  /**
+   * POST /campaigns/audience-profile/preview
+   * Preview Campaign Audience Profile
+   * tier: read · scope: campaigns:read
+   */
+  preview_campaign_audience_profile_campaigns_audience_profile_preview_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: AudienceProfilePreviewRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /campaigns/document-manifest/preview
+   * Preview Campaign Document Manifest
+   * tier: read · scope: campaigns:read
+   */
+  preview_campaign_document_manifest_campaigns_document_manifest_preview_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CampaignDocumentManifestRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /campaigns/recommend-personas
+   * Recommend Campaign Personas
+   * tier: billable · scope: campaigns:run
+   */
+  recommend_campaign_personas_campaigns_recommend_personas_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: PersonaRecommendationRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /campaigns/{campaign_id}/documents/{document_id}/regenerate
+   * Regenerate Campaign Document
+   * tier: billable · scope: campaigns:run
+   */
+  regenerate_campaign_document_campaigns__campaign_id__documents__document_id__regenerate_post: {
+    input: {
+    path: {
+      /** Campaign id or slug. */
+      campaign_id: string;
+      /** Campaign document id. */
+      document_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /campaigns/suggest
+   * Suggest Campaign Concepts
+   * tier: read · scope: campaigns:read
+   */
+  suggest_campaign_concepts_campaigns_suggest_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SuggestCampaignsRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /campaigns/ideas/{idea_id}/favorite
+   * Toggle Campaign Idea Favorite
+   * tier: write · scope: campaigns:write
+   */
+  toggle_campaign_idea_favorite_campaigns_ideas__idea_id__favorite_post: {
+    input: {
+    path: {
+      /** Campaign idea id. */
+      idea_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /campaigns/{campaign_id}/audience-pipeline/trigger
+   * Trigger Audience Pipeline
+   * tier: billable · scope: campaigns:run
+   */
+  trigger_audience_pipeline_campaigns__campaign_id__audience_pipeline_trigger_post: {
+    input: {
+    path: {
+      /** Campaign id or slug; resolved inside the key's organisation. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_AudiencePipelineTriggerResult_;
+  };
+  /**
+   * DELETE /campaigns/{campaign_id}/landing-pages/{landing_page_id}
+   * Unlink Landing Page From Campaign
+   * tier: destructive · scope: campaigns:delete
+   */
+  unlink_landing_page_from_campaign_campaigns__campaign_id__landing_pages__landing_page_id__delete: {
+    input: {
+    path: {
+      /** Campaign id or slug. */
+      campaign_id: string;
+      /** The landing page to detach. */
+      landing_page_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * PATCH /campaigns/ideas/{idea_id}
+   * Update Campaign Idea
+   * tier: write · scope: campaigns:write
+   */
+  update_campaign_idea_campaigns_ideas__idea_id__patch: {
+    input: {
+    path: {
+      /** Campaign idea id. */
+      idea_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: Record<string, unknown>;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+}
+
+// 20 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_AudiencePipelineAcceptResult_ {
+  data: AudiencePipelineAcceptResult;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_AudiencePipelineStatus_ {
+  data: AudiencePipelineStatus;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_AudiencePipelineSuggestedFilters_ {
+  data: AudiencePipelineSuggestedFilters;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_AudiencePipelineTriggerResult_ {
+  data: AudiencePipelineTriggerResult;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_StudioContentListPayload_ {
+  data: StudioContentListPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_StudioContentPayload_ {
+  data: StudioContentPayload;
+  pagination?: PaginationMeta | null;
+}
+
+/**
+ * The same generation, run in the background. SPENDS CREDIT.
+ *
+ * Returns a task id immediately. `num_ideas` is the cost multiplier.
+ */
+export interface AsyncGenerateIdeasRequest {
+  audience_list_id?: number | null;
+  audience_source?: string | null;
+  campaign_goal: string;
+  campaign_type?: string | null;
+  execution_targets?: Array<string> | null;
+  /** How many ideas to generate. Scales the spend. */
+  num_ideas?: number | null;
+  /** Ignored for tenancy. The organisation is the API key's own. */
+  organization_id: string;
+  persona_mode?: string | null;
+  preferred_channels?: Array<string> | null;
+  target_personas?: Array<string> | null;
+  user_direction?: string | null;
+  website_url: string;
+}
+
+/**
+ * Mirrors `AcceptFiltersRequest`.
+ *
+ * `run_pipeline` defaults to TRUE: accepting filters normally STARTS the run,
+ * which builds a list and can start a credit-spending enrichment. Send
+ * `false` to only save the filters.
+ */
+export interface AudiencePipelineAcceptFiltersRequest {
+  filters: Array<Record<string, unknown>>;
+  /** Custom list name (defaults to '{campaign_name} Audience') */
+  list_name?: string | null;
+  run_pipeline?: boolean;
+}
+
+/**
+ * The app's answer to accepting filters: `status` is `filters_saved` when
+ * `run_pipeline` was false, `pipeline_started` (with a `chain_id`) otherwise.
+ */
+export interface AudiencePipelineAcceptResult {
+  campaign_id: string;
+  chain_id?: string | null;
+  status: string;
+}
+
+/**
+ * Mirrors `AudiencePipelineStatusResponse`. Where the pipeline is, and what
+ * it has produced so far.
+ */
+export interface AudiencePipelineStatus {
+  completed_at?: string | null;
+  enrichment_job_id?: string | null;
+  error?: string | null;
+  keyword_ids?: Array<string> | null;
+  list_id?: string | null;
+  /** Pipeline state: idle | suggested | extracting_filters | creating_list | provisioning_keywords | checking_enrichment | enriching | completed | failed */
+  pipeline_status?: string;
+  started_at?: string | null;
+  suggested_filters?: Array<Record<string, unknown>> | null;
+  /** Pre-filled list name based on campaign name */
+  suggested_list_name?: string | null;
+  total_contacts?: number;
+}
+
+/**
+ * Mirrors `SuggestedFiltersResponse`. The targeting filters the pipeline
+ * would build the list from, and where they came from.
+ */
+export interface AudiencePipelineSuggestedFilters {
+  filters: Array<Record<string, unknown>>;
+  /** Where filters came from: user_modified | targeting_doc */
+  source: string;
+  /** Pre-filled list name based on campaign name */
+  suggested_list_name?: string | null;
+}
+
+/** The app's answer to a trigger: `{"status": "started", "chain_id": ..., "campaign_id": ...}`. */
+export interface AudiencePipelineTriggerResult {
+  campaign_id: string;
+  chain_id?: string | null;
+  status: string;
+}
+
+/** Profile an audience list. Spends nothing. */
+export interface AudienceProfilePreviewRequest {
+  audience_id: number;
+}
+
+/** Preview which documents a campaign would generate. Spends nothing. */
+export interface CampaignDocumentManifestRequest {
+  audience_source?: string | null;
+  campaign_focus?: string | null;
+  channels: Array<string>;
+  execution_targets?: Array<string> | null;
+}
+
+/** Attach an existing landing page to a campaign. Spends nothing. */
+export interface LinkLandingPageRequest {
+  landing_page_id: string;
+}
+
+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;
+}
+
+/**
+ * Recommend target personas from the company's own data. SPENDS CREDIT.
+ *
+ * `organization_id` is IGNORED - the org always comes from the key. It is
+ * mirrored because the app's model carries it, and dropping a field a caller
+ * sends would be a silent 422 on a body Studio itself produces.
+ */
+export interface PersonaRecommendationRequest {
+  /** Ignored. The organisation is the API key's own. */
+  organization_id?: string | null;
+  website_url: string;
+}
+
+/**
+ * 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>;
+
+/** Generate campaign ideas from a goal. SPENDS CREDIT. */
+export interface SuggestCampaignsRequest {
+  campaign_goal: string;
+  campaign_type?: string | null;
+  /** Ignored. The organisation is the API key's own. */
+  organization_id?: string | null;
+  target_persona?: string | null;
+  website_url: string;
+}