feat(api): add discoveries resource and list method

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 55
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lightspark%2Fgrid-eb44d3f73a6098f2dd410cb9896a3e5c2f7dbbae384cd1e8839523d18b5788bf.yml
-openapi_spec_hash: 49c97ed17fd291f0f22878afc202c40b
-config_hash: c48f66ccc627ca8bf39dfe231e26485c
+configured_endpoints: 56
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lightspark%2Fgrid-b0440178b0ded045e9e936cff9373c6bddcf557b037a1249bc328bdac2e47b55.yml
+openapi_spec_hash: 540510758de98ab16827bda43bc207cd
+config_hash: ea9b15789114706ecc042dc8184a6ca7

api.md

@@ -368,3 +368,13 @@ Methods:
 - <code title="get /verifications/{verificationId}">client.verifications.<a href="./src/resources/verifications.ts">retrieve</a>(verificationID) -> VerificationRetrieveResponse</code>
 - <code title="get /verifications">client.verifications.<a href="./src/resources/verifications.ts">list</a>({ ...params }) -> VerificationListResponsesDefaultPagination</code>
 - <code title="post /verifications">client.verifications.<a href="./src/resources/verifications.ts">submit</a>({ ...params }) -> VerificationSubmitResponse</code>
+
+# Discoveries
+
+Types:
+
+- <code><a href="./src/resources/discoveries.ts">DiscoveryListResponse</a></code>
+
+Methods:
+
+- <code title="get /discoveries">client.discoveries.<a href="./src/resources/discoveries.ts">list</a>({ ...params }) -> DiscoveryListResponse</code>

packages/mcp-server/src/code-tool-worker.ts

@@ -160,6 +160,7 @@ const fuse = new Fuse(
     'client.verifications.list',
     'client.verifications.retrieve',
     'client.verifications.submit',
+    'client.discoveries.list',
   ],
   { threshold: 1, shouldSort: true },
 );

packages/mcp-server/src/local-docs-search.ts

@@ -979,6 +979,20 @@ const EMBEDDED_METHODS: MethodEntry[] = [
     markdown:
       "## submit\n\n`client.verifications.submit(customerId: string): { id: string; createdAt: string; customerId: string; errors: object[]; verificationStatus: 'RESOLVE_ERRORS' | 'PENDING_MANUAL_REVIEW' | 'IN_PROGRESS' | 'APPROVED' | 'REJECTED'; updatedAt?: string; }`\n\n**post** `/verifications`\n\nTrigger KYC (individual) or KYB (business) verification for a customer. The response indicates whether all required information has been provided. If data is missing, the `errors` array describes exactly what needs to be supplied before verification can proceed.\n\nCall this endpoint again after resolving errors to re-submit.\n\n\n### Parameters\n\n- `customerId: string`\n  The ID of the customer to verify\n\n### Returns\n\n- `{ id: string; createdAt: string; customerId: string; errors: { reason: string; resourceId: string; type: string; acceptedDocumentTypes?: string[]; field?: string; }[]; verificationStatus: 'RESOLVE_ERRORS' | 'PENDING_MANUAL_REVIEW' | 'IN_PROGRESS' | 'APPROVED' | 'REJECTED'; updatedAt?: string; }`\n\n  - `id: string`\n  - `createdAt: string`\n  - `customerId: string`\n  - `errors: { reason: string; resourceId: string; type: string; acceptedDocumentTypes?: string[]; field?: string; }[]`\n  - `verificationStatus: 'RESOLVE_ERRORS' | 'PENDING_MANUAL_REVIEW' | 'IN_PROGRESS' | 'APPROVED' | 'REJECTED'`\n  - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport LightsparkGrid from '@lightsparkdev/grid';\n\nconst client = new LightsparkGrid();\n\nconst response = await client.verifications.submit({ customerId: 'Customer:019542f5-b3e7-1d02-0000-000000000001' });\n\nconsole.log(response);\n```",
   },
+  {
+    name: 'list',
+    endpoint: '/discoveries',
+    httpMethod: 'get',
+    summary: 'List available receiving institution names',
+    description:
+      'Retrieve available payment institution names for a given country and currency. Use this endpoint\nto look up supported banks and payment providers for a specific corridor.\nIf no country and currency parameter are provided, all payment institutions will be returned\n\nThe `bankName` field in each result is the value to pass as `bankName` when\ncreating an external account via `POST /customers/external-accounts`.\n',
+    stainlessPath: '(resource) discoveries > (method) list',
+    qualified: 'client.discoveries.list',
+    params: ['country?: string;', 'currency?: string;'],
+    response: '{ data?: { bankName: string; country: string; currency: string; displayName: string; }[]; }',
+    markdown:
+      "## list\n\n`client.discoveries.list(country?: string, currency?: string): { data?: object[]; }`\n\n**get** `/discoveries`\n\nRetrieve available payment institution names for a given country and currency. Use this endpoint\nto look up supported banks and payment providers for a specific corridor.\nIf no country and currency parameter are provided, all payment institutions will be returned\n\nThe `bankName` field in each result is the value to pass as `bankName` when\ncreating an external account via `POST /customers/external-accounts`.\n\n\n### Parameters\n\n- `country?: string`\n  ISO 3166-1 alpha-2 country code (e.g. PH)\n\n- `currency?: string`\n  ISO 4217 currency code (e.g. PHP)\n\n### Returns\n\n- `{ data?: { bankName: string; country: string; currency: string; displayName: string; }[]; }`\n\n  - `data?: { bankName: string; country: string; currency: string; displayName: string; }[]`\n\n### Example\n\n```typescript\nimport LightsparkGrid from '@lightsparkdev/grid';\n\nconst client = new LightsparkGrid();\n\nconst discoveries = await client.discoveries.list();\n\nconsole.log(discoveries);\n```",
+  },
 ];
 
 const EMBEDDED_READMES: { language: string; content: string }[] = [];

