@hasadna/open-bus-api-client
Version:
A client library for interacting with the Open-Bus API.
334 lines (333 loc) • 16.1 kB
JavaScript
"use strict";
/* 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());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.GovernmentTransportationApi = void 0;
const runtime = require("../runtime");
const index_1 = require("../models/index");
/**
*
*/
class GovernmentTransportationApi extends runtime.BaseAPI {
/**
* Retrieve list of cities
* Get cities
*/
govCitiesGetRaw(initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const queryParameters = {};
const headerParameters = {};
let urlPath = `/gov/cities`;
const response = yield this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GovCitiesGet200ResponseFromJSON)(jsonValue));
});
}
/**
* Retrieve list of cities
* Get cities
*/
govCitiesGet(initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.govCitiesGetRaw(initOverrides);
return yield response.value();
});
}
/**
* Retrieve bus lines by specific line ID
* Get lines by line ID
*/
govLinesByLinePostRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['govLinesByLinePostRequest'] == null) {
throw new runtime.RequiredError('govLinesByLinePostRequest', 'Required parameter "govLinesByLinePostRequest" was null or undefined when calling govLinesByLinePost().');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
let urlPath = `/gov/lines-by-line`;
const response = yield this.request({
path: urlPath,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.GovLinesByLinePostRequestToJSON)(requestParameters['govLinesByLinePostRequest']),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GovLinesByStationPost200ResponseFromJSON)(jsonValue));
});
}
/**
* Retrieve bus lines by specific line ID
* Get lines by line ID
*/
govLinesByLinePost(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.govLinesByLinePostRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Retrieve bus lines available at a specific station
* Get bus lines by station
*/
govLinesByStationPostRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['govLinesByStationPostRequest'] == null) {
throw new runtime.RequiredError('govLinesByStationPostRequest', 'Required parameter "govLinesByStationPostRequest" was null or undefined when calling govLinesByStationPost().');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
let urlPath = `/gov/lines-by-station`;
const response = yield this.request({
path: urlPath,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.GovLinesByStationPostRequestToJSON)(requestParameters['govLinesByStationPostRequest']),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GovLinesByStationPost200ResponseFromJSON)(jsonValue));
});
}
/**
* Retrieve bus lines available at a specific station
* Get bus lines by station
*/
govLinesByStationPost(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.govLinesByStationPostRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Retrieve not real numbers list for testing
* Get not real numbers (Testing)
*/
govNotRealNumbersGetRaw(initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const queryParameters = {};
const headerParameters = {};
let urlPath = `/gov/not-real-numbers`;
const response = yield this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GovNotRealNumbersGet200ResponseFromJSON)(jsonValue));
});
}
/**
* Retrieve not real numbers list for testing
* Get not real numbers (Testing)
*/
govNotRealNumbersGet(initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.govNotRealNumbersGetRaw(initOverrides);
return yield response.value();
});
}
/**
* Retrieve list of operators
* Get operators
*/
govOperatorsGetRaw(initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const queryParameters = {};
const headerParameters = {};
let urlPath = `/gov/operators`;
const response = yield this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GovOperatorsGet200ResponseFromJSON)(jsonValue));
});
}
/**
* Retrieve list of operators
* Get operators
*/
govOperatorsGet(initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.govOperatorsGetRaw(initOverrides);
return yield response.value();
});
}
/**
* Retrieve pniya list for vehicles
* Get Pniya (Vehicles type)
*/
govPniyaGetRaw(initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const queryParameters = {};
const headerParameters = {};
let urlPath = `/gov/pniya`;
const response = yield this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GovPniyaGet200ResponseFromJSON)(jsonValue));
});
}
/**
* Retrieve pniya list for vehicles
* Get Pniya (Vehicles type)
*/
govPniyaGet(initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.govPniyaGetRaw(initOverrides);
return yield response.value();
});
}
/**
* Retrieve stations for a specific bus line
* Get stations by line
*/
govStationsByLinePostRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['govStationsByLinePostRequest'] == null) {
throw new runtime.RequiredError('govStationsByLinePostRequest', 'Required parameter "govStationsByLinePostRequest" was null or undefined when calling govStationsByLinePost().');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
let urlPath = `/gov/stations-by-line`;
const response = yield this.request({
path: urlPath,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.GovStationsByLinePostRequestToJSON)(requestParameters['govStationsByLinePostRequest']),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GovStationsByLinePost200ResponseFromJSON)(jsonValue));
});
}
/**
* Retrieve stations for a specific bus line
* Get stations by line
*/
govStationsByLinePost(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.govStationsByLinePostRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Retrieve subject types for vehicles from the government list
* Get subject types for vehicles
*/
govSubjectsGetRaw(initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const queryParameters = {};
const headerParameters = {};
let urlPath = `/gov/subjects`;
const response = yield this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GovSubjectsGet200ResponseFromJSON)(jsonValue));
});
}
/**
* Retrieve subject types for vehicles from the government list
* Get subject types for vehicles
*/
govSubjectsGet(initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.govSubjectsGetRaw(initOverrides);
return yield response.value();
});
}
/**
* Retrieve current server time
* Get current time
*/
govTimeGetRaw(initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const queryParameters = {};
const headerParameters = {};
let urlPath = `/gov/time`;
const response = yield this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GovTimeGet200ResponseFromJSON)(jsonValue));
});
}
/**
* Retrieve current server time
* Get current time
*/
govTimeGet(initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.govTimeGetRaw(initOverrides);
return yield response.value();
});
}
/**
* Retrieve train stations by station type 7 - Israel Train 4 - Kfir Light Train 13 - Tevel Ligh Train
* Get train stations
*/
govTrainStationsPostRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['govTrainStationsPostRequest'] == null) {
throw new runtime.RequiredError('govTrainStationsPostRequest', 'Required parameter "govTrainStationsPostRequest" was null or undefined when calling govTrainStationsPost().');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
let urlPath = `/gov/train-stations`;
const response = yield this.request({
path: urlPath,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.GovTrainStationsPostRequestToJSON)(requestParameters['govTrainStationsPostRequest']),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GovStationsByLinePost200ResponseFromJSON)(jsonValue));
});
}
/**
* Retrieve train stations by station type 7 - Israel Train 4 - Kfir Light Train 13 - Tevel Ligh Train
* Get train stations
*/
govTrainStationsPost(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.govTrainStationsPostRaw(requestParameters, initOverrides);
return yield response.value();
});
}
}
exports.GovernmentTransportationApi = GovernmentTransportationApi;