feat: api: paginate GET /org/credential_providers

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-9a76e7a837ac9ffbe0e9557d618ce9b676e052249e364e516c28ddb33b912019.yml
-openapi_spec_hash: c0e5412cc95139f11a8b8635559bb985
-config_hash: 098a7f3fd134c8e4cbd3a44750892a18
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-e6c711f0d29a7d956cc8ca621440da966c1f1575b1205d01328b1099edf1c517.yml
+openapi_spec_hash: c06e7e36de1c6f9b29b54a6e3dc08ee5
+config_hash: 36159c262d293fbeacf513ab600a1729

api.md

@@ -390,15 +390,14 @@ Types:
 - <code><a href="./src/resources/credential-providers.ts">CredentialProviderItem</a></code>
 - <code><a href="./src/resources/credential-providers.ts">CredentialProviderTestResult</a></code>
 - <code><a href="./src/resources/credential-providers.ts">UpdateCredentialProviderRequest</a></code>
-- <code><a href="./src/resources/credential-providers.ts">CredentialProviderListResponse</a></code>
 - <code><a href="./src/resources/credential-providers.ts">CredentialProviderListItemsResponse</a></code>
 
 Methods:
 
 - <code title="post /org/credential_providers">client.credentialProviders.<a href="./src/resources/credential-providers.ts">create</a>({ ...params }) -> CredentialProvider</code>
 - <code title="get /org/credential_providers/{id}">client.credentialProviders.<a href="./src/resources/credential-providers.ts">retrieve</a>(id) -> CredentialProvider</code>
 - <code title="patch /org/credential_providers/{id}">client.credentialProviders.<a href="./src/resources/credential-providers.ts">update</a>(id, { ...params }) -> CredentialProvider</code>
-- <code title="get /org/credential_providers">client.credentialProviders.<a href="./src/resources/credential-providers.ts">list</a>() -> CredentialProviderListResponse</code>
+- <code title="get /org/credential_providers">client.credentialProviders.<a href="./src/resources/credential-providers.ts">list</a>({ ...params }) -> CredentialProvidersOffsetPagination</code>
 - <code title="delete /org/credential_providers/{id}">client.credentialProviders.<a href="./src/resources/credential-providers.ts">delete</a>(id) -> void</code>
 - <code title="get /org/credential_providers/{id}/items">client.credentialProviders.<a href="./src/resources/credential-providers.ts">listItems</a>(id) -> CredentialProviderListItemsResponse</code>
 - <code title="post /org/credential_providers/{id}/test">client.credentialProviders.<a href="./src/resources/credential-providers.ts">test</a>(id) -> CredentialProviderTestResult</code>

src/client.ts

@@ -52,10 +52,11 @@ import {
   CredentialProviderCreateParams,
   CredentialProviderItem,
   CredentialProviderListItemsResponse,
-  CredentialProviderListResponse,
+  CredentialProviderListParams,
   CredentialProviderTestResult,
   CredentialProviderUpdateParams,
   CredentialProviders,
+  CredentialProvidersOffsetPagination,
   UpdateCredentialProviderRequest,
 } from './resources/credential-providers';
 import {
@@ -1155,10 +1156,11 @@ export declare namespace Kernel {
     type CredentialProviderItem as CredentialProviderItem,
     type CredentialProviderTestResult as CredentialProviderTestResult,
     type UpdateCredentialProviderRequest as UpdateCredentialProviderRequest,
-    type CredentialProviderListResponse as CredentialProviderListResponse,
     type CredentialProviderListItemsResponse as CredentialProviderListItemsResponse,
+    type CredentialProvidersOffsetPagination as CredentialProvidersOffsetPagination,
     type CredentialProviderCreateParams as CredentialProviderCreateParams,
     type CredentialProviderUpdateParams as CredentialProviderUpdateParams,
+    type CredentialProviderListParams as CredentialProviderListParams,
   };
 
   export type AppAction = API.AppAction;

src/resources/credential-providers.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 { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
@@ -63,12 +64,20 @@ export class CredentialProviders extends APIResource {
    *
    * @example
    * ```ts
-   * const credentialProviders =
-   *   await client.credentialProviders.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const credentialProvider of client.credentialProviders.list()) {
+   *   // ...
+   * }
    * ```
    */
-  list(options?: RequestOptions): APIPromise<CredentialProviderListResponse> {
-    return this._client.get('/org/credential_providers', options);
+  list(
+    query: CredentialProviderListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CredentialProvidersOffsetPagination, CredentialProvider> {
+    return this._client.getAPIList('/org/credential_providers', OffsetPagination<CredentialProvider>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -115,6 +124,8 @@ export class CredentialProviders extends APIResource {
   }
 }
 
+export type CredentialProvidersOffsetPagination = OffsetPagination<CredentialProvider>;
+
 /**
  * Request to create an external credential provider
  */
@@ -280,8 +291,6 @@ export interface UpdateCredentialProviderRequest {
   priority?: number;
 }
 
-export type CredentialProviderListResponse = Array<CredentialProvider>;
-
 export interface CredentialProviderListItemsResponse {
   items?: Array<CredentialProviderItem>;
 }
@@ -335,16 +344,19 @@ export interface CredentialProviderUpdateParams {
   priority?: number;
 }
 
+export interface CredentialProviderListParams extends OffsetPaginationParams {}
+
 export declare namespace CredentialProviders {
   export {
     type CreateCredentialProviderRequest as CreateCredentialProviderRequest,
     type CredentialProvider as CredentialProvider,
     type CredentialProviderItem as CredentialProviderItem,
     type CredentialProviderTestResult as CredentialProviderTestResult,
     type UpdateCredentialProviderRequest as UpdateCredentialProviderRequest,
-    type CredentialProviderListResponse as CredentialProviderListResponse,
     type CredentialProviderListItemsResponse as CredentialProviderListItemsResponse,
+    type CredentialProvidersOffsetPagination as CredentialProvidersOffsetPagination,
     type CredentialProviderCreateParams as CredentialProviderCreateParams,
     type CredentialProviderUpdateParams as CredentialProviderUpdateParams,
+    type CredentialProviderListParams as CredentialProviderListParams,
   };
 }

src/resources/index.ts

@@ -55,10 +55,11 @@ export {
   type CredentialProviderItem,
   type CredentialProviderTestResult,
   type UpdateCredentialProviderRequest,
-  type CredentialProviderListResponse,
   type CredentialProviderListItemsResponse,
   type CredentialProviderCreateParams,
   type CredentialProviderUpdateParams,
+  type CredentialProviderListParams,
+  type CredentialProvidersOffsetPagination,
 } from './credential-providers';
 export {
   Credentials,

tests/api-resources/credential-providers.test.ts

@@ -70,6 +70,14 @@ describe('resource credentialProviders', () => {
     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.credentialProviders.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.credentialProviders.delete('id');