@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/bugReports.d.ts

@@ -0,0 +1,181 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.bugReports` (Bug Reports): 7 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"close_bug_report_bug_reports__report_id__close_post">;
+ *
+ * Reference with examples: bugReports.md
+ */
+/* eslint-disable */
+
+/** `g8.api.bugReports.<member>` -> the operationId it calls. */
+export interface BugReportsMembers {
+  closeBugReport: "close_bug_report_bug_reports__report_id__close_post";
+  commentOnBugReport: "comment_on_bug_report_bug_reports__report_id__comments_post";
+  createBugReport: "create_bug_report_bug_reports_post";
+  getBugBoard: "get_bug_board_bug_reports_board_get";
+  getBugReport: "get_bug_report_bug_reports__report_id__get";
+  getBugReportScreenshots: "get_bug_report_screenshots_bug_reports__report_id__screenshots_get";
+  listBugReports: "list_bug_reports_bug_reports_get";
+}
+
+/** Input and output of every `g8.api.bugReports` operation, keyed by operationId. */
+export interface BugReportsOperations {
+  /**
+   * POST /bug-reports/{report_id}/close
+   * Close Bug Report
+   * tier: write · scope: account:write
+   */
+  close_bug_report_bug_reports__report_id__close_post: {
+    input: {
+    path: {
+      /** Bug report id. */
+      report_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_BugReportPayload_;
+  };
+  /**
+   * POST /bug-reports/{report_id}/comments
+   * Comment On Bug Report
+   * tier: write · scope: account:write
+   */
+  comment_on_bug_report_bug_reports__report_id__comments_post: {
+    input: {
+    path: {
+      /** Bug report id. */
+      report_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: BugReportCommentRequest;
+  };
+    output: ApiResponse_BugReportPayload_;
+  };
+  /**
+   * POST /bug-reports
+   * Create Bug Report
+   * tier: write · scope: account:write
+   */
+  create_bug_report_bug_reports_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_BugReportPayload_;
+  };
+  /**
+   * GET /bug-reports/board
+   * Get Bug Board
+   * tier: read · scope: account:read
+   */
+  get_bug_board_bug_reports_board_get: {
+    input: {
+    query?: {
+      status?: ("open" | "in_progress" | "resolved" | "closed") | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_BugReportPayload_;
+  };
+  /**
+   * GET /bug-reports/{report_id}
+   * Get Bug Report
+   * tier: read · scope: account:read
+   */
+  get_bug_report_bug_reports__report_id__get: {
+    input: {
+    path: {
+      /** Bug report id. */
+      report_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_BugReportPayload_;
+  };
+  /**
+   * GET /bug-reports/{report_id}/screenshots
+   * Get Bug Report Screenshots
+   * tier: read · scope: account:read
+   */
+  get_bug_report_screenshots_bug_reports__report_id__screenshots_get: {
+    input: {
+    path: {
+      /** Bug report id. */
+      report_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_BugReportListPayload_;
+  };
+  /**
+   * GET /bug-reports
+   * List Bug Reports
+   * tier: read · scope: account:read
+   */
+  list_bug_reports_bug_reports_get: {
+    input: {
+    query?: {
+      status?: ("open" | "in_progress" | "resolved" | "closed") | null;
+      limit?: number;
+      offset?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_BugReportListPayload_;
+  };
+}
+
+// 6 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_BugReportListPayload_ {
+  data: BugReportListPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_BugReportPayload_ {
+  data: BugReportPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface BugReportCommentRequest {
+  body: string;
+}
+
+/** Bug reports under `items`. */
+export interface BugReportListPayload {
+  items?: Array<unknown>;
+  [key: string]: unknown;
+}
+
+/** A bug report with its status, comments and screenshots. */
+export type BugReportPayload = Record<string, unknown>;
+
+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;
+}

package/docs/api/bugReports.md

@@ -0,0 +1,268 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.bugReports`: Bug Reports
+
+7 operations (4 read, 3 write).
+
+No hand-written client covers this area. Call it through `g8.api.bugReports.*` 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: [bugReports.d.ts](bugReports.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`closeBugReport`](#op-closebugreport) | `POST /api/v1/bug-reports/{report_id}/close` | write | `account:write` | Close Bug Report |
+| [`commentOnBugReport`](#op-commentonbugreport) | `POST /api/v1/bug-reports/{report_id}/comments` | write | `account:write` | Comment On Bug Report |
+| [`createBugReport`](#op-createbugreport) | `POST /api/v1/bug-reports` | write | `account:write` | Create Bug Report |
+| [`getBugBoard`](#op-getbugboard) | `GET /api/v1/bug-reports/board` | read | `account:read` | Get Bug Board |
+| [`getBugReport`](#op-getbugreport) | `GET /api/v1/bug-reports/{report_id}` | read | `account:read` | Get Bug Report |
+| [`getBugReportScreenshots`](#op-getbugreportscreenshots) | `GET /api/v1/bug-reports/{report_id}/screenshots` | read | `account:read` | Get Bug Report Screenshots |
+| [`listBugReports`](#op-listbugreports) | `GET /api/v1/bug-reports` | read | `account:read` | List Bug Reports |
+
+---
+
+<a id="op-closebugreport"></a>
+
+### `g8.api.bugReports.closeBugReport(input)`
+
+**Close Bug Report**
+
+- HTTP: `POST /api/v1/bug-reports/{report_id}/close`
+- operationId: `close_bug_report_bug_reports__report_id__close_post` (also callable as `g8.api.call("close_bug_report_bug_reports__report_id__close_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `account:write`
+
+Close a report you filed. The tracked issue is closed too.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.report_id` | `string (uuid)` | yes | Bug report id. |
+
+**Returns** `ApiResponse_BugReportPayload_`: the envelope `{ data: BugReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.bugReports.closeBugReport({ path: { report_id: "00000000-0000-0000-0000-000000000000" } });
+```
+
+---
+
+<a id="op-commentonbugreport"></a>
+
+### `g8.api.bugReports.commentOnBugReport(input)`
+
+**Comment On Bug Report**
+
+- HTTP: `POST /api/v1/bug-reports/{report_id}/comments`
+- operationId: `comment_on_bug_report_bug_reports__report_id__comments_post` (also callable as `g8.api.call("comment_on_bug_report_bug_reports__report_id__comments_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `account:write`
+
+Add a comment. graph8's engineer sees it on the tracked issue.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.report_id` | `string (uuid)` | yes | Bug report id. |
+| `body` | `BugReportCommentRequest` | yes | Request body; fields below. |
+
+Body fields (`BugReportCommentRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.body` | `string` | yes | min length 1 |
+
+**Returns** `ApiResponse_BugReportPayload_`: the envelope `{ data: BugReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.bugReports.commentOnBugReport({
+  path: { report_id: "00000000-0000-0000-0000-000000000000" },
+  body: { body: "example" },
+});
+```
+
+---
+
+<a id="op-createbugreport"></a>
+
+### `g8.api.bugReports.createBugReport(input?)`
+
+**Create Bug Report**
+
+- HTTP: `POST /api/v1/bug-reports`
+- operationId: `create_bug_report_bug_reports_post` (also callable as `g8.api.call("create_bug_report_bug_reports_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `account:write`
+
+File a bug with graph8. It is routed to the engineer who owns the product area.
+
+**Input**: none.
+
+**Returns** `ApiResponse_BugReportPayload_`: the envelope `{ data: BugReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.bugReports.createBugReport();
+```
+
+---
+
+<a id="op-getbugboard"></a>
+
+### `g8.api.bugReports.getBugBoard(input?)`
+
+**Get Bug Board**
+
+- HTTP: `GET /api/v1/bug-reports/board`
+- operationId: `get_bug_board_bug_reports_board_get` (also callable as `g8.api.call("get_bug_board_bug_reports_board_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+The reports this key filed, grouped by status with their live tracker state.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.status` | `"open" \| "in_progress" \| "resolved" \| "closed" \| null` | no |  |
+
+**Returns** `ApiResponse_BugReportPayload_`: the envelope `{ data: BugReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.bugReports.getBugBoard();
+```
+
+---
+
+<a id="op-getbugreport"></a>
+
+### `g8.api.bugReports.getBugReport(input)`
+
+**Get Bug Report**
+
+- HTTP: `GET /api/v1/bug-reports/{report_id}`
+- operationId: `get_bug_report_bug_reports__report_id__get` (also callable as `g8.api.call("get_bug_report_bug_reports__report_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+One bug report, with comments and screenshots.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.report_id` | `string (uuid)` | yes | Bug report id. |
+
+**Returns** `ApiResponse_BugReportPayload_`: the envelope `{ data: BugReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.bugReports.getBugReport({ path: { report_id: "00000000-0000-0000-0000-000000000000" } });
+```
+
+---
+
+<a id="op-getbugreportscreenshots"></a>
+
+### `g8.api.bugReports.getBugReportScreenshots(input)`
+
+**Get Bug Report Screenshots**
+
+- HTTP: `GET /api/v1/bug-reports/{report_id}/screenshots`
+- operationId: `get_bug_report_screenshots_bug_reports__report_id__screenshots_get` (also callable as `g8.api.call("get_bug_report_screenshots_bug_reports__report_id__screenshots_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+Time-limited download links for a report's screenshots.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.report_id` | `string (uuid)` | yes | Bug report id. |
+
+**Returns** `ApiResponse_BugReportListPayload_`: the envelope `{ data: BugReportListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`BugReportListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.bugReports.getBugReportScreenshots({ path: { report_id: "00000000-0000-0000-0000-000000000000" } });
+```
+
+---
+
+<a id="op-listbugreports"></a>
+
+### `g8.api.bugReports.listBugReports(input?)`
+
+**List Bug Reports**
+
+- HTTP: `GET /api/v1/bug-reports`
+- operationId: `list_bug_reports_bug_reports_get` (also callable as `g8.api.call("list_bug_reports_bug_reports_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+The bug reports this key filed, newest first.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.status` | `"open" \| "in_progress" \| "resolved" \| "closed" \| null` | no |  |
+| `query.limit` | `integer` | no | default `50` |
+| `query.offset` | `integer` | no | default `0` |
+
+**Returns** `ApiResponse_BugReportListPayload_`: the envelope `{ data: BugReportListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`BugReportListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.bugReports.listBugReports();
+```