@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/websiteEditor.d.ts

@@ -0,0 +1,324 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.websiteEditor` (Website Editor): 12 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"apply_website_page_operations_website_editor_pages__page_id__ops_post">;
+ *
+ * Reference with examples: websiteEditor.md
+ */
+/* eslint-disable */
+
+/** `g8.api.websiteEditor.<member>` -> the operationId it calls. */
+export interface WebsiteEditorMembers {
+  applyWebsitePageOperations: "apply_website_page_operations_website_editor_pages__page_id__ops_post";
+  cloneWebsitePage: "clone_website_page_website_editor_pages__page_id__clone_post";
+  connectWebsiteHosting: "connect_website_hosting_website_editor_connect_post";
+  disconnectWebsiteHosting: "disconnect_website_hosting_website_editor_disconnect_delete";
+  getWebsiteHostingConnection: "get_website_hosting_connection_website_editor_connection_get";
+  getWebsitePageConversation: "get_website_page_conversation_website_editor_pages__page_id__conversation_get";
+  listWebsiteHostingProjects: "list_website_hosting_projects_website_editor_projects_get";
+  listWebsitePageVersions: "list_website_page_versions_website_editor_pages__page_id__versions_get";
+  publishWebsitePages: "publish_website_pages_website_editor_publish_post";
+  restoreWebsitePageVersion: "restore_website_page_version_website_editor_pages__page_id__restore_version_post";
+  syncWebsitePages: "sync_website_pages_website_editor_sync_post";
+  updateWebsitePageText: "update_website_page_text_website_editor_pages__page_id__update_text_post";
+}
+
+/** Input and output of every `g8.api.websiteEditor` operation, keyed by operationId. */
+export interface WebsiteEditorOperations {
+  /**
+   * POST /website-editor/pages/{page_id}/ops
+   * Apply Website Page Operations
+   * tier: write · scope: campaigns:write
+   */
+  apply_website_page_operations_website_editor_pages__page_id__ops_post: {
+    input: {
+    path: {
+      /** Website page id, from `GET /content-workspace/pages`. */
+      page_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: WebsiteEditorPageOpsRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /website-editor/pages/{page_id}/clone
+   * Clone Website Page
+   * tier: write · scope: campaigns:write
+   */
+  clone_website_page_website_editor_pages__page_id__clone_post: {
+    input: {
+    path: {
+      /** Website page id, from `GET /content-workspace/pages`. */
+      page_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /website-editor/connect
+   * Connect Website Hosting
+   * tier: write · scope: campaigns:write
+   */
+  connect_website_hosting_website_editor_connect_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: WebsiteEditorConnectRequest;
+  };
+    output: ApiResponse_WebsiteEditorConnection_;
+  };
+  /**
+   * DELETE /website-editor/disconnect
+   * Disconnect Website Hosting
+   * tier: destructive · scope: campaigns:delete
+   */
+  disconnect_website_hosting_website_editor_disconnect_delete: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * GET /website-editor/connection
+   * Get Website Hosting Connection
+   * tier: read · scope: campaigns:read
+   */
+  get_website_hosting_connection_website_editor_connection_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_WebsiteEditorConnection_;
+  };
+  /**
+   * GET /website-editor/pages/{page_id}/conversation
+   * Get Website Page Conversation
+   * tier: read · scope: campaigns:read
+   */
+  get_website_page_conversation_website_editor_pages__page_id__conversation_get: {
+    input: {
+    path: {
+      /** Website page id, from `GET /content-workspace/pages`. */
+      page_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * GET /website-editor/projects
+   * List Website Hosting Projects
+   * tier: read · scope: campaigns:read
+   */
+  list_website_hosting_projects_website_editor_projects_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentListPayload_;
+  };
+  /**
+   * GET /website-editor/pages/{page_id}/versions
+   * List Website Page Versions
+   * tier: read · scope: campaigns:read
+   */
+  list_website_page_versions_website_editor_pages__page_id__versions_get: {
+    input: {
+    path: {
+      /** Website page id, from `GET /content-workspace/pages`. */
+      page_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentListPayload_;
+  };
+  /**
+   * POST /website-editor/publish
+   * Publish Website Pages
+   * tier: external · scope: campaigns:run
+   */
+  publish_website_pages_website_editor_publish_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: WebsiteEditorPublishRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /website-editor/pages/{page_id}/restore-version
+   * Restore Website Page Version
+   * tier: write · scope: campaigns:write
+   */
+  restore_website_page_version_website_editor_pages__page_id__restore_version_post: {
+    input: {
+    path: {
+      /** Website page id, from `GET /content-workspace/pages`. */
+      page_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: WebsiteEditorRestoreVersionRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /website-editor/sync
+   * Sync Website Pages
+   * tier: external · scope: campaigns:run
+   */
+  sync_website_pages_website_editor_sync_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: WebsiteEditorSyncRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /website-editor/pages/{page_id}/update-text
+   * Update Website Page Text
+   * tier: write · scope: campaigns:write
+   */
+  update_website_page_text_website_editor_pages__page_id__update_text_post: {
+    input: {
+    path: {
+      /** Website page id, from `GET /content-workspace/pages`. */
+      page_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: WebsiteEditorUpdateTextRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+}
+
+// 13 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;
+}
+
+export interface ApiResponse_WebsiteEditorConnection_ {
+  data: WebsiteEditorConnection;
+  pagination?: PaginationMeta | 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 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>;
+
+/** Connect the org's website hosting account. The token is write-only. */
+export interface WebsiteEditorConnectRequest {
+  /** The hosting provider's account id. */
+  account_id: string;
+  /** An API token for that account. Never returned. */
+  api_token: string;
+  /** The site project to edit and publish. */
+  project_name?: string | null;
+}
+
+/** The hosting connection, without its credential. */
+export interface WebsiteEditorConnection {
+  account_id?: string | null;
+  connected: boolean;
+  created_at?: string | null;
+  id?: string | null;
+  last_synced_at?: string | null;
+  project_name?: string | null;
+  /** connected, syncing or error. */
+  status?: string | null;
+  updated_at?: string | null;
+}
+
+/** Ordered deterministic edit operations on one page. */
+export interface WebsiteEditorPageOpsRequest {
+  /** Your copy's version, for conflict detection. */
+  base_version?: number | null;
+  /** A human-readable note stored on the version. */
+  instruction?: string | null;
+  /** Ordered edit operations. */
+  ops: Array<Record<string, unknown>>;
+  save_mode?: "autosave" | "save";
+}
+
+/** Which pages to publish. Omit `page_ids` for every page with HTML. */
+export interface WebsiteEditorPublishRequest {
+  page_ids?: Array<string> | null;
+}
+
+/** Which saved version to restore. */
+export interface WebsiteEditorRestoreVersionRequest {
+  version_num: number;
+}
+
+/** Pull pages from a hosted site project. */
+export interface WebsiteEditorSyncRequest {
+  /** Only these paths. Omit for every page. */
+  paths?: Array<string> | null;
+  /** From `GET /website-editor/projects`. */
+  project_name: string;
+}
+
+/** Set one element's text. No model runs. */
+export interface WebsiteEditorUpdateTextRequest {
+  /** The element's `data-g8-id`. */
+  element_id: string;
+  new_text: string;
+}