feat: api: paginate GET /extensions

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 117
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-e5524e6eeeedc614c05bf19896f1ce6c4f8a113de85c02952d6874d579651f70.yml
-openapi_spec_hash: 7815a189a50e6aa9e283213cc78d041c
-config_hash: 453b25a35834fd59a55a2315d1d50746
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-9a76e7a837ac9ffbe0e9557d618ce9b676e052249e364e516c28ddb33b912019.yml
+openapi_spec_hash: c0e5412cc95139f11a8b8635559bb985
+config_hash: 098a7f3fd134c8e4cbd3a44750892a18

api.md

@@ -296,7 +296,7 @@ Types:
 
 Methods:
 
-- <code title="get /extensions">client.extensions.<a href="./src/resources/extensions.ts">list</a>() -> ExtensionListResponse</code>
+- <code title="get /extensions">client.extensions.<a href="./src/resources/extensions.ts">list</a>({ ...params }) -> ExtensionListResponsesOffsetPagination</code>
 - <code title="delete /extensions/{id_or_name}">client.extensions.<a href="./src/resources/extensions.ts">delete</a>(idOrName) -> void</code>
 - <code title="get /extensions/{id_or_name}">client.extensions.<a href="./src/resources/extensions.ts">download</a>(idOrName) -> Response</code>
 - <code title="get /extensions/from_chrome_store">client.extensions.<a href="./src/resources/extensions.ts">downloadFromChromeStore</a>({ ...params }) -> Response</code>

src/client.ts

@@ -84,7 +84,9 @@ import {
 import { KernelApp } from './core/app-framework';
 import {
   ExtensionDownloadFromChromeStoreParams,
+  ExtensionListParams,
   ExtensionListResponse,
+  ExtensionListResponsesOffsetPagination,
   ExtensionUploadParams,
   ExtensionUploadResponse,
   Extensions,
@@ -1094,6 +1096,8 @@ export declare namespace Kernel {
     Extensions as Extensions,
     type ExtensionListResponse as ExtensionListResponse,
     type ExtensionUploadResponse as ExtensionUploadResponse,
+    type ExtensionListResponsesOffsetPagination as ExtensionListResponsesOffsetPagination,
+    type ExtensionListParams as ExtensionListParams,
     type ExtensionDownloadFromChromeStoreParams as ExtensionDownloadFromChromeStoreParams,
     type ExtensionUploadParams as ExtensionUploadParams,
   };

src/resources/extensions.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
+import { OffsetPagination, type OffsetPaginationParams, PagePromise } from '../core/pagination';
 import { type Uploadable } from '../core/uploads';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
@@ -17,11 +18,20 @@ export class Extensions extends APIResource {
    *
    * @example
    * ```ts
-   * const extensions = await client.extensions.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const extensionListResponse of client.extensions.list()) {
+   *   // ...
+   * }
    * ```
    */
-  list(options?: RequestOptions): APIPromise<ExtensionListResponse> {
-    return this._client.get('/extensions', options);
+  list(
+    query: ExtensionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ExtensionListResponsesOffsetPagination, ExtensionListResponse> {
+    return this._client.getAPIList('/extensions', OffsetPagination<ExtensionListResponse>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -103,39 +113,37 @@ export class Extensions extends APIResource {
   }
 }
 
-export type ExtensionListResponse = Array<ExtensionListResponse.ExtensionListResponseItem>;
+export type ExtensionListResponsesOffsetPagination = OffsetPagination<ExtensionListResponse>;
 
-export namespace ExtensionListResponse {
+/**
+ * A browser extension uploaded to Kernel.
+ */
+export interface ExtensionListResponse {
   /**
-   * A browser extension uploaded to Kernel.
+   * Unique identifier for the extension
    */
-  export interface ExtensionListResponseItem {
-    /**
-     * Unique identifier for the extension
-     */
-    id: string;
+  id: string;
 
-    /**
-     * Timestamp when the extension was created
-     */
-    created_at: string;
+  /**
+   * Timestamp when the extension was created
+   */
+  created_at: string;
 
-    /**
-     * Size of the extension archive in bytes
-     */
-    size_bytes: number;
+  /**
+   * Size of the extension archive in bytes
+   */
+  size_bytes: number;
 
-    /**
-     * Timestamp when the extension was last used
-     */
-    last_used_at?: string | null;
+  /**
+   * Timestamp when the extension was last used
+   */
+  last_used_at?: string | null;
 
-    /**
-     * Optional, easier-to-reference name for the extension. Must be unique within the
-     * project.
-     */
-    name?: string | null;
-  }
+  /**
+   * Optional, easier-to-reference name for the extension. Must be unique within the
+   * project.
+   */
+  name?: string | null;
 }
 
 /**
@@ -169,6 +177,8 @@ export interface ExtensionUploadResponse {
   name?: string | null;
 }
 
+export interface ExtensionListParams extends OffsetPaginationParams {}
+
 export interface ExtensionDownloadFromChromeStoreParams {
   /**
    * Chrome Web Store URL for the extension.
@@ -197,6 +207,8 @@ export declare namespace Extensions {
   export {
     type ExtensionListResponse as ExtensionListResponse,
     type ExtensionUploadResponse as ExtensionUploadResponse,
+    type ExtensionListResponsesOffsetPagination as ExtensionListResponsesOffsetPagination,
+    type ExtensionListParams as ExtensionListParams,
     type ExtensionDownloadFromChromeStoreParams as ExtensionDownloadFromChromeStoreParams,
     type ExtensionUploadParams as ExtensionUploadParams,
   };

src/resources/index.ts

@@ -87,8 +87,10 @@ export {
   Extensions,
   type ExtensionListResponse,
   type ExtensionUploadResponse,
+  type ExtensionListParams,
   type ExtensionDownloadFromChromeStoreParams,
   type ExtensionUploadParams,
+  type ExtensionListResponsesOffsetPagination,
 } from './extensions';
 export {
   Invocations,

tests/api-resources/extensions.test.ts

@@ -20,6 +20,14 @@ describe('resource extensions', () => {
     expect(dataAndResponse.response).toBe(rawResponse);
   });
 
+  // Mock server tests are disabled
+  test.skip('list: request options and params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(
+      client.extensions.list({ limit: 1, offset: 0 }, { path: '/_stainless_unknown_path' }),
+    ).rejects.toThrow(Kernel.NotFoundError);
+  });
+
   // Mock server tests are disabled
   test.skip('delete', async () => {
     const responsePromise = client.extensions.delete('id_or_name');