feat: Neil/kernel 1017 profile pagination query parameter

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 101
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-ea5c9cb25c29fa5a8758bbf8732eb306783bb6f13b4df29bf1ad5ad3cb32da1e.yml
-openapi_spec_hash: 597031840469b011f5cf22a4d8b9d750
-config_hash: 147340811dd6fbb9c2d80515a7e31f9a
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-fc4a441d80d9a26574ef8af390a0c76265f5d4190daf90a04b6b353b128bbd97.yml
+openapi_spec_hash: 192987649d3797c3a80e6ef201667b64
+config_hash: 8af430e19f4af86c05f2987241cae72f

api.md

@@ -192,15 +192,11 @@ Methods:
 
 # Profiles
 
-Types:
-
-- <code><a href="./src/resources/profiles.ts">ProfileListResponse</a></code>
-
 Methods:
 
 - <code title="post /profiles">client.profiles.<a href="./src/resources/profiles.ts">create</a>({ ...params }) -> Profile</code>
 - <code title="get /profiles/{id_or_name}">client.profiles.<a href="./src/resources/profiles.ts">retrieve</a>(idOrName) -> Profile</code>
-- <code title="get /profiles">client.profiles.<a href="./src/resources/profiles.ts">list</a>() -> ProfileListResponse</code>
+- <code title="get /profiles">client.profiles.<a href="./src/resources/profiles.ts">list</a>({ ...params }) -> ProfilesOffsetPagination</code>
 - <code title="delete /profiles/{id_or_name}">client.profiles.<a href="./src/resources/profiles.ts">delete</a>(idOrName) -> void</code>
 - <code title="get /profiles/{id_or_name}/download">client.profiles.<a href="./src/resources/profiles.ts">download</a>(idOrName) -> Response</code>
 

src/client.ts

@@ -88,7 +88,7 @@ import {
   InvocationUpdateResponse,
   Invocations,
 } from './resources/invocations';
-import { ProfileCreateParams, ProfileListResponse, Profiles } from './resources/profiles';
+import { ProfileCreateParams, ProfileListParams, Profiles } from './resources/profiles';
 import {
   Proxies,
   ProxyCheckResponse,
@@ -985,8 +985,8 @@ export declare namespace Kernel {
 
   export {
     Profiles as Profiles,
-    type ProfileListResponse as ProfileListResponse,
     type ProfileCreateParams as ProfileCreateParams,
+    type ProfileListParams as ProfileListParams,
   };
 
   export { Auth as Auth };

src/resources/browsers/browsers.ts

@@ -209,6 +209,8 @@ export class Browsers extends APIResource {
 
 export type BrowserListResponsesOffsetPagination = OffsetPagination<BrowserListResponse>;
 
+export type ProfilesOffsetPagination = OffsetPagination<Profile>;
+
 /**
  * @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
  * instead.

src/resources/browsers/index.ts

@@ -14,6 +14,7 @@ export {
   type BrowserListParams,
   type BrowserDeleteParams,
   type BrowserLoadExtensionsParams,
+  type ProfilesOffsetPagination,
   type BrowserListResponsesOffsetPagination,
 } from './browsers';
 export {

src/resources/index.ts

@@ -33,6 +33,7 @@ export {
   type BrowserListParams,
   type BrowserDeleteParams,
   type BrowserLoadExtensionsParams,
+  type ProfilesOffsetPagination,
   type BrowserListResponsesOffsetPagination,
 } from './browsers/browsers';
 export {
@@ -92,7 +93,7 @@ export {
   type InvocationFollowParams,
   type InvocationListResponsesOffsetPagination,
 } from './invocations';
-export { Profiles, type ProfileListResponse, type ProfileCreateParams } from './profiles';
+export { Profiles, type ProfileCreateParams, type ProfileListParams } from './profiles';
 export {
   Proxies,
   type ProxyCreateResponse,

src/resources/profiles.ts

@@ -2,7 +2,9 @@
 
 import { APIResource } from '../core/resource';
 import * as BrowsersAPI from './browsers/browsers';
+import { ProfilesOffsetPagination } from './browsers/browsers';
 import { APIPromise } from '../core/api-promise';
+import { OffsetPagination, type OffsetPaginationParams, PagePromise } from '../core/pagination';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
@@ -26,8 +28,11 @@ export class Profiles extends APIResource {
   /**
    * List profiles with optional filtering and pagination.
    */
-  list(options?: RequestOptions): APIPromise<ProfileListResponse> {
-    return this._client.get('/profiles', options);
+  list(
+    query: ProfileListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ProfilesOffsetPagination, BrowsersAPI.Profile> {
+    return this._client.getAPIList('/profiles', OffsetPagination<BrowsersAPI.Profile>, { query, ...options });
   }
 
   /**
@@ -53,15 +58,22 @@ export class Profiles extends APIResource {
   }
 }
 
-export type ProfileListResponse = Array<BrowsersAPI.Profile>;
-
 export interface ProfileCreateParams {
   /**
    * Optional name of the profile. Must be unique within the organization.
    */
   name?: string;
 }
 
+export interface ProfileListParams extends OffsetPaginationParams {
+  /**
+   * Search profiles by name or ID.
+   */
+  query?: string;
+}
+
 export declare namespace Profiles {
-  export { type ProfileListResponse as ProfileListResponse, type ProfileCreateParams as ProfileCreateParams };
+  export { type ProfileCreateParams as ProfileCreateParams, type ProfileListParams as ProfileListParams };
 }
+
+export { type ProfilesOffsetPagination };

tests/api-resources/profiles.test.ts

@@ -44,6 +44,21 @@ describe('resource profiles', () => {
     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.profiles.list(
+        {
+          limit: 1,
+          offset: 0,
+          query: 'query',
+        },
+        { path: '/_stainless_unknown_path' },
+      ),
+    ).rejects.toThrow(Kernel.NotFoundError);
+  });
+
   // Mock server tests are disabled
   test.skip('delete', async () => {
     const responsePromise = client.profiles.delete('id_or_name');