Merge pull request #189 from OneBusAway/release-please--branches--mai…

…n--changes--next--components--onebusaway-sdk

release: 0.1.0-alpha.40

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.39"
+  ".": "0.1.0-alpha.40"
 }

.stats.yml

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

CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 0.1.0-alpha.40 (2024-08-20)
+
+Full Changelog: [v0.1.0-alpha.39...v0.1.0-alpha.40](https://github.com/OneBusAway/js-sdk/compare/v0.1.0-alpha.39...v0.1.0-alpha.40)
+
+### Features
+
+* **api:** OpenAPI spec update via Stainless API ([#188](https://github.com/OneBusAway/js-sdk/issues/188)) ([81208e6](https://github.com/OneBusAway/js-sdk/commit/81208e62a52714dae490a6544ec64076e2af20dc))
+* **api:** OpenAPI spec update via Stainless API ([#191](https://github.com/OneBusAway/js-sdk/issues/191)) ([1edcc74](https://github.com/OneBusAway/js-sdk/commit/1edcc746cfd7f36d93ab371901af7f0a6bfeaa1f))
+* **api:** OpenAPI spec update via Stainless API ([#192](https://github.com/OneBusAway/js-sdk/issues/192)) ([18b4067](https://github.com/OneBusAway/js-sdk/commit/18b40671fcbc150188bb028525c4e9115ebd40be))
+* **api:** OpenAPI spec update via Stainless API ([#193](https://github.com/OneBusAway/js-sdk/issues/193)) ([4997727](https://github.com/OneBusAway/js-sdk/commit/49977278ae1a3c8449295eddedbb9f311da51025))
+* **api:** OpenAPI spec update via Stainless API ([#194](https://github.com/OneBusAway/js-sdk/issues/194)) ([35bfd3d](https://github.com/OneBusAway/js-sdk/commit/35bfd3d94b03281c7e33a5f2f94d3fb244c05d13))
+* **api:** OpenAPI spec update via Stainless API ([#195](https://github.com/OneBusAway/js-sdk/issues/195)) ([bc5e2aa](https://github.com/OneBusAway/js-sdk/commit/bc5e2aa21877f1f0cd15d717c1adadde32180f81))
+* **api:** OpenAPI spec update via Stainless API ([#196](https://github.com/OneBusAway/js-sdk/issues/196)) ([1a8a509](https://github.com/OneBusAway/js-sdk/commit/1a8a50992eef459c1c37ef6ee7a076235104ef1c))
+* **api:** OpenAPI spec update via Stainless API ([#197](https://github.com/OneBusAway/js-sdk/issues/197)) ([888162a](https://github.com/OneBusAway/js-sdk/commit/888162a1e29c7357be7bead60b9f6ede810f564f))
+* **api:** OpenAPI spec update via Stainless API ([#198](https://github.com/OneBusAway/js-sdk/issues/198)) ([712e991](https://github.com/OneBusAway/js-sdk/commit/712e9914645a5e19482e27262e2d1635ec1a9905))
+* **api:** OpenAPI spec update via Stainless API ([#199](https://github.com/OneBusAway/js-sdk/issues/199)) ([ffe2b91](https://github.com/OneBusAway/js-sdk/commit/ffe2b919c3b8d9e973a37fcba054c41bf705bc43))
+* **api:** OpenAPI spec update via Stainless API ([#200](https://github.com/OneBusAway/js-sdk/issues/200)) ([4f2a3a3](https://github.com/OneBusAway/js-sdk/commit/4f2a3a32074cb49a4f036dc63c62820d608730c2))
+
+
+### Chores
+
+* **internal:** codegen related update ([#190](https://github.com/OneBusAway/js-sdk/issues/190)) ([faff47d](https://github.com/OneBusAway/js-sdk/commit/faff47d9d53b81f6127e6b5250b20cd45cbf7bc3))
+
 ## 0.1.0-alpha.39 (2024-08-12)
 
 Full Changelog: [v0.1.0-alpha.38...v0.1.0-alpha.39](https://github.com/OneBusAway/js-sdk/compare/v0.1.0-alpha.38...v0.1.0-alpha.39)

api.md

@@ -9,11 +9,11 @@ Types:
 
 Types:
 
-- <code><a href="./src/resources/agencies-with-coverage.ts">AgenciesWithCoverageRetrieveResponse</a></code>
+- <code><a href="./src/resources/agencies-with-coverage.ts">AgenciesWithCoverageListResponse</a></code>
 
 Methods:
 
-- <code title="get /api/where/agencies-with-coverage.json">client.agenciesWithCoverage.<a href="./src/resources/agencies-with-coverage.ts">retrieve</a>() -> AgenciesWithCoverageRetrieveResponse</code>
+- <code title="get /api/where/agencies-with-coverage.json">client.agenciesWithCoverage.<a href="./src/resources/agencies-with-coverage.ts">list</a>() -> AgenciesWithCoverageListResponse</code>
 
 # Agency
 
@@ -59,11 +59,11 @@ Methods:
 
 Types:
 
-- <code><a href="./src/resources/stops-for-location.ts">StopsForLocationRetrieveResponse</a></code>
+- <code><a href="./src/resources/stops-for-location.ts">StopsForLocationListResponse</a></code>
 
 Methods:
 
-- <code title="get /api/where/stops-for-location.json">client.stopsForLocation.<a href="./src/resources/stops-for-location.ts">retrieve</a>({ ...params }) -> StopsForLocationRetrieveResponse</code>
+- <code title="get /api/where/stops-for-location.json">client.stopsForLocation.<a href="./src/resources/stops-for-location.ts">list</a>({ ...params }) -> StopsForLocationListResponse</code>
 
 # StopsForRoute
 
@@ -129,11 +129,11 @@ Methods:
 
 Types:
 
-- <code><a href="./src/resources/routes-for-location.ts">RoutesForLocationRetrieveResponse</a></code>
+- <code><a href="./src/resources/routes-for-location.ts">RoutesForLocationListResponse</a></code>
 
 Methods:
 
-- <code title="get /api/where/routes-for-location.json">client.routesForLocation.<a href="./src/resources/routes-for-location.ts">retrieve</a>({ ...params }) -> RoutesForLocationRetrieveResponse</code>
+- <code title="get /api/where/routes-for-location.json">client.routesForLocation.<a href="./src/resources/routes-for-location.ts">list</a>({ ...params }) -> RoutesForLocationListResponse</code>
 
 # RoutesForAgency
 
@@ -181,11 +181,11 @@ Methods:
 
 Types:
 
-- <code><a href="./src/resources/trips-for-location.ts">TripsForLocationRetrieveResponse</a></code>
+- <code><a href="./src/resources/trips-for-location.ts">TripsForLocationListResponse</a></code>
 
 Methods:
 
-- <code title="get /api/where/trips-for-location.json">client.tripsForLocation.<a href="./src/resources/trips-for-location.ts">retrieve</a>({ ...params }) -> TripsForLocationRetrieveResponse</code>
+- <code title="get /api/where/trips-for-location.json">client.tripsForLocation.<a href="./src/resources/trips-for-location.ts">list</a>({ ...params }) -> TripsForLocationListResponse</code>
 
 # TripDetails
 
@@ -207,6 +207,16 @@ Methods:
 
 - <code title="get /api/where/trip-for-vehicle/{vehicleID}.json">client.tripForVehicle.<a href="./src/resources/trip-for-vehicle.ts">retrieve</a>(vehicleId, { ...params }) -> TripForVehicleRetrieveResponse</code>
 
+# TripsForRoute
+
+Types:
+
+- <code><a href="./src/resources/trips-for-route.ts">TripsForRouteListResponse</a></code>
+
+Methods:
+
+- <code title="get /api/where/trips-for-route/{routeID}.json">client.tripsForRoute.<a href="./src/resources/trips-for-route.ts">list</a>(routeId, { ...params }) -> TripsForRouteListResponse</code>
+
 # ReportProblemWithStop
 
 Methods:

examples/agencies-with-coverage.mjs

@@ -13,7 +13,7 @@ const settings = loadSettings({
 const oba = new onebusaway(settings);
 
 async function main() {
-  const response = await oba.agenciesWithCoverage.retrieve();
+  const response = await oba.agenciesWithCoverage.list();
   console.log(response.data);
 }
 

examples/routes-for-location.mjs

@@ -0,0 +1,26 @@
+import onebusaway from '../dist/index.mjs';
+import { loadSettings } from './helpers/load-env.mjs';
+
+// Load settings from .env file, if it exists. If not, we'll use the
+// Puget Sound server URL (which is also the default in the SDK) and
+// the 'TEST' API key.
+const settings = loadSettings({
+  apiKey: 'TEST',
+  baseUrl: 'https://api.pugetsound.onebusaway.org/',
+});
+
+// Create a new instance of the OneBusAway SDK with the settings we loaded.
+const oba = new onebusaway(settings);
+
+async function main() {
+  const query = {
+    lat: 47.6097, // required, type your latitude here
+    lon: -122.3331, // required, type your longitude here
+  };
+
+  const response = await oba.routesForLocation.list(query);
+
+  console.log(response.data);
+}
+
+main();

examples/schedule-for-route.mjs

@@ -0,0 +1,27 @@
+import onebusaway from '../dist/index.mjs';
+import { loadSettings } from './helpers/load-env.mjs';
+
+// Load settings from .env file, if it exists. If not, we'll use the
+// Puget Sound server URL (which is also the default in the SDK) and
+// the 'TEST' API key.
+const settings = loadSettings({
+  apiKey: 'TEST',
+  baseUrl: 'https://api.pugetsound.onebusaway.org/',
+});
+
+// Create a new instance of the OneBusAway SDK with the settings we loaded.
+const oba = new onebusaway(settings);
+
+async function main() {
+  const routeId = '1_100223';
+
+  const query = {
+    date: '2024-08-20', // response code 510 - returned if the route has no schedules for the day requested
+  };
+
+  const response = await oba.scheduleForRoute.retrieve(routeId, query);
+
+  console.log(response.data);
+}
+
+main();

examples/stops-for-location.mjs

@@ -13,7 +13,7 @@ const settings = loadSettings({
 const oba = new onebusaway(settings);
 
 async function main() {
-  const spaceNeedleStops = await oba.stopsForLocation.retrieve({
+  const spaceNeedleStops = await oba.stopsForLocation.list({
     lat: 47.6205,
     lon: -122.3493,
     radius: 500,

examples/trips-for-route.mjs

@@ -0,0 +1,20 @@
+import onebusaway from '../dist/index.mjs';
+import { loadSettings } from './helpers/load-env.mjs';
+
+// Load settings from .env file, if it exists. If not, we'll use the
+// Puget Sound server URL (which is also the default in the SDK) and
+// the 'TEST' API key.
+const settings = loadSettings({
+  apiKey: 'TEST',
+  baseUrl: 'https://api.pugetsound.onebusaway.org/',
+});
+
+// Create a new instance of the OneBusAway SDK with the settings we loaded.
+const oba = new onebusaway(settings);
+
+async function main() {
+  const response = await oba.tripsForRoute.list('1_100224');
+  console.log(response.data.list[0]);
+}
+
+main();

package.json

@@ -1,6 +1,6 @@
 {
   "name": "onebusaway-sdk",
-  "version": "0.1.0-alpha.39",
+  "version": "0.1.0-alpha.40",
   "description": "The official TypeScript library for the Onebusaway SDK API",
   "author": "Onebusaway SDK <[email protected]>",
   "types": "dist/index.d.ts",

src/index.ts

@@ -139,6 +139,7 @@ export class OnebusawaySDK extends Core.APIClient {
   tripsForLocation: API.TripsForLocation = new API.TripsForLocation(this);
   tripDetails: API.TripDetails = new API.TripDetails(this);
   tripForVehicle: API.TripForVehicle = new API.TripForVehicle(this);
+  tripsForRoute: API.TripsForRoute = new API.TripsForRoute(this);
   reportProblemWithStop: API.ReportProblemWithStop = new API.ReportProblemWithStop(this);
   reportProblemWithTrip: API.ReportProblemWithTrip = new API.ReportProblemWithTrip(this);
   searchForStop: API.SearchForStop = new API.SearchForStop(this);
@@ -208,7 +209,7 @@ export namespace OnebusawaySDK {
   export import RequestOptions = Core.RequestOptions;
 
   export import AgenciesWithCoverage = API.AgenciesWithCoverage;
-  export import AgenciesWithCoverageRetrieveResponse = API.AgenciesWithCoverageRetrieveResponse;
+  export import AgenciesWithCoverageListResponse = API.AgenciesWithCoverageListResponse;
 
   export import Agency = API.Agency;
   export import AgencyRetrieveResponse = API.AgencyRetrieveResponse;
@@ -224,8 +225,8 @@ export namespace OnebusawaySDK {
   export import CurrentTimeRetrieveResponse = API.CurrentTimeRetrieveResponse;
 
   export import StopsForLocation = API.StopsForLocation;
-  export import StopsForLocationRetrieveResponse = API.StopsForLocationRetrieveResponse;
-  export import StopsForLocationRetrieveParams = API.StopsForLocationRetrieveParams;
+  export import StopsForLocationListResponse = API.StopsForLocationListResponse;
+  export import StopsForLocationListParams = API.StopsForLocationListParams;
 
   export import StopsForRoute = API.StopsForRoute;
   export import StopsForRouteListResponse = API.StopsForRouteListResponse;
@@ -248,8 +249,8 @@ export namespace OnebusawaySDK {
   export import RouteIDsForAgencyListResponse = API.RouteIDsForAgencyListResponse;
 
   export import RoutesForLocation = API.RoutesForLocation;
-  export import RoutesForLocationRetrieveResponse = API.RoutesForLocationRetrieveResponse;
-  export import RoutesForLocationRetrieveParams = API.RoutesForLocationRetrieveParams;
+  export import RoutesForLocationListResponse = API.RoutesForLocationListResponse;
+  export import RoutesForLocationListParams = API.RoutesForLocationListParams;
 
   export import RoutesForAgency = API.RoutesForAgency;
   export import RoutesForAgencyListResponse = API.RoutesForAgencyListResponse;
@@ -268,8 +269,8 @@ export namespace OnebusawaySDK {
   export import TripRetrieveResponse = API.TripRetrieveResponse;
 
   export import TripsForLocation = API.TripsForLocation;
-  export import TripsForLocationRetrieveResponse = API.TripsForLocationRetrieveResponse;
-  export import TripsForLocationRetrieveParams = API.TripsForLocationRetrieveParams;
+  export import TripsForLocationListResponse = API.TripsForLocationListResponse;
+  export import TripsForLocationListParams = API.TripsForLocationListParams;
 
   export import TripDetails = API.TripDetails;
   export import TripDetailRetrieveResponse = API.TripDetailRetrieveResponse;
@@ -279,6 +280,10 @@ export namespace OnebusawaySDK {
   export import TripForVehicleRetrieveResponse = API.TripForVehicleRetrieveResponse;
   export import TripForVehicleRetrieveParams = API.TripForVehicleRetrieveParams;
 
+  export import TripsForRoute = API.TripsForRoute;
+  export import TripsForRouteListResponse = API.TripsForRouteListResponse;
+  export import TripsForRouteListParams = API.TripsForRouteListParams;
+
   export import ReportProblemWithStop = API.ReportProblemWithStop;
   export import ReportProblemWithStopRetrieveParams = API.ReportProblemWithStopRetrieveParams;
 

src/resources/agencies-with-coverage.ts

@@ -7,24 +7,25 @@ import * as Shared from './shared';
 
 export class AgenciesWithCoverage extends APIResource {
   /**
-   * Retrieve Agencies with Coverage
+   * Returns a list of all transit agencies currently supported by OneBusAway along
+   * with the center of their coverage area.
    */
-  retrieve(options?: Core.RequestOptions): Core.APIPromise<AgenciesWithCoverageRetrieveResponse> {
+  list(options?: Core.RequestOptions): Core.APIPromise<AgenciesWithCoverageListResponse> {
     return this._client.get('/api/where/agencies-with-coverage.json', options);
   }
 }
 
-export interface AgenciesWithCoverageRetrieveResponse extends Shared.ResponseWrapper {
-  data: AgenciesWithCoverageRetrieveResponse.Data;
+export interface AgenciesWithCoverageListResponse extends Shared.ResponseWrapper {
+  data: AgenciesWithCoverageListResponse.Data;
 }
 
-export namespace AgenciesWithCoverageRetrieveResponse {
+export namespace AgenciesWithCoverageListResponse {
   export interface Data {
+    limitExceeded: boolean;
+
     list: Array<Data.List>;
 
     references: Shared.References;
-
-    limitExceeded?: boolean;
   }
 
   export namespace Data {
@@ -43,5 +44,5 @@ export namespace AgenciesWithCoverageRetrieveResponse {
 }
 
 export namespace AgenciesWithCoverage {
-  export import AgenciesWithCoverageRetrieveResponse = AgenciesWithCoverageAPI.AgenciesWithCoverageRetrieveResponse;
+  export import AgenciesWithCoverageListResponse = AgenciesWithCoverageAPI.AgenciesWithCoverageListResponse;
 }

src/resources/agency.ts

@@ -22,9 +22,9 @@ export namespace AgencyRetrieveResponse {
   export interface Data {
     entry: Data.Entry;
 
-    references: Shared.References;
+    limitExceeded: boolean;
 
-    limitExceeded?: boolean;
+    references: Shared.References;
   }
 
   export namespace Data {