chore(axon): add axon auto-pagination to stainless sdks (#8420)

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 124
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runloop-ai%2Frunloop-f32de1991bef7651f9b0970b503e2986c7a88708c4a408d54abe6d089795e9f9.yml
 openapi_spec_hash: d2005d48f75fba4a5368209cf49641dc
-config_hash: a759c23a5a04ad26f8740acc7e094c01
+config_hash: 5ffcc19219880e7d9ce43c1e6860568c

api.md

@@ -92,7 +92,7 @@ Methods:
 
 - <code title="post /v1/axons">client.axons.<a href="./src/resources/axons/axons.ts">create</a>({ ...params }) -> AxonView</code>
 - <code title="get /v1/axons/{id}">client.axons.<a href="./src/resources/axons/axons.ts">retrieve</a>(id) -> AxonView</code>
-- <code title="get /v1/axons">client.axons.<a href="./src/resources/axons/axons.ts">list</a>({ ...params }) -> AxonListView</code>
+- <code title="get /v1/axons">client.axons.<a href="./src/resources/axons/axons.ts">list</a>({ ...params }) -> AxonViewsAxonsCursorIDPage</code>
 - <code title="post /v1/axons/{id}/publish">client.axons.<a href="./src/resources/axons/axons.ts">publish</a>(id, { ...params }) -> PublishResultView</code>
 - <code title="get /v1/axons/{id}/subscribe/sse">client.axons.<a href="./src/resources/axons/axons.ts">subscribeSse</a>(id) -> AxonEventView</code>
 

src/index.ts

@@ -7,6 +7,8 @@ import * as Pagination from './pagination';
 import {
   type AgentsCursorIDPageParams,
   AgentsCursorIDPageResponse,
+  type AxonsCursorIDPageParams,
+  AxonsCursorIDPageResponse,
   type BenchmarkRunsCursorIDPageParams,
   BenchmarkRunsCursorIDPageResponse,
   type BenchmarksCursorIDPageParams,
@@ -180,6 +182,7 @@ import {
   AxonListView,
   AxonPublishParams,
   AxonView,
+  AxonViewsAxonsCursorIDPage,
   Axons,
   PublishParams,
   PublishResultView,
@@ -436,6 +439,7 @@ Runloop.BenchmarkJobs = BenchmarkJobs;
 Runloop.Agents = Agents;
 Runloop.AgentViewsAgentsCursorIDPage = AgentViewsAgentsCursorIDPage;
 Runloop.Axons = Axons;
+Runloop.AxonViewsAxonsCursorIDPage = AxonViewsAxonsCursorIDPage;
 Runloop.Blueprints = Blueprints;
 Runloop.BlueprintViewsBlueprintsCursorIDPage = BlueprintViewsBlueprintsCursorIDPage;
 Runloop.Devboxes = Devboxes;
@@ -494,6 +498,12 @@ export declare namespace Runloop {
     type AgentsCursorIDPageResponse as AgentsCursorIDPageResponse,
   };
 
+  export import AxonsCursorIDPage = Pagination.AxonsCursorIDPage;
+  export {
+    type AxonsCursorIDPageParams as AxonsCursorIDPageParams,
+    type AxonsCursorIDPageResponse as AxonsCursorIDPageResponse,
+  };
+
   export import BenchmarkRunsCursorIDPage = Pagination.BenchmarkRunsCursorIDPage;
   export {
     type BenchmarkRunsCursorIDPageParams as BenchmarkRunsCursorIDPageParams,
@@ -596,6 +606,7 @@ export declare namespace Runloop {
     type AxonView as AxonView,
     type PublishParams as PublishParams,
     type PublishResultView as PublishResultView,
+    AxonViewsAxonsCursorIDPage as AxonViewsAxonsCursorIDPage,
     type AxonListParams as AxonListParams,
     type AxonPublishParams as AxonPublishParams,
   };

src/pagination.ts

@@ -446,6 +446,80 @@ export class AgentsCursorIDPage<Item extends { id: string }>
   }
 }
 
+export interface AxonsCursorIDPageResponse<Item> {
+  axons: Array<Item>;
+
+  has_more: boolean;
+
+  total_count: number;
+}
+
+export interface AxonsCursorIDPageParams {
+  starting_after?: string;
+
+  limit?: number;
+}
+
+export class AxonsCursorIDPage<Item extends { id: string }>
+  extends AbstractPage<Item>
+  implements AxonsCursorIDPageResponse<Item>
+{
+  axons: Array<Item>;
+
+  has_more: boolean;
+
+  total_count: number;
+
+  constructor(
+    client: APIClient,
+    response: Response,
+    body: AxonsCursorIDPageResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.axons = body.axons || [];
+    this.has_more = body.has_more || false;
+    this.total_count = body.total_count || 0;
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.axons ?? [];
+  }
+
+  override hasNextPage(): boolean {
+    if (this.has_more === false) {
+      return false;
+    }
+
+    return super.hasNextPage();
+  }
+
+  // @deprecated Please use `nextPageInfo()` instead
+  nextPageParams(): Partial<AxonsCursorIDPageParams> | null {
+    const info = this.nextPageInfo();
+    if (!info) return null;
+    if ('params' in info) return info.params;
+    const params = Object.fromEntries(info.url.searchParams);
+    if (!Object.keys(params).length) return null;
+    return params;
+  }
+
+  nextPageInfo(): PageInfo | null {
+    const axons = this.getPaginatedItems();
+    if (!axons.length) {
+      return null;
+    }
+
+    const id = axons[axons.length - 1]?.id;
+    if (!id) {
+      return null;
+    }
+
+    return { params: { starting_after: id } };
+  }
+}
+
 export interface BenchmarkRunsCursorIDPageResponse<Item> {
   runs: Array<Item>;
 

src/resources/axons/axons.ts

@@ -17,6 +17,7 @@ import {
   SqlStepErrorView,
   SqlStepResultView,
 } from './sql';
+import { AxonsCursorIDPage, type AxonsCursorIDPageParams } from '../../pagination';
 import { Stream } from '../../streaming';
 
 export class Axons extends APIResource {
@@ -47,16 +48,19 @@ export class Axons extends APIResource {
   /**
    * [Beta] List all active axons.
    */
-  list(query?: AxonListParams, options?: Core.RequestOptions): Core.APIPromise<AxonListView>;
-  list(options?: Core.RequestOptions): Core.APIPromise<AxonListView>;
+  list(
+    query?: AxonListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<AxonViewsAxonsCursorIDPage, AxonView>;
+  list(options?: Core.RequestOptions): Core.PagePromise<AxonViewsAxonsCursorIDPage, AxonView>;
   list(
     query: AxonListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.APIPromise<AxonListView> {
+  ): Core.PagePromise<AxonViewsAxonsCursorIDPage, AxonView> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-    return this._client.get('/v1/axons', { query, ...options });
+    return this._client.getAPIList('/v1/axons', AxonViewsAxonsCursorIDPage, { query, ...options });
   }
 
   /**
@@ -88,6 +92,8 @@ export class Axons extends APIResource {
   }
 }
 
+export class AxonViewsAxonsCursorIDPage extends AxonsCursorIDPage<AxonView> {}
+
 export interface AxonCreateParams {
   /**
    * (Optional) Name for the axon.
@@ -201,7 +207,7 @@ export interface AxonCreateParams {
   name?: string | null;
 }
 
-export interface AxonListParams {
+export interface AxonListParams extends AxonsCursorIDPageParams {
   /**
    * Filter by axon ID.
    */
@@ -213,20 +219,10 @@ export interface AxonListParams {
    */
   include_total_count?: boolean;
 
-  /**
-   * The limit of items to return. Default is 20. Max is 5000.
-   */
-  limit?: number;
-
   /**
    * Filter by axon name (prefix match supported).
    */
   name?: string;
-
-  /**
-   * Load the next page of data starting after the item with the given ID.
-   */
-  starting_after?: string;
 }
 
 export interface AxonPublishParams {
@@ -251,6 +247,7 @@ export interface AxonPublishParams {
   source: string;
 }
 
+Axons.AxonViewsAxonsCursorIDPage = AxonViewsAxonsCursorIDPage;
 Axons.Sql = Sql;
 
 export declare namespace Axons {
@@ -261,6 +258,7 @@ export declare namespace Axons {
     type AxonView as AxonView,
     type PublishParams as PublishParams,
     type PublishResultView as PublishResultView,
+    AxonViewsAxonsCursorIDPage as AxonViewsAxonsCursorIDPage,
     type AxonListParams as AxonListParams,
     type AxonPublishParams as AxonPublishParams,
   };

src/resources/axons/index.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
+  AxonViewsAxonsCursorIDPage,
   Axons,
   type AxonCreateParams,
   type AxonEventView,

src/resources/index.ts

@@ -11,6 +11,7 @@ export {
   type AgentListParams,
 } from './agents';
 export {
+  AxonViewsAxonsCursorIDPage,
   Axons,
   type AxonCreateParams,
   type AxonEventView,