@hasadna/open-bus-api-client

/* 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 { GtfsAgencyPydanticModel, GtfsRidePydanticModel, GtfsRideStopPydanticModel, GtfsRideStopWithRelatedPydanticModel, GtfsRideWithRelatedPydanticModel, GtfsRoutePydanticModel, GtfsStopPydanticModel, HTTPValidationError, } from '../models/index'; import { GtfsAgencyPydanticModelFromJSON, GtfsAgencyPydanticModelToJSON, GtfsRidePydanticModelFromJSON, GtfsRidePydanticModelToJSON, GtfsRideStopPydanticModelFromJSON, GtfsRideStopPydanticModelToJSON, GtfsRideStopWithRelatedPydanticModelFromJSON, GtfsRideStopWithRelatedPydanticModelToJSON, GtfsRideWithRelatedPydanticModelFromJSON, GtfsRideWithRelatedPydanticModelToJSON, GtfsRoutePydanticModelFromJSON, GtfsRoutePydanticModelToJSON, GtfsStopPydanticModelFromJSON, GtfsStopPydanticModelToJSON, HTTPValidationErrorFromJSON, HTTPValidationErrorToJSON, } from '../models/index'; export interface GtfsAgenciesListGetRequest { limit?: number; offset?: number; dateFrom?: Date; dateTo?: Date; } export interface GtfsRideStopsGetGetRequest { id: number; } export interface GtfsRideStopsListGetRequest { limit?: number; offset?: number; getCount?: boolean; arrivalTimeFrom?: Date; arrivalTimeTo?: Date; gtfsStopIds?: string; gtfsRideIds?: string; gtfsRideGtfsRouteId?: number; gtfsRideJourneyRefPrefix?: string; gtfsRideStartTimeFrom?: Date; gtfsRideStartTimeTo?: Date; gtfsStopDateFrom?: Date; gtfsStopDateTo?: Date; gtfsStopCode?: number; gtfsStopCity?: string; gtfsRouteDateFrom?: Date; gtfsRouteDateTo?: Date; gtfsRouteLineRefs?: string; gtfsRouteOperatorRefs?: string; gtfsRouteRouteShortName?: string; gtfsRouteRouteLongNameContains?: string; gtfsRouteRouteMkt?: string; gtfsRouteRouteDirection?: string; gtfsRouteRouteAlternative?: string; gtfsRouteAgencyName?: string; gtfsRouteRouteType?: string; orderBy?: string; } export interface GtfsRidesGetGetRequest { id: number; } export interface GtfsRidesListGetRequest { limit?: number; offset?: number; getCount?: boolean; gtfsRouteId?: number; journeyRefPrefix?: string; startTimeFrom?: Date; startTimeTo?: Date; gtfsRouteDateFrom?: Date; gtfsRouteDateTo?: Date; gtfsRouteLineRefs?: string; gtfsRouteOperatorRefs?: string; gtfsRouteRouteShortName?: string; gtfsRouteRouteLongNameContains?: string; gtfsRouteRouteMkt?: string; gtfsRouteRouteDirection?: string; gtfsRouteRouteAlternative?: string; gtfsRouteAgencyName?: string; gtfsRouteRouteType?: string; orderBy?: string; } export interface GtfsRoutesGetGetRequest { id: number; } export interface GtfsRoutesListGetRequest { limit?: number; offset?: number; getCount?: boolean; dateFrom?: Date; dateTo?: Date; lineRefs?: string; operatorRefs?: string; routeShortName?: string; routeLongNameContains?: string; routeMkt?: string; routeDirection?: string; routeAlternative?: string; agencyName?: string; routeType?: string; orderBy?: string; } export interface GtfsStopsGetGetRequest { id: number; } export interface GtfsStopsListGetRequest { limit?: number; offset?: number; getCount?: boolean; dateFrom?: Date; dateTo?: Date; code?: number; city?: string; } /** * GtfsApi - interface * * @export * @interface GtfsApiInterface */ export interface GtfsApiInterface { /** * List of gtfs agencies. * @summary List * @param {number} [limit] Limit the number of returned results. If not specified will limit to 100 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 {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 {*} [options] Override http request option. * @throws {RequiredError} * @memberof GtfsApiInterface */ gtfsAgenciesListGetRaw(requestParameters: GtfsAgenciesListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GtfsAgencyPydanticModel>>>; /** * List of gtfs agencies. * List */ gtfsAgenciesListGet(requestParameters: GtfsAgenciesListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GtfsAgencyPydanticModel>>; /** * Return a single gtfs ride stop based on id * @summary Get * @param {number} id gtfs ride stop id to get * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GtfsApiInterface */ gtfsRideStopsGetGetRaw(requestParameters: GtfsRideStopsGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GtfsRideStopPydanticModel>>; /** * Return a single gtfs ride stop based on id * Get */ gtfsRideStopsGetGet(requestParameters: GtfsRideStopsGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GtfsRideStopPydanticModel>; /** * List of gtfs ride stops. Due to large number of items in the table, you must filter the results by at least one of the following: 1. gtfs_ride_ids - containing a single gtfs ride id. 2. arrival_time_from and arrival_time_to - containing a time range. Additional filters can be applied in addition to one of the above options to narrow down the results. * @summary List * @param {number} [limit] Limit the number of returned results. If not specified will limit to 100 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 {Date} [arrivalTimeFrom] Filter by arrival time from. Only return items which have date/time after or equals to given value. Format: \"YYYY-MM-DDTHH:MM:SS+Z\", e.g. \"2021-11-03T15:48:49+02:00\". Note that all date/times must have a timezone specification. * @param {Date} [arrivalTimeTo] Filter by arrival time to. Only return items which have date/time before or equals to given value. Format: \"YYYY-MM-DDTHH:MM:SS+Z\", e.g. \"2021-11-03T15:48:49+02:00\". Note that all date/times must have a timezone specification. * @param {string} [gtfsStopIds] Filter by gtfs stop id. Comma-separated list of values. * @param {string} [gtfsRideIds] Filter by gtfs ride id. Comma-separated list of values. * @param {number} [gtfsRideGtfsRouteId] Filter by related gtfs ride\'s gtfs route id. Only return items which exactly match given string. * @param {string} [gtfsRideJourneyRefPrefix] Filter by related gtfs ride\'s journey ref prefix. Only return items which start with given string. * @param {Date} [gtfsRideStartTimeFrom] Filter by related gtfs ride\'s start time from. Only return items which have date/time after or equals to given value. Format: \"YYYY-MM-DDTHH:MM:SS+Z\", e.g. \"2021-11-03T15:48:49+02:00\". Note that all date/times must have a timezone specification. * @param {Date} [gtfsRideStartTimeTo] Filter by related gtfs ride\'s start time to. Only return items which have date/time before or equals to given value. Format: \"YYYY-MM-DDTHH:MM:SS+Z\", e.g. \"2021-11-03T15:48:49+02:00\". Note that all date/times must have a timezone specification. * @param {Date} [gtfsStopDateFrom] Filter by related gtfs stop\'s 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} [gtfsStopDateTo] Filter by related gtfs stop\'s 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} [gtfsStopCode] Filter by related gtfs stop\'s code. Only return items which exactly match given string. * @param {string} [gtfsStopCity] Filter by related gtfs stop\'s city. Only return items which exactly match given string. * @param {Date} [gtfsRouteDateFrom] Filter by related gtfs route\'s 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} [gtfsRouteDateTo] Filter by related gtfs route\'s 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} [gtfsRouteLineRefs] Filter by related gtfs route\'s line ref. Comma-separated list of values. * @param {string} [gtfsRouteOperatorRefs] Agency identifier. To get it, first query gtfs_agencies. Filter by related gtfs route\'s operator ref. Comma-separated list of values. Example: 3 for Eged * @param {string} [gtfsRouteRouteShortName] Line number. Filter by related gtfs route\'s route short name. Only return items which exactly match given string. Example: 480 * @param {string} [gtfsRouteRouteLongNameContains] Filter by related gtfs route\'s route long name. Only return items which contain given string. * @param {string} [gtfsRouteRouteMkt] Filter by related gtfs route\'s route mkt. Only return items which exactly match given string. * @param {string} [gtfsRouteRouteDirection] Filter by related gtfs route\'s route direction. Only return items which exactly match given string. * @param {string} [gtfsRouteRouteAlternative] Filter by related gtfs route\'s route alternative. Only return items which exactly match given string. * @param {string} [gtfsRouteAgencyName] Filter by related gtfs route\'s agency name. Only return items which exactly match given string. * @param {string} [gtfsRouteRouteType] Filter by related gtfs route\'s route type. Only return items which exactly match given string. * @param {string} [orderBy] Order of the results. Comma-separated list of fields and direction. e.g. \"field1 asc,field2 desc\". * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GtfsApiInterface */ gtfsRideStopsListGetRaw(requestParameters: GtfsRideStopsListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GtfsRideStopWithRelatedPydanticModel>>>; /** * List of gtfs ride stops. Due to large number of items in the table, you must filter the results by at least one of the following: 1. gtfs_ride_ids - containing a single gtfs ride id. 2. arrival_time_from and arrival_time_to - containing a time range. Additional filters can be applied in addition to one of the above options to narrow down the results. * List */ gtfsRideStopsListGet(requestParameters: GtfsRideStopsListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GtfsRideStopWithRelatedPydanticModel>>; /** * Return a single gtfs ride based on id * @summary Get * @param {number} id gtfs ride id to get * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GtfsApiInterface */ gtfsRidesGetGetRaw(requestParameters: GtfsRidesGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GtfsRidePydanticModel>>; /** * Return a single gtfs ride based on id * Get */ gtfsRidesGetGet(requestParameters: GtfsRidesGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GtfsRidePydanticModel>; /** * List of gtfs rides. * @summary List * @param {number} [limit] Limit the number of returned results. If not specified will limit to 100 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} [gtfsRouteId] Filter by gtfs route id. Only return items which exactly match given string. * @param {string} [journeyRefPrefix] Filter by journey ref prefix. Only return items which start with given string. * @param {Date} [startTimeFrom] Filter by start time from. Only return items which have date/time after or equals to given value. Format: \"YYYY-MM-DDTHH:MM:SS+Z\", e.g. \"2021-11-03T15:48:49+02:00\". Note that all date/times must have a timezone specification. * @param {Date} [startTimeTo] Filter by start time to. Only return items which have date/time before or equals to given value. Format: \"YYYY-MM-DDTHH:MM:SS+Z\", e.g. \"2021-11-03T15:48:49+02:00\". Note that all date/times must have a timezone specification. * @param {Date} [gtfsRouteDateFrom] Filter by related gtfs route\'s 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} [gtfsRouteDateTo] Filter by related gtfs route\'s 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} [gtfsRouteLineRefs] Filter by related gtfs route\'s line ref. Comma-separated list of values. * @param {string} [gtfsRouteOperatorRefs] Agency identifier. To get it, first query gtfs_agencies. Filter by related gtfs route\'s operator ref. Comma-separated list of values. Example: 3 for Eged * @param {string} [gtfsRouteRouteShortName] Line number. Filter by related gtfs route\'s route short name. Only return items which exactly match given string. Example: 480 * @param {string} [gtfsRouteRouteLongNameContains] Filter by related gtfs route\'s route long name. Only return items which contain given string. * @param {string} [gtfsRouteRouteMkt] Filter by related gtfs route\'s route mkt. Only return items which exactly match given string. * @param {string} [gtfsRouteRouteDirection] Filter by related gtfs route\'s route direction. Only return items which exactly match given string. * @param {string} [gtfsRouteRouteAlternative] Filter by related gtfs route\'s route alternative. Only return items which exactly match given string. * @param {string} [gtfsRouteAgencyName] Filter by related gtfs route\'s agency name. Only return items which exactly match given string. * @param {string} [gtfsRouteRouteType] Filter by related gtfs route\'s route type. Only return items which exactly match given string. * @param {string} [orderBy] Order of the results. Comma-separated list of fields and direction. e.g. \"field1 asc,field2 desc\". * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GtfsApiInterface */ gtfsRidesListGetRaw(requestParameters: GtfsRidesListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GtfsRideWithRelatedPydanticModel>>>; /** * List of gtfs rides. * List */ gtfsRidesListGet(requestParameters: GtfsRidesListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GtfsRideWithRelatedPydanticModel>>; /** * Return a single gtfs route based on id * @summary Get * @param {number} id gtfs route id to get * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GtfsApiInterface */ gtfsRoutesGetGetRaw(requestParameters: GtfsRoutesGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GtfsRoutePydanticModel>>; /** * Return a single gtfs route based on id * Get */ gtfsRoutesGetGet(requestParameters: GtfsRoutesGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GtfsRoutePydanticModel>; /** * List of gtfs routes. * @summary List * @param {number} [limit] Limit the number of returned results. If not specified will limit to 100 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 {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} [lineRefs] Filter by line ref. Comma-separated list of values. * @param {string} [operatorRefs] Agency identifier. To get it, first query gtfs_agencies. Filter by operator ref. Comma-separated list of values. Example: 3 for Eged * @param {string} [routeShortName] Line number. Filter by route short name. Only return items which exactly match given string. Example: 480 * @param {string} [routeLongNameContains] Filter by route long name. Only return items which contain given string. * @param {string} [routeMkt] Filter by route mkt. Only return items which exactly match given string. * @param {string} [routeDirection] Filter by route direction. Only return items which exactly match given string. * @param {string} [routeAlternative] Filter by route alternative. Only return items which exactly match given string. * @param {string} [agencyName] Filter by agency name. Only return items which exactly match given string. * @param {string} [routeType] Filter by route type. Only return items which exactly match given string. * @param {string} [orderBy] Order of the results. Comma-separated list of fields and direction. e.g. \"field1 asc,field2 desc\". * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GtfsApiInterface */ gtfsRoutesListGetRaw(requestParameters: GtfsRoutesListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GtfsRoutePydanticModel>>>; /** * List of gtfs routes. * List */ gtfsRoutesListGet(requestParameters: GtfsRoutesListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GtfsRoutePydanticModel>>; /** * Return a single gtfs stop based on id * @summary Get * @param {number} id gtfs stop id to get * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GtfsApiInterface */ gtfsStopsGetGetRaw(requestParameters: GtfsStopsGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GtfsStopPydanticModel>>; /** * Return a single gtfs stop based on id * Get */ gtfsStopsGetGet(requestParameters: GtfsStopsGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GtfsStopPydanticModel>; /** * List of gtfs stops. * @summary List * @param {number} [limit] Limit the number of returned results. If not specified will limit to 100 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 {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} [code] Filter by code. Only return items which exactly match given string. * @param {string} [city] Filter by city. Only return items which exactly match given string. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GtfsApiInterface */ gtfsStopsListGetRaw(requestParameters: GtfsStopsListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GtfsStopPydanticModel>>>; /** * List of gtfs stops. * List */ gtfsStopsListGet(requestParameters: GtfsStopsListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GtfsStopPydanticModel>>; } /** * */ export class GtfsApi extends runtime.BaseAPI implements GtfsApiInterface { /** * List of gtfs agencies. * List */ async gtfsAgenciesListGetRaw(requestParameters: GtfsAgenciesListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GtfsAgencyPydanticModel>>> { const queryParameters: any = {}; if (requestParameters['limit'] != null) { queryParameters['limit'] = requestParameters['limit']; } if (requestParameters['offset'] != null) { queryParameters['offset'] = requestParameters['offset']; } 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); } const headerParameters: runtime.HTTPHeaders = {}; let urlPath = `/gtfs_agencies/list`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GtfsAgencyPydanticModelFromJSON)); } /** * List of gtfs agencies. * List */ async gtfsAgenciesListGet(requestParameters: GtfsAgenciesListGetRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GtfsAgencyPydanticModel>> { const response = await this.gtfsAgenciesListGetRaw(requestParameters, initOverrides); return await response.value(); } /** * Return a single gtfs ride stop based on id * Get */ async gtfsRideStopsGetGetRaw(requestParameters: GtfsRideStopsGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GtfsRideStopPydanticModel>> { if (requestParameters['id'] == null) { throw new runtime.RequiredError( 'id', 'Required parameter "id" was null or undefined when calling gtfsRideStopsGetGet().' ); } const queryParameters: any = {}; if (requestParameters['id'] != null) { queryParameters['id'] = requestParameters['id']; } const headerParameters: runtime.HTTPHeaders = {}; let urlPath = `/gtfs_ride_stops/get`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => GtfsRideStopPydanticModelFromJSON(jsonValue)); } /** * Return a single gtfs ride stop based on id * Get */ async gtfsRideStopsGetGet(requestParameters: GtfsRideStopsGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GtfsRideStopPydanticModel> { const response = await this.gtfsRideStopsGetGetRaw(requestParameters, initOverrides); return await response.value(); } /** * List of gtfs ride stops. Due to large number of items in the table, you must filter the results by at least one of the following: 1. gtfs_ride_ids - containing a single gtfs ride id. 2. arrival_time_from and arrival_time_to - containing a time range. Additional filters can be applied in addition to one of the above options to narrow down the results. * List */ async gtfsRideStopsListGetRaw(requestParameters: GtfsRideStopsListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GtfsRideStopWithRelatedPydanticModel>>> { 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['arrivalTimeFrom'] != null) { queryParameters['arrival_time_from'] = (requestParameters['arrivalTimeFrom'] as any).toISOString(); } if (requestParameters['arrivalTimeTo'] != null) { queryParameters['arrival_time_to'] = (requestParameters['arrivalTimeTo'] as any).toISOString(); } if (requestParameters['gtfsStopIds'] != null) { queryParameters['gtfs_stop_ids'] = requestParameters['gtfsStopIds']; } if (requestParameters['gtfsRideIds'] != null) { queryParameters['gtfs_ride_ids'] = requestParameters['gtfsRideIds']; } if (requestParameters['gtfsRideGtfsRouteId'] != null) { queryParameters['gtfs_ride__gtfs_route_id'] = requestParameters['gtfsRideGtfsRouteId']; } if (requestParameters['gtfsRideJourneyRefPrefix'] != null) { queryParameters['gtfs_ride__journey_ref_prefix'] = requestParameters['gtfsRideJourneyRefPrefix']; } if (requestParameters['gtfsRideStartTimeFrom'] != null) { queryParameters['gtfs_ride__start_time_from'] = (requestParameters['gtfsRideStartTimeFrom'] as any).toISOString(); } if (requestParameters['gtfsRideStartTimeTo'] != null) { queryParameters['gtfs_ride__start_time_to'] = (requestParameters['gtfsRideStartTimeTo'] as any).toISOString(); } if (requestParameters['gtfsStopDateFrom'] != null) { queryParameters['gtfs_stop__date_from'] = (requestParameters['gtfsStopDateFrom'] as any).toISOString().substring(0,10); } if (requestParameters['gtfsStopDateTo'] != null) { queryParameters['gtfs_stop__date_to'] = (requestParameters['gtfsStopDateTo'] as any).toISOString().substring(0,10); } if (requestParameters['gtfsStopCode'] != null) { queryParameters['gtfs_stop__code'] = requestParameters['gtfsStopCode']; } if (requestParameters['gtfsStopCity'] != null) { queryParameters['gtfs_stop__city'] = requestParameters['gtfsStopCity']; } if (requestParameters['gtfsRouteDateFrom'] != null) { queryParameters['gtfs_route__date_from'] = (requestParameters['gtfsRouteDateFrom'] as any).toISOString().substring(0,10); } if (requestParameters['gtfsRouteDateTo'] != null) { queryParameters['gtfs_route__date_to'] = (requestParameters['gtfsRouteDateTo'] as any).toISOString().substring(0,10); } if (requestParameters['gtfsRouteLineRefs'] != null) { queryParameters['gtfs_route__line_refs'] = requestParameters['gtfsRouteLineRefs']; } if (requestParameters['gtfsRouteOperatorRefs'] != null) { queryParameters['gtfs_route__operator_refs'] = requestParameters['gtfsRouteOperatorRefs']; } if (requestParameters['gtfsRouteRouteShortName'] != null) { queryParameters['gtfs_route__route_short_name'] = requestParameters['gtfsRouteRouteShortName']; } if (requestParameters['gtfsRouteRouteLongNameContains'] != null) { queryParameters['gtfs_route__route_long_name_contains'] = requestParameters['gtfsRouteRouteLongNameContains']; } if (requestParameters['gtfsRouteRouteMkt'] != null) { queryParameters['gtfs_route__route_mkt'] = requestParameters['gtfsRouteRouteMkt']; } if (requestParameters['gtfsRouteRouteDirection'] != null) { queryParameters['gtfs_route__route_direction'] = requestParameters['gtfsRouteRouteDirection']; } if (requestParameters['gtfsRouteRouteAlternative'] != null) { queryParameters['gtfs_route__route_alternative'] = requestParameters['gtfsRouteRouteAlternative']; } if (requestParameters['gtfsRouteAgencyName'] != null) { queryParameters['gtfs_route__agency_name'] = requestParameters['gtfsRouteAgencyName']; } if (requestParameters['gtfsRouteRouteType'] != null) { queryParameters['gtfs_route__route_type'] = requestParameters['gtfsRouteRouteType']; } if (requestParameters['orderBy'] != null) { queryParameters['order_by'] = requestParameters['orderBy']; } const headerParameters: runtime.HTTPHeaders = {}; let urlPath = `/gtfs_ride_stops/list`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GtfsRideStopWithRelatedPydanticModelFromJSON)); } /** * List of gtfs ride stops. Due to large number of items in the table, you must filter the results by at least one of the following: 1. gtfs_ride_ids - containing a single gtfs ride id. 2. arrival_time_from and arrival_time_to - containing a time range. Additional filters can be applied in addition to one of the above options to narrow down the results. * List */ async gtfsRideStopsListGet(requestParameters: GtfsRideStopsListGetRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GtfsRideStopWithRelatedPydanticModel>> { const response = await this.gtfsRideStopsListGetRaw(requestParameters, initOverrides); return await response.value(); } /** * Return a single gtfs ride based on id * Get */ async gtfsRidesGetGetRaw(requestParameters: GtfsRidesGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GtfsRidePydanticModel>> { if (requestParameters['id'] == null) { throw new runtime.RequiredError( 'id', 'Required parameter "id" was null or undefined when calling gtfsRidesGetGet().' ); } const queryParameters: any = {}; if (requestParameters['id'] != null) { queryParameters['id'] = requestParameters['id']; } const headerParameters: runtime.HTTPHeaders = {}; let urlPath = `/gtfs_rides/get`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => GtfsRidePydanticModelFromJSON(jsonValue)); } /** * Return a single gtfs ride based on id * Get */ async gtfsRidesGetGet(requestParameters: GtfsRidesGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GtfsRidePydanticModel> { const response = await this.gtfsRidesGetGetRaw(requestParameters, initOverrides); return await response.value(); } /** * List of gtfs rides. * List */ async gtfsRidesListGetRaw(requestParameters: GtfsRidesListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GtfsRideWithRelatedPydanticModel>>> { 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['gtfsRouteId'] != null) { queryParameters['gtfs_route_id'] = requestParameters['gtfsRouteId']; } if (requestParameters['journeyRefPrefix'] != null) { queryParameters['journey_ref_prefix'] = requestParameters['journeyRefPrefix']; } if (requestParameters['startTimeFrom'] != null) { queryParameters['start_time_from'] = (requestParameters['startTimeFrom'] as any).toISOString(); } if (requestParameters['startTimeTo'] != null) { queryParameters['start_time_to'] = (requestParameters['startTimeTo'] as any).toISOString(); } if (requestParameters['gtfsRouteDateFrom'] != null) { queryParameters['gtfs_route__date_from'] = (requestParameters['gtfsRouteDateFrom'] as any).toISOString().substring(0,10); } if (requestParameters['gtfsRouteDateTo'] != null) { queryParameters['gtfs_route__date_to'] = (requestParameters['gtfsRouteDateTo'] as any).toISOString().substring(0,10); } if (requestParameters['gtfsRouteLineRefs'] != null) { queryParameters['gtfs_route__line_refs'] = requestParameters['gtfsRouteLineRefs']; } if (requestParameters['gtfsRouteOperatorRefs'] != null) { queryParameters['gtfs_route__operator_refs'] = requestParameters['gtfsRouteOperatorRefs']; } if (requestParameters['gtfsRouteRouteShortName'] != null) { queryParameters['gtfs_route__route_short_name'] = requestParameters['gtfsRouteRouteShortName']; } if (requestParameters['gtfsRouteRouteLongNameContains'] != null) { queryParameters['gtfs_route__route_long_name_contains'] = requestParameters['gtfsRouteRouteLongNameContains']; } if (requestParameters['gtfsRouteRouteMkt'] != null) { queryParameters['gtfs_route__route_mkt'] = requestParameters['gtfsRouteRouteMkt']; } if (requestParameters['gtfsRouteRouteDirection'] != null) { queryParameters['gtfs_route__route_direction'] = requestParameters['gtfsRouteRouteDirection']; } if (requestParameters['gtfsRouteRouteAlternative'] != null) { queryParameters['gtfs_route__route_alternative'] = requestParameters['gtfsRouteRouteAlternative']; } if (requestParameters['gtfsRouteAgencyName'] != null) { queryParameters['gtfs_route__agency_name'] = requestParameters['gtfsRouteAgencyName']; } if (requestParameters['gtfsRouteRouteType'] != null) { queryParameters['gtfs_route__route_type'] = requestParameters['gtfsRouteRouteType']; } if (requestParameters['orderBy'] != null) { queryParameters['order_by'] = requestParameters['orderBy']; } const headerParameters: runtime.HTTPHeaders = {}; let urlPath = `/gtfs_rides/list`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GtfsRideWithRelatedPydanticModelFromJSON)); } /** * List of gtfs rides. * List */ async gtfsRidesListGet(requestParameters: GtfsRidesListGetRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GtfsRideWithRelatedPydanticModel>> { const response = await this.gtfsRidesListGetRaw(requestParameters, initOverrides); return await response.value(); } /** * Return a single gtfs route based on id * Get */ async gtfsRoutesGetGetRaw(requestParameters: GtfsRoutesGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GtfsRoutePydanticModel>> { if (requestParameters['id'] == null) { throw new runtime.RequiredError( 'id', 'Required parameter "id" was null or undefined when calling gtfsRoutesGetGet().' ); } const queryParameters: any = {}; if (requestParameters['id'] != null) { queryParameters['id'] = requestParameters['id']; } const headerParameters: runtime.HTTPHeaders = {}; let urlPath = `/gtfs_routes/get`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => GtfsRoutePydanticModelFromJSON(jsonValue)); } /** * Return a single gtfs route based on id * Get */ async gtfsRoutesGetGet(requestParameters: GtfsRoutesGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GtfsRoutePydanticModel> { const response = await this.gtfsRoutesGetGetRaw(requestParameters, initOverrides); return await response.value(); } /** * List of gtfs routes. * List */ async gtfsRoutesListGetRaw(requestParameters: GtfsRoutesListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GtfsRoutePydanticModel>>> { 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['lineRefs'] != null) { queryParameters['line_refs'] = requestParameters['lineRefs']; } if (requestParameters['operatorRefs'] != null) { queryParameters['operator_refs'] = requestParameters['operatorRefs']; } if (requestParameters['routeShortName'] != null) { queryParameters['route_short_name'] = requestParameters['routeShortName']; } if (requestParameters['routeLongNameContains'] != null) { queryParameters['route_long_name_contains'] = requestParameters['routeLongNameContains']; } if (requestParameters['routeMkt'] != null) { queryParameters['route_mkt'] = requestParameters['routeMkt']; } if (requestParameters['routeDirection'] != null) { queryParameters['route_direction'] = requestParameters['routeDirection']; } if (requestParameters['routeAlternative'] != null) { queryParameters['route_alternative'] = requestParameters['routeAlternative']; } if (requestParameters['agencyName'] != null) { queryParameters['agency_name'] = requestParameters['agencyName']; } if (requestParameters['routeType'] != null) { queryParameters['route_type'] = requestParameters['routeType']; } if (requestParameters['orderBy'] != null) { queryParameters['order_by'] = requestParameters['orderBy']; } const headerParameters: runtime.HTTPHeaders = {}; let urlPath = `/gtfs_routes/list`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GtfsRoutePydanticModelFromJSON)); } /** * List of gtfs routes. * List */ async gtfsRoutesListGet(requestParameters: GtfsRoutesListGetRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GtfsRoutePydanticModel>> { const response = await this.gtfsRoutesListGetRaw(requestParameters, initOverrides); return await response.value(); } /** * Return a single gtfs stop based on id * Get */ async gtfsStopsGetGetRaw(requestParameters: GtfsStopsGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GtfsStopPydanticModel>> { if (requestParameters['id'] == null) { throw new runtime.RequiredError( 'id', 'Required parameter "id" was null or undefined when calling gtfsStopsGetGet().' ); } const queryParameters: any = {}; if (requestParameters['id'] != null) { queryParameters['id'] = requestParameters['id']; } const headerParameters: runtime.HTTPHeaders = {}; let urlPath = `/gtfs_stops/get`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => GtfsStopPydanticModelFromJSON(jsonValue)); } /** * Return a single gtfs stop based on id * Get */ async gtfsStopsGetGet(requestParameters: GtfsStopsGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GtfsStopPydanticModel> { const response = await this.gtfsStopsGetGetRaw(requestParameters, initOverrides); return await response.value(); } /** * List of gtfs stops. * List */ async gtfsStopsListGetRaw(requestParameters: GtfsStopsListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GtfsStopPydanticModel>>> { 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['code'] != null) { queryParameters['code'] = requestParameters['code']; } if (requestParameters['city'] != null) { queryParameters['city'] = requestParameters['city']; } const headerParameters: runtime.HTTPHeaders = {}; let urlPath = `/gtfs_stops/list`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GtfsStopPydanticModelFromJSON)); } /** * List of gtfs stops. * List */ async gtfsStopsListGet(requestParameters: GtfsStopsListGetRequest =