@hasadna/open-bus-api-client
Version:
A client library for interacting with the Open-Bus API.
251 lines (208 loc) • 13.1 kB
text/typescript
/* 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: f2d4fa609b8a0b4607f9b72aa4cd7bc143334baa
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import * as runtime from '../runtime';
import type {
GtfsRidesAggGroupByPydanticModel,
GtfsRidesAggPydanticModel,
HTTPValidationError,
} from '../models/index';
import {
GtfsRidesAggGroupByPydanticModelFromJSON,
GtfsRidesAggGroupByPydanticModelToJSON,
GtfsRidesAggPydanticModelFromJSON,
GtfsRidesAggPydanticModelToJSON,
HTTPValidationErrorFromJSON,
HTTPValidationErrorToJSON,
} from '../models/index';
export interface ByGtfsRidesAggGroupByGetRequest {
dateFrom: Date;
dateTo: Date;
groupBy: string;
excludeHoursFrom?: number;
excludeHoursTo?: number;
}
export interface GtfsRidesAggListGetRequest {
dateFrom: Date;
dateTo: Date;
limit?: number;
offset?: number;
getCount?: boolean;
excludeHoursFrom?: number;
excludeHoursTo?: number;
}
/**
* AggregationsApi - interface
*
* @export
* @interface AggregationsApiInterface
*/
export interface AggregationsApiInterface {
/**
* gtfs rides aggregation grouped by given fields.
* @summary Group By
* @param {Date} dateFrom Filter by date. Only return items which have a date after or equals to given value. Format: \"YYYY-MM-DD\", e.g. \"2021-11-03\".
* @param {Date} dateTo Filter by date. Only return items which have a date before or equals to given value. Format: \"YYYY-MM-DD\", e.g. \"2021-11-03\".
* @param {string} groupBy Comma-separated list of fields to group by. Valid values: gtfs_route_date, gtfs_route_hour, operator_ref, day_of_week, line_ref.
* @param {number} [excludeHoursFrom] Hours to exclude from search, currently used to filter out edge cases. Filter by hour. Only return items which have an hour date after or equals to given value. Format: 0(12AM)-23
* @param {number} [excludeHoursTo] Hours to exclude from search, currently used to filter out edge cases. Filter by hour. Only return items which have a date before or equals to given value. Format: 0(12AM)-23
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AggregationsApiInterface
*/
byGtfsRidesAggGroupByGetRaw(requestParameters: ByGtfsRidesAggGroupByGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GtfsRidesAggGroupByPydanticModel>>>;
/**
* gtfs rides aggregation grouped by given fields.
* Group By
*/
byGtfsRidesAggGroupByGet(requestParameters: ByGtfsRidesAggGroupByGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GtfsRidesAggGroupByPydanticModel>>;
/**
* List of gtfs rides aggregations.
* @summary List
* @param {Date} dateFrom Filter by date. Only return items which have a date after or equals to given value. Format: \"YYYY-MM-DD\", e.g. \"2021-11-03\".
* @param {Date} dateTo Filter by date. Only return items which have a date before or equals to given value. Format: \"YYYY-MM-DD\", e.g. \"2021-11-03\".
* @param {number} [limit] Limit the number of returned results. If not specified will limit to 1000 results. To get more results, you can either use the offset param, alternatively - set the limit to -1 and use http streaming with compatible json streaming decoder to get all results, this method can fetch up to a maximum of 500000 results.
* @param {number} [offset] Item number to start returning results from. Use in combination with limit for pagination, alternatively, don\'t set offset, set limit to -1 and use http streaming with compatible json streaming decoder to get all results up to a maximum of 500000 results.
* @param {boolean} [getCount] Set to \"true\" to only get the total number of results for given filters. limit/offset/order parameters will be ignored.
* @param {number} [excludeHoursFrom] Hours to exclude from search, currently used to filter out edge cases. Filter by hour. Only return items which have an hour date after or equals to given value. Format: 0(12AM)-23
* @param {number} [excludeHoursTo] Hours to exclude from search, currently used to filter out edge cases. Filter by hour. Only return items which have a date before or equals to given value. Format: 0(12AM)-23
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AggregationsApiInterface
*/
gtfsRidesAggListGetRaw(requestParameters: GtfsRidesAggListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GtfsRidesAggPydanticModel>>>;
/**
* List of gtfs rides aggregations.
* List
*/
gtfsRidesAggListGet(requestParameters: GtfsRidesAggListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GtfsRidesAggPydanticModel>>;
}
/**
*
*/
export class AggregationsApi extends runtime.BaseAPI implements AggregationsApiInterface {
/**
* gtfs rides aggregation grouped by given fields.
* Group By
*/
async byGtfsRidesAggGroupByGetRaw(requestParameters: ByGtfsRidesAggGroupByGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GtfsRidesAggGroupByPydanticModel>>> {
if (requestParameters['dateFrom'] == null) {
throw new runtime.RequiredError(
'dateFrom',
'Required parameter "dateFrom" was null or undefined when calling byGtfsRidesAggGroupByGet().'
);
}
if (requestParameters['dateTo'] == null) {
throw new runtime.RequiredError(
'dateTo',
'Required parameter "dateTo" was null or undefined when calling byGtfsRidesAggGroupByGet().'
);
}
if (requestParameters['groupBy'] == null) {
throw new runtime.RequiredError(
'groupBy',
'Required parameter "groupBy" was null or undefined when calling byGtfsRidesAggGroupByGet().'
);
}
const queryParameters: any = {};
if (requestParameters['dateFrom'] != null) {
queryParameters['date_from'] = (requestParameters['dateFrom'] as any).toISOString().substring(0,10);
}
if (requestParameters['dateTo'] != null) {
queryParameters['date_to'] = (requestParameters['dateTo'] as any).toISOString().substring(0,10);
}
if (requestParameters['excludeHoursFrom'] != null) {
queryParameters['exclude_hours_from'] = requestParameters['excludeHoursFrom'];
}
if (requestParameters['excludeHoursTo'] != null) {
queryParameters['exclude_hours_to'] = requestParameters['excludeHoursTo'];
}
if (requestParameters['groupBy'] != null) {
queryParameters['group_by'] = requestParameters['groupBy'];
}
const headerParameters: runtime.HTTPHeaders = {};
let urlPath = `/gtfs_rides_agg/group_by`;
const response = await this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GtfsRidesAggGroupByPydanticModelFromJSON));
}
/**
* gtfs rides aggregation grouped by given fields.
* Group By
*/
async byGtfsRidesAggGroupByGet(requestParameters: ByGtfsRidesAggGroupByGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GtfsRidesAggGroupByPydanticModel>> {
const response = await this.byGtfsRidesAggGroupByGetRaw(requestParameters, initOverrides);
return await response.value();
}
/**
* List of gtfs rides aggregations.
* List
*/
async gtfsRidesAggListGetRaw(requestParameters: GtfsRidesAggListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GtfsRidesAggPydanticModel>>> {
if (requestParameters['dateFrom'] == null) {
throw new runtime.RequiredError(
'dateFrom',
'Required parameter "dateFrom" was null or undefined when calling gtfsRidesAggListGet().'
);
}
if (requestParameters['dateTo'] == null) {
throw new runtime.RequiredError(
'dateTo',
'Required parameter "dateTo" was null or undefined when calling gtfsRidesAggListGet().'
);
}
const queryParameters: any = {};
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'] as any).toISOString().substring(0,10);
}
if (requestParameters['dateTo'] != null) {
queryParameters['date_to'] = (requestParameters['dateTo'] as any).toISOString().substring(0,10);
}
if (requestParameters['excludeHoursFrom'] != null) {
queryParameters['exclude_hours_from'] = requestParameters['excludeHoursFrom'];
}
if (requestParameters['excludeHoursTo'] != null) {
queryParameters['exclude_hours_to'] = requestParameters['excludeHoursTo'];
}
const headerParameters: runtime.HTTPHeaders = {};
let urlPath = `/gtfs_rides_agg/list`;
const response = await this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GtfsRidesAggPydanticModelFromJSON));
}
/**
* List of gtfs rides aggregations.
* List
*/
async gtfsRidesAggListGet(requestParameters: GtfsRidesAggListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GtfsRidesAggPydanticModel>> {
const response = await this.gtfsRidesAggListGetRaw(requestParameters, initOverrides);
return await response.value();
}
}