@hasadna/open-bus-api-client
Version:
A client library for interacting with the Open-Bus API.
174 lines (173 loc) • 10.6 kB
JavaScript
/* tslint:disable */
/* eslint-disable */
/**
* Open Bus Stride API
* ### Follow planned and real-time bus statistics 🚌 Welcome to The Public Knowledge Workshop\'s Stride project. We provide usable and accurate data about the Israeli public transportation system. For background on the project and some more detailed documentation and usage guides, see [STRIDE.md](https://github.com/hasadna/open-bus-pipelines/blob/main/STRIDE.md). Looking for a specific use-case? * Take a look at the **user cases** APIs below. * Try one of our existing [jupyter notebooks](https://github.com/hasadna/open-bus-stride-client/blob/main/README.md#using-the-interactive-jupyter-notebooks). * Don\'t see your use-case covered here? Please [open us a ticket](https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fhasadna%2Fopen-bus%2Fissues%2Fnew)! Queries are by default limited to 100 results per query, this limit can be increased up to 500,000 results. Please try to set appropriate query parameters to limit the results to reduce load on our DB. If you do need to get large number of results (up to 500,000) it\'s recommended to use one of these methods: 1. Use HTTP streaming and JSON streaming decoder, this method is most efficient and provide accurate results. Our [Stride Python Client iterate method](https://github.com/hasadna/open-bus-stride-client#usage) uses this method. 2. Use combination of limit / offset parameters to get results by page. This method may be less accurate because it depends on data remaining unchanged between requests. For more advanced usage- * Use **gtfs** for data about the planned lines timetables. * Use **siri** for data about lines real-time * See [Open Bus Stride Data Model](https://github.com/hasadna/open-bus-stride-db/blob/main/DATA_MODEL.md) for description of field and table names. * See [Open Bus Stride ETL Processes](https://github.com/hasadna/open-bus-pipelines/blob/main/STRIDE_ETL_PROCESSES.md) for description of the ETL processes which fetch and aggregate the data. * See [MOT Developer Information](https://www.gov.il/BlobFolder/generalpage/gtfs_general_transit_feed_specifications/he/GTFS%20-%20Developer%20Information.pdf) for description of the source fields as published by the Israel Ministry of Transportation.
*
* The version of the OpenAPI document: 6909b3db7b8bfa5ac3f3c4aeb3de80d2a2c75810
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
import * as runtime from '../runtime';
import { RideExecutionPydanticModelFromJSON, RouteTimetablePydanticModelFromJSON, StopArrivalPydanticModelFromJSON, } from '../models/index';
/**
*
*/
export class UserCasesApi extends runtime.BaseAPI {
/**
* List of A comparison between the planned and actual rides of a specific route between the given dates. Currently, the \"actual_rides_count\", will be either None (no actual ride) or equal to the \"planned_rides_count.
* List
*/
ridesExecutionListGetRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['dateFrom'] == null) {
throw new runtime.RequiredError('dateFrom', 'Required parameter "dateFrom" was null or undefined when calling ridesExecutionListGet().');
}
if (requestParameters['dateTo'] == null) {
throw new runtime.RequiredError('dateTo', 'Required parameter "dateTo" was null or undefined when calling ridesExecutionListGet().');
}
const queryParameters = {};
if (requestParameters['limit'] != null) {
queryParameters['limit'] = requestParameters['limit'];
}
if (requestParameters['offset'] != null) {
queryParameters['offset'] = requestParameters['offset'];
}
if (requestParameters['getCount'] != null) {
queryParameters['get_count'] = requestParameters['getCount'];
}
if (requestParameters['dateFrom'] != null) {
queryParameters['date_from'] = requestParameters['dateFrom'].toISOString().substring(0, 10);
}
if (requestParameters['dateTo'] != null) {
queryParameters['date_to'] = requestParameters['dateTo'].toISOString().substring(0, 10);
}
if (requestParameters['operatorRef'] != null) {
queryParameters['operator_ref'] = requestParameters['operatorRef'];
}
if (requestParameters['lineRef'] != null) {
queryParameters['line_ref'] = requestParameters['lineRef'];
}
const headerParameters = {};
let urlPath = `/rides_execution/list`;
const response = yield this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(RideExecutionPydanticModelFromJSON));
});
}
/**
* List of A comparison between the planned and actual rides of a specific route between the given dates. Currently, the \"actual_rides_count\", will be either None (no actual ride) or equal to the \"planned_rides_count.
* List
*/
ridesExecutionListGet(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.ridesExecutionListGetRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* List of the stops timetable of a given bus. Currently, only planned time (gtfs) is returned for every stop.
* List
*/
routeTimetableListGetRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const queryParameters = {};
if (requestParameters['limit'] != null) {
queryParameters['limit'] = requestParameters['limit'];
}
if (requestParameters['offset'] != null) {
queryParameters['offset'] = requestParameters['offset'];
}
if (requestParameters['getCount'] != null) {
queryParameters['get_count'] = requestParameters['getCount'];
}
if (requestParameters['plannedStartTimeDateFrom'] != null) {
queryParameters['planned_start_time_date_from'] = requestParameters['plannedStartTimeDateFrom'].toISOString();
}
if (requestParameters['plannedStartTimeDateTo'] != null) {
queryParameters['planned_start_time_date_to'] = requestParameters['plannedStartTimeDateTo'].toISOString();
}
if (requestParameters['lineRefs'] != null) {
queryParameters['line_refs'] = requestParameters['lineRefs'];
}
const headerParameters = {};
let urlPath = `/route_timetable/list`;
const response = yield this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(RouteTimetablePydanticModelFromJSON));
});
}
/**
* List of the stops timetable of a given bus. Currently, only planned time (gtfs) is returned for every stop.
* List
*/
routeTimetableListGet() {
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
const response = yield this.routeTimetableListGetRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* List of the actual arrival times to a specific stop. Currently, only planned time (gtfs) is returned for every stop.
* List
*/
stopArrivalsListGetRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const queryParameters = {};
if (requestParameters['limit'] != null) {
queryParameters['limit'] = requestParameters['limit'];
}
if (requestParameters['offset'] != null) {
queryParameters['offset'] = requestParameters['offset'];
}
if (requestParameters['getCount'] != null) {
queryParameters['get_count'] = requestParameters['getCount'];
}
if (requestParameters['gtfsStopId'] != null) {
queryParameters['gtfs_stop_id'] = requestParameters['gtfsStopId'];
}
if (requestParameters['gtfsRideIds'] != null) {
queryParameters['gtfs_ride_ids'] = requestParameters['gtfsRideIds'];
}
const headerParameters = {};
let urlPath = `/stop_arrivals/list`;
const response = yield this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(StopArrivalPydanticModelFromJSON));
});
}
/**
* List of the actual arrival times to a specific stop. Currently, only planned time (gtfs) is returned for every stop.
* List
*/
stopArrivalsListGet() {
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
const response = yield this.stopArrivalsListGetRaw(requestParameters, initOverrides);
return yield response.value();
});
}
}