@graph8/sdk 0.251.0 → 0.262.0

package/docs/api/logs.d.ts

@@ -0,0 +1,71 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.logs` (Logs): 1 operation.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"list_request_logs_logs_get">;
+ *
+ * Reference with examples: logs.md
+ */
+/* eslint-disable */
+
+/** `g8.api.logs.<member>` -> the operationId it calls. */
+export interface LogsMembers {
+  listRequestLogs: "list_request_logs_logs_get";
+}
+
+/** Input and output of every `g8.api.logs` operation, keyed by operationId. */
+export interface LogsOperations {
+  /**
+   * GET /logs
+   * List Request Logs
+   * tier: read · scope: analytics:read
+   */
+  list_request_logs_logs_get: {
+    input: {
+    query?: {
+      /** Max entries to return (most recent first) */
+      limit?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_list_RequestLogEntry__;
+  };
+}
+
+// 3 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_list_RequestLogEntry__ {
+  data: Array<RequestLogEntry>;
+  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;
+}
+
+export interface RequestLogEntry {
+  /** HTTP method */
+  method: string;
+  /** Request path */
+  path: string;
+  /** Correlation id — matches the X-Request-Id response header */
+  request_id: string;
+  /** HTTP status code of the response */
+  status: number;
+  /** Unix seconds when the request completed */
+  timestamp: number;
+}

package/docs/api/logs.md

@@ -0,0 +1,70 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.logs`: Logs
+
+1 operation (1 read).
+
+No hand-written client covers this area. Call it through `g8.api.logs.*` 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: [logs.d.ts](logs.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`listRequestLogs`](#op-listrequestlogs) | `GET /api/v1/logs` | read | `analytics:read` | List Request Logs |
+
+---
+
+<a id="op-listrequestlogs"></a>
+
+### `g8.api.logs.listRequestLogs(input?)`
+
+**List Request Logs**
+
+- HTTP: `GET /api/v1/logs`
+- operationId: `list_request_logs_logs_get` (also callable as `g8.api.call("list_request_logs_logs_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Recent API requests for the authenticated org (most recent first).
+
+Useful for debugging an integration: see your last calls, their status codes,
+and the request_id to correlate with the X-Request-Id header. Best-effort —
+entries are retained briefly and may be absent if logging was unavailable.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.limit` | `integer` | no | Max entries to return (most recent first) default `50` |
+
+**Returns** `ApiResponse_list_RequestLogEntry__`: the envelope `{ data: Array<RequestLogEntry>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`RequestLogEntry` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `method` | `string` | yes | HTTP method |
+| `path` | `string` | yes | Request path |
+| `request_id` | `string` | yes | Correlation id — matches the X-Request-Id response header |
+| `status` | `integer` | yes | HTTP status code of the response |
+| `timestamp` | `integer` | yes | Unix seconds when the request completed |
+
+**Example**
+
+```ts
+const result = await g8.api.logs.listRequestLogs();
+```