@truefoundry/trueforge-sdk 0.2.0-rc.6 → 0.2.0-rc.8

package/README.md

@@ -18,6 +18,7 @@ When auth is enabled on the server, pass an ID token via the optional `token` cl
 - [Exception Handling](#exception-handling)
 - [Streaming Response](#streaming-response)
 - [Binary Response](#binary-response)
+- [Pagination](#pagination)
 - [Advanced](#advanced)
   - [Subpackage Exports](#subpackage-exports)
   - [Additional Headers](#additional-headers)
@@ -497,6 +498,29 @@ const text = new TextDecoder().decode(bytes);
 
 </details>
 
+## Pagination
+
+List endpoints are paginated. The SDK provides an iterator so that you can simply loop over the items:
+
+```typescript
+import { TrueForge } from "@truefoundry/trueforge-sdk";
+
+const client = new TrueForge({ baseUrl: "YOUR_BASE_URL", token: "YOUR_TOKEN" });
+const pageableResponse = await client.agents.list();
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.agents.list();
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
+```
+
 ## Advanced
 
 ### Subpackage Exports

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@truefoundry/trueforge-sdk",
-        "X-Fern-SDK-Version": "0.2.0-rc.6",
-        "User-Agent": "@truefoundry/trueforge-sdk/0.2.0-rc.6",
+        "X-Fern-SDK-Version": "0.2.0-rc.8",
+        "User-Agent": "@truefoundry/trueforge-sdk/0.2.0-rc.8",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/cjs/api/resources/internal/resources/agents/client/Client.d.ts

@@ -11,7 +11,7 @@ export declare class AgentsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<AgentsClient.Options>;
     constructor(options: AgentsClient.Options);
     /**
-     * TypeScript TrueForge SDK samples (stream and non-stream) for creating a session and turn against this agent.
+     * TrueForge SDK samples (TypeScript and Python, stream and non-stream) for a session and turn against this agent.
      *
      * @param {string} agent_id - Immutable agent identifier.
      * @param {TrueForge.internal.GetCodeSnippetsAgentsRequest} request

package/dist/cjs/api/resources/internal/resources/agents/client/Client.js

@@ -56,7 +56,7 @@ class AgentsClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
-     * TypeScript TrueForge SDK samples (stream and non-stream) for creating a session and turn against this agent.
+     * TrueForge SDK samples (TypeScript and Python, stream and non-stream) for a session and turn against this agent.
      *
      * @param {string} agent_id - Immutable agent identifier.
      * @param {TrueForge.internal.GetCodeSnippetsAgentsRequest} request

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.2.0-rc.6";
+export declare const SDK_VERSION = "0.2.0-rc.8";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.2.0-rc.6";
+exports.SDK_VERSION = "0.2.0-rc.8";

package/dist/esm/BaseClient.mjs

@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@truefoundry/trueforge-sdk",
-        "X-Fern-SDK-Version": "0.2.0-rc.6",
-        "User-Agent": "@truefoundry/trueforge-sdk/0.2.0-rc.6",
+        "X-Fern-SDK-Version": "0.2.0-rc.8",
+        "User-Agent": "@truefoundry/trueforge-sdk/0.2.0-rc.8",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/esm/api/resources/internal/resources/agents/client/Client.d.mts

@@ -11,7 +11,7 @@ export declare class AgentsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<AgentsClient.Options>;
     constructor(options: AgentsClient.Options);
     /**
-     * TypeScript TrueForge SDK samples (stream and non-stream) for creating a session and turn against this agent.
+     * TrueForge SDK samples (TypeScript and Python, stream and non-stream) for a session and turn against this agent.
      *
      * @param {string} agent_id - Immutable agent identifier.
      * @param {TrueForge.internal.GetCodeSnippetsAgentsRequest} request

package/dist/esm/api/resources/internal/resources/agents/client/Client.mjs

@@ -20,7 +20,7 @@ export class AgentsClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
-     * TypeScript TrueForge SDK samples (stream and non-stream) for creating a session and turn against this agent.
+     * TrueForge SDK samples (TypeScript and Python, stream and non-stream) for a session and turn against this agent.
      *
      * @param {string} agent_id - Immutable agent identifier.
      * @param {TrueForge.internal.GetCodeSnippetsAgentsRequest} request

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.2.0-rc.6";
+export declare const SDK_VERSION = "0.2.0-rc.8";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.2.0-rc.6";
+export const SDK_VERSION = "0.2.0-rc.8";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truefoundry/trueforge-sdk",
-  "version": "0.2.0-rc.6",
+  "version": "0.2.0-rc.8",
   "private": false,
   "type": "commonjs",
   "main": "./dist/cjs/index.js",

package/reference.md

@@ -94,7 +94,19 @@ List configured agents for the tenant, ordered by name. Optional `agent_name` fi
 <dd>
 
 ```typescript
-await client.agents.list();
+const pageableResponse = await client.agents.list();
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.agents.list();
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
 
 ```
 </dd>
@@ -916,7 +928,19 @@ List schedules for the tenant, newest first.
 <dd>
 
 ```typescript
-await client.schedules.list();
+const pageableResponse = await client.schedules.list();
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.schedules.list();
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
 
 ```
 </dd>
@@ -1317,7 +1341,19 @@ List runs of a schedule, newest `scheduled_for` first. Available to its creator
 <dd>
 
 ```typescript
-await client.schedules.listRuns("schedule_id");
+const pageableResponse = await client.schedules.listRuns("schedule_id");
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.schedules.listRuns("schedule_id");
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
 
 ```
 </dd>
@@ -1389,7 +1425,19 @@ List the sessions (newest first by default).
 <dd>
 
 ```typescript
-await client.sessions.list();
+const pageableResponse = await client.sessions.list();
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.sessions.list();
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
 
 ```
 </dd>
@@ -1787,7 +1835,19 @@ List session events as `{ turn_id, event }` across the active turn branch (newes
 <dd>
 
 ```typescript
-await client.sessions.listEvents("session_id");
+const pageableResponse = await client.sessions.listEvents("session_id");
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.sessions.listEvents("session_id");
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
 
 ```
 </dd>
@@ -1858,7 +1918,19 @@ List turns for a session (newest first by default), token-paginated. Only the se
 <dd>
 
 ```typescript
-await client.sessions.listTurns("session_id");
+const pageableResponse = await client.sessions.listTurns("session_id");
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.sessions.listTurns("session_id");
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
 
 ```
 </dd>
@@ -2234,7 +2306,19 @@ Paginated persisted events for a turn (insertion order by default). Only the ses
 <dd>
 
 ```typescript
-await client.sessions.listTurnEvents("session_id", "turn_id");
+const pageableResponse = await client.sessions.listTurnEvents("session_id", "turn_id");
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.sessions.listTurnEvents("session_id", "turn_id");
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
 
 ```
 </dd>
@@ -3052,7 +3136,7 @@ await client.internal.sessions.getOrCreateByExternalId({
 <dl>
 <dd>
 
-TypeScript TrueForge SDK samples (stream and non-stream) for creating a session and turn against this agent.
+TrueForge SDK samples (TypeScript and Python, stream and non-stream) for a session and turn against this agent.
 </dd>
 </dl>
 </dd>