@graph8/sdk 0.245.0 → 0.260.0

package/docs/api/health.d.ts

@@ -0,0 +1,39 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.health` (health): 1 operation.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"api_health_health_get">;
+ *
+ * Reference with examples: health.md
+ */
+/* eslint-disable */
+
+/** `g8.api.health.<member>` -> the operationId it calls. */
+export interface HealthMembers {
+  apiHealth: "api_health_health_get";
+}
+
+/** Input and output of every `g8.api.health` operation, keyed by operationId. */
+export interface HealthOperations {
+  /**
+   * GET /health
+   * API health
+   * tier: read · scope: n/a
+   */
+  api_health_health_get: {
+    input: Record<string, never>;
+    output: ApiHealthResponse;
+  };
+}
+
+// 1 schema referenced above (the same as G8Contract.<Name>).
+
+export interface ApiHealthResponse {
+  /** Which service answered. Always 'developer-api'. */
+  service?: string;
+  /** Always 'ok' when the Developer API is serving requests. */
+  status?: string;
+}

package/docs/api/health.md

@@ -0,0 +1,58 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.health`: health
+
+1 operation (1 read).
+
+No hand-written client covers this area. Call it through `g8.api.health.*` 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: [health.d.ts](health.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`apiHealth`](#op-apihealth) | `GET /api/v1/health` | read |  | API health |
+
+---
+
+<a id="op-apihealth"></a>
+
+### `g8.api.health.apiHealth(input?)`
+
+**API health**
+
+- HTTP: `GET /api/v1/health`
+- operationId: `api_health_health_get` (also callable as `g8.api.call("api_health_health_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: none published
+
+Check that the graph8 Developer API is up. No API key is required.
+
+Returns ``{"status": "ok", "service": "developer-api"}`` whenever the API is
+serving requests. It does not check databases or downstream providers.
+
+**Input**: none.
+
+**Returns** `ApiHealthResponse`.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `service` | `string` | no | Which service answered. Always 'developer-api'. default `"developer-api"` |
+| `status` | `string` | no | Always 'ok' when the Developer API is serving requests. default `"ok"` |
+
+**Example**
+
+```ts
+const result = await g8.api.health.apiHealth();
+```

package/docs/api/imageLibrary.d.ts

@@ -0,0 +1,341 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.imageLibrary` (Image Library): 14 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"commit_generated_image_image_library_generated__image_id__commit_post">;
+ *
+ * Reference with examples: imageLibrary.md
+ */
+/* eslint-disable */
+
+/** `g8.api.imageLibrary.<member>` -> the operationId it calls. */
+export interface ImageLibraryMembers {
+  commitGeneratedImage: "commit_generated_image_image_library_generated__image_id__commit_post";
+  deleteLibraryImage: "delete_library_image_image_library__image_id__delete";
+  discardGeneratedImage: "discard_generated_image_image_library_generated__image_id__delete";
+  extractImagesFromAllPages: "extract_images_from_all_pages_image_library_extract_all_pages_post";
+  extractImagesFromWebsite: "extract_images_from_website_image_library_extract_post";
+  getImageExtractionStatus: "get_image_extraction_status_image_library_extract_status__task_id__get";
+  listLibraryImageCategories: "list_library_image_categories_image_library_categories_get";
+  listLibraryImages: "list_library_images_image_library_get";
+  mergeLibraryDuplicates: "merge_library_duplicates_image_library_duplicates_merge_post";
+  scanLibraryDuplicates: "scan_library_duplicates_image_library_duplicates_scan_post";
+  setLibraryImageAltText: "set_library_image_alt_text_image_library__image_id__alt_text_patch";
+  setLibraryImageCategory: "set_library_image_category_image_library__image_id__category_patch";
+  setLibraryImageFeedback: "set_library_image_feedback_image_library__image_id__feedback_patch";
+  setLibraryImageTags: "set_library_image_tags_image_library__image_id__tags_patch";
+}
+
+/** Input and output of every `g8.api.imageLibrary` operation, keyed by operationId. */
+export interface ImageLibraryOperations {
+  /**
+   * POST /image-library/generated/{image_id}/commit
+   * Commit Generated Image
+   * tier: write · scope: campaigns:write
+   */
+  commit_generated_image_image_library_generated__image_id__commit_post: {
+    input: {
+    path: {
+      /** Image id (UUID). */
+      image_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * DELETE /image-library/{image_id}
+   * Delete Library Image
+   * tier: destructive · scope: campaigns:delete
+   */
+  delete_library_image_image_library__image_id__delete: {
+    input: {
+    path: {
+      /** Image id (UUID). */
+      image_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * DELETE /image-library/generated/{image_id}
+   * Discard Generated Image
+   * tier: destructive · scope: campaigns:delete
+   */
+  discard_generated_image_image_library_generated__image_id__delete: {
+    input: {
+    path: {
+      /** Image id (UUID). */
+      image_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /image-library/extract-all-pages
+   * Extract Images From All Pages
+   * tier: write · scope: campaigns:write
+   */
+  extract_images_from_all_pages_image_library_extract_all_pages_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /image-library/extract
+   * Extract Images From Website
+   * tier: write · scope: campaigns:write
+   */
+  extract_images_from_website_image_library_extract_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ExtractImagesRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * GET /image-library/extract/status/{task_id}
+   * Get Image Extraction Status
+   * tier: read · scope: campaigns:read
+   */
+  get_image_extraction_status_image_library_extract_status__task_id__get: {
+    input: {
+    path: {
+      /** Task id returned by `POST /image-library/extract`. */
+      task_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * GET /image-library/categories
+   * List Library Image Categories
+   * tier: read · scope: campaigns:read
+   */
+  list_library_image_categories_image_library_categories_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * GET /image-library
+   * List Library Images
+   * tier: read · scope: campaigns:read
+   */
+  list_library_images_image_library_get: {
+    input: {
+    query?: {
+      /** From `GET /image-library/categories`. */
+      category?: string | null;
+      campaign_id?: string | null;
+      /** Only images pulled from this page. */
+      source_url?: string | null;
+      /** How the image got here - extract, upload, ai. */
+      source?: string | null;
+      include_archived?: boolean;
+      limit?: number;
+      offset?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentListPayload_;
+  };
+  /**
+   * POST /image-library/duplicates/merge
+   * Merge Library Duplicates
+   * tier: write · scope: campaigns:write
+   */
+  merge_library_duplicates_image_library_duplicates_merge_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ImageMergeDuplicatesRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /image-library/duplicates/scan
+   * Scan Library Duplicates
+   * tier: read · scope: campaigns:read
+   */
+  scan_library_duplicates_image_library_duplicates_scan_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * PATCH /image-library/{image_id}/alt-text
+   * Set Library Image Alt Text
+   * tier: write · scope: campaigns:write
+   */
+  set_library_image_alt_text_image_library__image_id__alt_text_patch: {
+    input: {
+    path: {
+      /** Image id (UUID). */
+      image_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ImageAltTextRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * PATCH /image-library/{image_id}/category
+   * Set Library Image Category
+   * tier: write · scope: campaigns:write
+   */
+  set_library_image_category_image_library__image_id__category_patch: {
+    input: {
+    path: {
+      /** Image id (UUID). */
+      image_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ImageCategoryRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * PATCH /image-library/{image_id}/feedback
+   * Set Library Image Feedback
+   * tier: write · scope: campaigns:write
+   */
+  set_library_image_feedback_image_library__image_id__feedback_patch: {
+    input: {
+    path: {
+      /** Image id (UUID). */
+      image_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ImageFeedbackRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * PATCH /image-library/{image_id}/tags
+   * Set Library Image Tags
+   * tier: write · scope: campaigns:write
+   */
+  set_library_image_tags_image_library__image_id__tags_patch: {
+    input: {
+    path: {
+      /** Image id (UUID). */
+      image_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ImageTagsRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+}
+
+// 11 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;
+}
+
+/** Pull images out of a website. Fetches the site; spends no credit. */
+export interface ExtractImagesRequest {
+  min_height?: number;
+  min_width?: number;
+  url: string;
+}
+
+/** Set alt text, which is ALSO the library display name. */
+export interface ImageAltTextRequest {
+  alt_text?: string | null;
+}
+
+/** Recategorise an image. Categories come from `GET /image-library/categories`. */
+export interface ImageCategoryRequest {
+  category: string;
+}
+
+/** Thumbs up/down on an image. Null clears the existing feedback. */
+export interface ImageFeedbackRequest {
+  feedback?: string | null;
+}
+
+/** Keep one image; remove the duplicates after re-pointing their references. */
+export interface ImageMergeDuplicatesRequest {
+  duplicate_ids: Array<string>;
+  keeper_id: string;
+}
+
+/** The image's complete new tag set. Send `[]` to clear it. */
+export interface ImageTagsRequest {
+  tags: Array<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;
+}
+
+/**
+ * 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>;