feat(api): update via SDK Studio (#7)

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 7
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/open-transit%2Fopen-transit-2243a7233ce0fdfe90a6a1730f6a735432cd55037ac60b32c613fa7b6838b432.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/open-transit%2Fopen-transit-3c09ec2f8c094abffea8b1f8d2f410de855fd69e855be9f4823fb7b9eda7a3db.yml

api.md

@@ -23,7 +23,7 @@ Types:
 
 Methods:
 
-- <code title="get /api/where/agency/{agencyID}.json">client.agency.<a href="./src/resources/agency.ts">retrieve</a>(agencyId) -> AgencyRetrieveResponse</code>
+- <code title="get /api/where/agency/{agencyID}.json">client.agency.<a href="./src/resources/agency.ts">retrieve</a>(agencyId, { ...params }) -> AgencyRetrieveResponse</code>
 
 # Config
 

src/index.ts

@@ -189,6 +189,7 @@ export namespace OnebusawaySDK {
 
   export import Agency = API.Agency;
   export import AgencyRetrieveResponse = API.AgencyRetrieveResponse;
+  export import AgencyRetrieveParams = API.AgencyRetrieveParams;
 
   export import Config = API.Config;
   export import ConfigRetrieveResponse = API.ConfigRetrieveResponse;

src/resources/agency.ts

@@ -7,10 +7,14 @@ import * as Shared from './shared';
 
 export class Agency extends APIResource {
   /**
-   * Retrieve info for a specific transit agency identified by id
+   * Retrieve information for a specific transit agency identified by its unique ID.
    */
-  retrieve(agencyId: string, options?: Core.RequestOptions): Core.APIPromise<AgencyRetrieveResponse> {
-    return this._client.get(`/api/where/agency/agencyID.json`, options);
+  retrieve(
+    agencyId: string,
+    query: AgencyRetrieveParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<AgencyRetrieveResponse> {
+    return this._client.get(`/api/where/agency/agencyID.json`, { query, ...options });
   }
 }
 
@@ -50,6 +54,14 @@ export namespace AgencyRetrieveResponse {
   }
 }
 
+export interface AgencyRetrieveParams {
+  /**
+   * API key for authentication.
+   */
+  key: string;
+}
+
 export namespace Agency {
   export import AgencyRetrieveResponse = AgencyAPI.AgencyRetrieveResponse;
+  export import AgencyRetrieveParams = AgencyAPI.AgencyRetrieveParams;
 }

src/resources/index.ts

@@ -2,7 +2,7 @@
 
 export * from './shared';
 export { AgenciesWithCoverageRetrieveResponse, AgenciesWithCoverage } from './agencies-with-coverage';
-export { AgencyRetrieveResponse, Agency } from './agency';
+export { AgencyRetrieveResponse, AgencyRetrieveParams, Agency } from './agency';
 export {
   ArrivalAndDepartureForStopRetrieveResponse,
   ArrivalAndDepartureForStopRetrieveParams,

tests/api-resources/agency.test.ts

@@ -9,8 +9,8 @@ const onebusawaySDK = new OnebusawaySDK({
 });
 
 describe('resource agency', () => {
-  test('retrieve', async () => {
-    const responsePromise = onebusawaySDK.agency.retrieve('string');
+  test('retrieve: only required params', async () => {
+    const responsePromise = onebusawaySDK.agency.retrieve('string', { key: 'string' });
     const rawResponse = await responsePromise.asResponse();
     expect(rawResponse).toBeInstanceOf(Response);
     const response = await responsePromise;
@@ -20,10 +20,7 @@ describe('resource agency', () => {
     expect(dataAndResponse.response).toBe(rawResponse);
   });
 
-  test('retrieve: request options instead of 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(
-      onebusawaySDK.agency.retrieve('string', { path: '/_stainless_unknown_path' }),
-    ).rejects.toThrow(OnebusawaySDK.NotFoundError);
+  test('retrieve: required and optional params', async () => {
+    const response = await onebusawaySDK.agency.retrieve('string', { key: 'string' });
   });
 });