release: 1.5.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.4.0"
+  ".": "1.5.0"
 }

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 28
+configured_endpoints: 29
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/open-transit%2Fopen-transit-6f08502508c8ad25235971add3124a1cde4f1c3ec705d5df455d750e0adcb90b.yml

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.5.0 (2024-11-29)
+
+Full Changelog: [v1.4.0...v1.5.0](https://github.com/OneBusAway/js-sdk/compare/v1.4.0...v1.5.0)
+
+### Features
+
+* **api:** api update ([#268](https://github.com/OneBusAway/js-sdk/issues/268)) ([aae3f08](https://github.com/OneBusAway/js-sdk/commit/aae3f08995e6fad2f89ac0ca1702af39152d0363))
+
 ## 1.4.0 (2024-11-29)
 
 Full Changelog: [v1.3.0...v1.4.0](https://github.com/OneBusAway/js-sdk/compare/v1.3.0...v1.4.0)

api.md

@@ -75,6 +75,16 @@ Methods:
 
 - <code title="get /api/where/stops-for-route/{routeID}.json">client.stopsForRoute.<a href="./src/resources/stops-for-route.ts">list</a>(routeId, { ...params }) -> StopsForRouteListResponse</code>
 
+# StopsForAgency
+
+Types:
+
+- <code><a href="./src/resources/stops-for-agency.ts">StopsForAgencyListResponse</a></code>
+
+Methods:
+
+- <code title="get /api/where/stops-for-agency/{agencyID}.json">client.stopsForAgency.<a href="./src/resources/stops-for-agency.ts">list</a>(agencyId) -> StopsForAgencyListResponse</code>
+
 # Stop
 
 Types:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "onebusaway-sdk",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "The official TypeScript library for the Onebusaway SDK API",
   "author": "Onebusaway SDK <info@onebusaway.org>",
   "types": "dist/index.d.ts",

src/index.ts

@@ -56,6 +56,7 @@ import {
 import { Shape, ShapeRetrieveResponse } from './resources/shape';
 import { Stop, StopRetrieveResponse } from './resources/stop';
 import { StopIDsForAgency, StopIDsForAgencyListResponse } from './resources/stop-ids-for-agency';
+import { StopsForAgency, StopsForAgencyListResponse } from './resources/stops-for-agency';
 import {
   StopsForLocation,
   StopsForLocationListParams,
@@ -209,6 +210,7 @@ export class OnebusawaySDK extends Core.APIClient {
   currentTime: API.CurrentTime = new API.CurrentTime(this);
   stopsForLocation: API.StopsForLocation = new API.StopsForLocation(this);
   stopsForRoute: API.StopsForRoute = new API.StopsForRoute(this);
+  stopsForAgency: API.StopsForAgency = new API.StopsForAgency(this);
   stop: API.Stop = new API.Stop(this);
   stopIdsForAgency: API.StopIDsForAgency = new API.StopIDsForAgency(this);
   scheduleForStop: API.ScheduleForStop = new API.ScheduleForStop(this);
@@ -276,6 +278,7 @@ OnebusawaySDK.Config = Config;
 OnebusawaySDK.CurrentTime = CurrentTime;
 OnebusawaySDK.StopsForLocation = StopsForLocation;
 OnebusawaySDK.StopsForRoute = StopsForRoute;
+OnebusawaySDK.StopsForAgency = StopsForAgency;
 OnebusawaySDK.Stop = Stop;
 OnebusawaySDK.StopIDsForAgency = StopIDsForAgency;
 OnebusawaySDK.ScheduleForStop = ScheduleForStop;
@@ -328,6 +331,8 @@ export declare namespace OnebusawaySDK {
     type StopsForRouteListParams as StopsForRouteListParams,
   };
 
+  export { StopsForAgency as StopsForAgency, type StopsForAgencyListResponse as StopsForAgencyListResponse };
+
   export { Stop as Stop, type StopRetrieveResponse as StopRetrieveResponse };
 
   export {

src/resources/index.ts

@@ -46,6 +46,7 @@ export {
 export { Shape, type ShapeRetrieveResponse } from './shape';
 export { Stop, type StopRetrieveResponse } from './stop';
 export { StopIDsForAgency, type StopIDsForAgencyListResponse } from './stop-ids-for-agency';
+export { StopsForAgency, type StopsForAgencyListResponse } from './stops-for-agency';
 export {
   StopsForLocation,
   type StopsForLocationListResponse,

src/resources/stops-for-agency.ts

@@ -0,0 +1,54 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import * as Core from '../core';
+import * as Shared from './shared';
+
+export class StopsForAgency extends APIResource {
+  /**
+   * Get stops for a specific agency
+   */
+  list(agencyId: string, options?: Core.RequestOptions): Core.APIPromise<StopsForAgencyListResponse> {
+    return this._client.get(`/api/where/stops-for-agency/${agencyId}.json`, options);
+  }
+}
+
+export interface StopsForAgencyListResponse extends Shared.ResponseWrapper {
+  limitExceeded: boolean;
+
+  list: Array<StopsForAgencyListResponse.List>;
+
+  references: Shared.References;
+
+  outOfRange?: boolean;
+}
+
+export namespace StopsForAgencyListResponse {
+  export interface List {
+    id: string;
+
+    lat: number;
+
+    lon: number;
+
+    name: string;
+
+    parent: string;
+
+    routeIds: Array<string>;
+
+    staticRouteIds: Array<string>;
+
+    code?: string;
+
+    direction?: string;
+
+    locationType?: number;
+
+    wheelchairBoarding?: string;
+  }
+}
+
+export declare namespace StopsForAgency {
+  export { type StopsForAgencyListResponse as StopsForAgencyListResponse };
+}

src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.4.0'; // x-release-please-version
+export const VERSION = '1.5.0'; // x-release-please-version

tests/api-resources/stops-for-agency.test.ts

@@ -0,0 +1,29 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import OnebusawaySDK from 'onebusaway-sdk';
+import { Response } from 'node-fetch';
+
+const client = new OnebusawaySDK({
+  apiKey: 'My API Key',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
+
+describe('resource stopsForAgency', () => {
+  test('list', async () => {
+    const responsePromise = client.stopsForAgency.list('agencyID');
+    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);
+  });
+
+  test('list: 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(
+      client.stopsForAgency.list('agencyID', { path: '/_stainless_unknown_path' }),
+    ).rejects.toThrow(OnebusawaySDK.NotFoundError);
+  });
+});