packages/mcp-server/src/methods.ts

@@ -341,6 +341,12 @@ export const sdkMethods: SdkMethod[] = [
     httpMethod: 'post',
     httpPath: '/verifications',
   },
+  {
+    clientCallName: 'client.discoveries.list',
+    fullyQualifiedName: 'discoveries.list',
+    httpMethod: 'get',
+    httpPath: '/discoveries',
+  },
 ];
 
 function allowedMethodsForCodeTool(options: McpOptions | undefined): SdkMethod[] | undefined {

scripts/detect-breaking-changes

@@ -30,6 +30,7 @@ TEST_PATHS=(
 	tests/api-resources/beneficial-owners.test.ts
 	tests/api-resources/documents.test.ts
 	tests/api-resources/verifications.test.ts
+	tests/api-resources/discoveries.test.ts
 	tests/index.test.ts
 )
 

src/client.ts

@@ -42,6 +42,7 @@ import {
   CryptoEstimateWithdrawalFeeParams,
   CryptoEstimateWithdrawalFeeResponse,
 } from './resources/crypto';
+import { Discoveries, DiscoveryListParams, DiscoveryListResponse } from './resources/discoveries';
 import {
   DocumentListParams,
   DocumentListResponse,
@@ -1011,6 +1012,10 @@ export class LightsparkGrid {
    * Endpoints for Know Your Customer (KYC) and Know Your Business (KYB) verification, including managing beneficial owners and triggering verification for customers.
    */
   verifications: API.Verifications = new API.Verifications(this);
+  /**
+   * Endpoints for discovering available payment rails, banks, and providers for a given country and currency corridor.
+   */
+  discoveries: API.Discoveries = new API.Discoveries(this);
 }
 
 LightsparkGrid.Config = Config;
@@ -1032,6 +1037,7 @@ LightsparkGrid.Crypto = Crypto;
 LightsparkGrid.BeneficialOwners = BeneficialOwners;
 LightsparkGrid.Documents = Documents;
 LightsparkGrid.Verifications = Verifications;
+LightsparkGrid.Discoveries = Discoveries;
 
 export declare namespace LightsparkGrid {
   export type RequestOptions = Opts.RequestOptions;
@@ -1214,5 +1220,11 @@ export declare namespace LightsparkGrid {
     type VerificationSubmitParams as VerificationSubmitParams,
   };
 
+  export {
+    Discoveries as Discoveries,
+    type DiscoveryListResponse as DiscoveryListResponse,
+    type DiscoveryListParams as DiscoveryListParams,
+  };
+
   export type BulkCustomerImportErrorEntry = API.BulkCustomerImportErrorEntry;
 }

src/resources/discoveries.ts

@@ -0,0 +1,77 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Endpoints for discovering available payment rails, banks, and providers for a given country and currency corridor.
+ */
+export class Discoveries extends APIResource {
+  /**
+   * Retrieve available payment institution names for a given country and currency.
+   * Use this endpoint to look up supported banks and payment providers for a
+   * specific corridor. If no country and currency parameter are provided, all
+   * payment institutions will be returned
+   *
+   * The `bankName` field in each result is the value to pass as `bankName` when
+   * creating an external account via `POST /customers/external-accounts`.
+   */
+  list(
+    query: DiscoveryListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DiscoveryListResponse> {
+    return this._client.get('/discoveries', { query, ...options });
+  }
+}
+
+export interface DiscoveryListResponse {
+  /**
+   * List of payment rails matching the filter criteria
+   */
+  data?: Array<DiscoveryListResponse.Data>;
+}
+
+export namespace DiscoveryListResponse {
+  export interface Data {
+    /**
+     * Canonical name for this payment rail. Pass this value as `bankName` when
+     * creating an external account.
+     */
+    bankName: string;
+
+    /**
+     * ISO 3166-1 alpha-2 country code.
+     */
+    country: string;
+
+    /**
+     * ISO 4217 currency code.
+     */
+    currency: string;
+
+    /**
+     * Human-friendly display name for this payment rail.
+     */
+    displayName: string;
+  }
+}
+
+export interface DiscoveryListParams {
+  /**
+   * ISO 3166-1 alpha-2 country code (e.g. PH)
+   */
+  country?: string;
+
+  /**
+   * ISO 4217 currency code (e.g. PHP)
+   */
+  currency?: string;
+}
+
+export declare namespace Discoveries {
+  export {
+    type DiscoveryListResponse as DiscoveryListResponse,
+    type DiscoveryListParams as DiscoveryListParams,
+  };
+}

src/resources/index.ts

@@ -42,6 +42,7 @@ export {
   type CustomerListInternalAccountsParams,
   type CustomerOneovesDefaultPagination,
 } from './customers/customers';
+export { Discoveries, type DiscoveryListResponse, type DiscoveryListParams } from './discoveries';
 export {
   Documents,
   type DocumentRetrieveResponse,

tests/api-resources/discoveries.test.ts

@@ -0,0 +1,34 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import LightsparkGrid from '@lightsparkdev/grid';
+
+const client = new LightsparkGrid({
+  username: 'My Username',
+  password: 'My Password',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
+
+describe('resource discoveries', () => {
+  // Mock server tests are disabled
+  test.skip('list', async () => {
+    const responsePromise = client.discoveries.list();
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    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.discoveries.list(
+        { country: 'country', currency: 'currency' },
+        { path: '/_stainless_unknown_path' },
+      ),
+    ).rejects.toThrow(LightsparkGrid.NotFoundError);
+  });
+});