@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 { HTTPValidationError, SiriRidePydanticModel, SiriRideStopPydanticModel, SiriRideStopWithRelatedPydanticModel, SiriRideWithRelatedPydanticModel, SiriRoutePydanticModel, SiriSnapshotPydanticModel, SiriStopPydanticModel, SiriVehicleLocationPydanticModel, SiriVehicleLocationWithRelatedPydanticModel, SiriVelocityAggregationPydanticModel, } from '../models/index'; import { HTTPValidationErrorFromJSON, HTTPValidationErrorToJSON, SiriRidePydanticModelFromJSON, SiriRidePydanticModelToJSON, SiriRideStopPydanticModelFromJSON, SiriRideStopPydanticModelToJSON, SiriRideStopWithRelatedPydanticModelFromJSON, SiriRideStopWithRelatedPydanticModelToJSON, SiriRideWithRelatedPydanticModelFromJSON, SiriRideWithRelatedPydanticModelToJSON, SiriRoutePydanticModelFromJSON, SiriRoutePydanticModelToJSON, SiriSnapshotPydanticModelFromJSON, SiriSnapshotPydanticModelToJSON, SiriStopPydanticModelFromJSON, SiriStopPydanticModelToJSON, SiriVehicleLocationPydanticModelFromJSON, SiriVehicleLocationPydanticModelToJSON, SiriVehicleLocationWithRelatedPydanticModelFromJSON, SiriVehicleLocationWithRelatedPydanticModelToJSON, SiriVelocityAggregationPydanticModelFromJSON, SiriVelocityAggregationPydanticModelToJSON, } from '../models/index'; export interface SiriRideStopsGetGetRequest { id: number; } export interface SiriRideStopsListGetRequest { limit?: number; offset?: number; getCount?: boolean; siriStopIds?: string; siriRideIds?: string; siriVehicleLocationLonGreaterOrEqual?: number; siriVehicleLocationLonLowerOrEqual?: number; siriVehicleLocationLatGreaterOrEqual?: number; siriVehicleLocationLatLowerOrEqual?: number; siriVehicleLocationRecordedAtTimeFrom?: Date; siriVehicleLocationRecordedAtTimeTo?: Date; siriRideScheduledStartTimeFrom?: Date; siriRideScheduledStartTimeTo?: Date; gtfsStopLatGreaterOrEqual?: number; gtfsStopLatLowerOrEqual?: number; gtfsStopLonGreaterOrEqual?: number; gtfsStopLonLowerOrEqual?: number; gtfsDateFrom?: Date; gtfsDateTo?: Date; orderBy?: string; } export interface SiriRidesGetGetRequest { id: number; } export interface SiriRidesListGetRequest { limit?: number; offset?: number; getCount?: boolean; gtfsRouteDateFrom?: Date; gtfsRouteDateTo?: Date; gtfsRouteLineRefs?: string; gtfsRouteOperatorRefs?: string; gtfsRouteRouteShortName?: string; gtfsRouteRouteLongNameContains?: string; gtfsRouteRouteMkt?: string; gtfsRouteRouteDirection?: string; gtfsRouteRouteAlternative?: string; gtfsRouteAgencyName?: string; gtfsRouteRouteType?: string; gtfsRideGtfsRouteId?: number; gtfsRideJourneyRefPrefix?: string; gtfsRideStartTimeFrom?: Date; gtfsRideStartTimeTo?: Date; siriRouteIds?: string; siriRouteLineRefs?: string; siriRouteOperatorRefs?: string; journeyRefPrefix?: string; journeyRefs?: string; vehicleRefs?: string; scheduledStartTimeFrom?: Date; scheduledStartTimeTo?: Date; orderBy?: string; } export interface SiriRoutesGetGetRequest { id: number; } export interface SiriRoutesListGetRequest { limit?: number; offset?: number; getCount?: boolean; lineRefs?: string; operatorRefs?: string; orderBy?: string; } export interface SiriSnapshotsGetGetRequest { id: number; } export interface SiriSnapshotsListGetRequest { limit?: number; offset?: number; getCount?: boolean; snapshotIdPrefix?: string; orderBy?: string; } export interface SiriStopsGetGetRequest { id: number; } export interface SiriStopsListGetRequest { limit?: number; offset?: number; getCount?: boolean; codes?: string; orderBy?: string; } export interface SiriVehicleLocationsGetGetRequest { id: number; } export interface SiriVehicleLocationsListGetRequest { limit?: number; offset?: number; getCount?: boolean; siriVehicleLocationIds?: string; siriSnapshotIds?: string; siriRideStopIds?: string; recordedAtTimeFrom?: Date; recordedAtTimeTo?: Date; lonGreaterOrEqual?: number; lonLowerOrEqual?: number; latGreaterOrEqual?: number; latLowerOrEqual?: number; orderBy?: string; siriRoutesLineRef?: string; siriRideVehicleRef?: string; siriRoutesOperatorRef?: string; siriRidesSchedualedStartTimeFrom?: Date; siriRidesSchedualedStartTimeTo?: Date; siriRidesIds?: string; siriRoutesIds?: string; } export interface VelocityAggregationSiriVelocityAggregationSiriVelocityAggregationGetRequest { recordedFrom: Date; lonMin?: number; lonMax?: number; latMin?: number; latMax?: number; roundingPrecision?: number; } /** * SiriApi - interface * * @export * @interface SiriApiInterface */ export interface SiriApiInterface { /** * Return a single siri ride stop based on id * @summary Get * @param {number} id siri ride stop id to get * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SiriApiInterface */ siriRideStopsGetGetRaw(requestParameters: SiriRideStopsGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SiriRideStopPydanticModel>>; /** * Return a single siri ride stop based on id * Get */ siriRideStopsGetGet(requestParameters: SiriRideStopsGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SiriRideStopPydanticModel>; /** * List of siri ride 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 {string} [siriStopIds] Filter by siri stop id. Comma-separated list of values. * @param {string} [siriRideIds] Filter by siri ride id. Comma-separated list of values. * @param {number} [siriVehicleLocationLonGreaterOrEqual] Filter by siri vehicle location lon. Only return items which have a numeric value greater than or equal to given value Example: 34.808 * @param {number} [siriVehicleLocationLonLowerOrEqual] Filter by siri vehicle location lon. Only return items which have a numeric value lower than or equal to given value Example: 34.808 * @param {number} [siriVehicleLocationLatGreaterOrEqual] Filter by siri vehicle location lat. Only return items which have a numeric value greater than or equal to given value Example: 31.961 * @param {number} [siriVehicleLocationLatLowerOrEqual] Filter by siri vehicle location lat. Only return items which have a numeric value lower than or equal to given value Example: 31.961 * @param {Date} [siriVehicleLocationRecordedAtTimeFrom] Filter by siri vehicle location recorded at time. 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} [siriVehicleLocationRecordedAtTimeTo] Filter by siri vehicle location recorded at time. 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} [siriRideScheduledStartTimeFrom] Filter by siri ride scheduled start time. 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} [siriRideScheduledStartTimeTo] Filter by siri ride scheduled start time. 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 {number} [gtfsStopLatGreaterOrEqual] Filter by gtfs stop lat. Only return items which have a numeric value greater than or equal to given value Example: 31.961 * @param {number} [gtfsStopLatLowerOrEqual] Filter by gtfs stop lat. Only return items which have a numeric value lower than or equal to given value Example: 31.961 * @param {number} [gtfsStopLonGreaterOrEqual] Filter by gtfs stop lon. Only return items which have a numeric value greater than or equal to given value Example: 34.808 * @param {number} [gtfsStopLonLowerOrEqual] Filter by gtfs stop lon. Only return items which have a numeric value lower than or equal to given value Example: 34.808 * @param {Date} [gtfsDateFrom] filter all gtfs related records on this date Filter by gtfs 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} [gtfsDateTo] filter all gtfs related records on this date Filter by gtfs 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} [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 SiriApiInterface */ siriRideStopsListGetRaw(requestParameters: SiriRideStopsListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SiriRideStopWithRelatedPydanticModel>>>; /** * List of siri ride stops. * List */ siriRideStopsListGet(requestParameters: SiriRideStopsListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SiriRideStopWithRelatedPydanticModel>>; /** * Return a single siri ride based on id * @summary Get * @param {number} id siri ride id to get * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SiriApiInterface */ siriRidesGetGetRaw(requestParameters: SiriRidesGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SiriRidePydanticModel>>; /** * Return a single siri ride based on id * Get */ siriRidesGetGet(requestParameters: SiriRidesGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SiriRidePydanticModel>; /** * List of siri 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 {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 {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 {string} [siriRouteIds] Filter by siri route ids. Comma-separated list of values. * @param {string} [siriRouteLineRefs] Filter by siri route line refs. Comma-separated list of values. * @param {string} [siriRouteOperatorRefs] Filter by siri route operator refs. Comma-separated list of values. * @param {string} [journeyRefPrefix] Filter by journey ref prefix. Only return items which start with given string. * @param {string} [journeyRefs] Filter by journey ref. Comma-separated list of values. * @param {string} [vehicleRefs] Filter by vehicle ref. Comma-separated list of values. * @param {Date} [scheduledStartTimeFrom] Filter by scheduled start time. 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} [scheduledStartTimeTo] Filter by scheduled start time. 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} [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 SiriApiInterface */ siriRidesListGetRaw(requestParameters: SiriRidesListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SiriRideWithRelatedPydanticModel>>>; /** * List of siri rides. * List */ siriRidesListGet(requestParameters: SiriRidesListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SiriRideWithRelatedPydanticModel>>; /** * Return a single siri route based on id * @summary Get * @param {number} id siri route id to get * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SiriApiInterface */ siriRoutesGetGetRaw(requestParameters: SiriRoutesGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SiriRoutePydanticModel>>; /** * Return a single siri route based on id * Get */ siriRoutesGetGet(requestParameters: SiriRoutesGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SiriRoutePydanticModel>; /** * List of siri 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 {string} [lineRefs] Filter by line ref. Comma-separated list of values. * @param {string} [operatorRefs] Filter by operator ref. Comma-separated list of values. * @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 SiriApiInterface */ siriRoutesListGetRaw(requestParameters: SiriRoutesListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SiriRoutePydanticModel>>>; /** * List of siri routes. * List */ siriRoutesListGet(requestParameters: SiriRoutesListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SiriRoutePydanticModel>>; /** * Return a single siri snapshot based on id * @summary Get * @param {number} id siri snapshot id to get * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SiriApiInterface */ siriSnapshotsGetGetRaw(requestParameters: SiriSnapshotsGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SiriSnapshotPydanticModel>>; /** * Return a single siri snapshot based on id * Get */ siriSnapshotsGetGet(requestParameters: SiriSnapshotsGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SiriSnapshotPydanticModel>; /** * List of siri snapshots. * @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 {string} [snapshotIdPrefix] Filter by snapshot id prefix. Only return items which start with 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 SiriApiInterface */ siriSnapshotsListGetRaw(requestParameters: SiriSnapshotsListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SiriSnapshotPydanticModel>>>; /** * List of siri snapshots. * List */ siriSnapshotsListGet(requestParameters: SiriSnapshotsListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SiriSnapshotPydanticModel>>; /** * Return a single siri stop based on id * @summary Get * @param {number} id siri stop id to get * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SiriApiInterface */ siriStopsGetGetRaw(requestParameters: SiriStopsGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SiriStopPydanticModel>>; /** * Return a single siri stop based on id * Get */ siriStopsGetGet(requestParameters: SiriStopsGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SiriStopPydanticModel>; /** * List of siri 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 {string} [codes] Filter by stop code. Comma-separated list of values. * @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 SiriApiInterface */ siriStopsListGetRaw(requestParameters: SiriStopsListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SiriStopPydanticModel>>>; /** * List of siri stops. * List */ siriStopsListGet(requestParameters: SiriStopsListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SiriStopPydanticModel>>; /** * Return a single siri vehicle location based on id * @summary Get * @param {number} id siri vehicle location id to get * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SiriApiInterface */ siriVehicleLocationsGetGetRaw(requestParameters: SiriVehicleLocationsGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SiriVehicleLocationPydanticModel>>; /** * Return a single siri vehicle location based on id * Get */ siriVehicleLocationsGetGet(requestParameters: SiriVehicleLocationsGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SiriVehicleLocationPydanticModel>; /** * List of siri vehicle locations. * @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 {string} [siriVehicleLocationIds] Filter by siri vehicle location id. Comma-separated list of values. * @param {string} [siriSnapshotIds] Filter by siri snapshot id. Comma-separated list of values. * @param {string} [siriRideStopIds] Filter by siri ride stop id. Comma-separated list of values. * @param {Date} [recordedAtTimeFrom] Filter by recorded at time. 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} [recordedAtTimeTo] Filter by recorded at time. 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 {number} [lonGreaterOrEqual] Filter by lon. Only return items which have a numeric value greater than or equal to given value Example: 34.808 * @param {number} [lonLowerOrEqual] Filter by lon. Only return items which have a numeric value lower than or equal to given value Example: 34.808 * @param {number} [latGreaterOrEqual] Filter by lat. Only return items which have a numeric value greater than or equal to given value Example: 31.961 * @param {number} [latLowerOrEqual] Filter by lat. Only return items which have a numeric value lower than or equal to given value Example: 31.961 * @param {string} [orderBy] Order of the results. Comma-separated list of fields and direction. e.g. \"field1 asc,field2 desc\". * @param {string} [siriRoutesLineRef] Filter by siri route line ref. Only return items which exactly match given string. * @param {string} [siriRideVehicleRef] Filter by siri ride vehicle ref. Only return items which exactly match given string. * @param {string} [siriRoutesOperatorRef] Filter by siri route operator ref. Only return items which exactly match given string. * @param {Date} [siriRidesSchedualedStartTimeFrom] Filter by siri ride scheduled start time. 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} [siriRidesSchedualedStartTimeTo] Filter by siri ride scheduled start time. 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} [siriRidesIds] Filter by siri ride id. Comma-separated list of values. * @param {string} [siriRoutesIds] Filter by siri route id. Comma-separated list of values. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SiriApiInterface */ siriVehicleLocationsListGetRaw(requestParameters: SiriVehicleLocationsListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SiriVehicleLocationWithRelatedPydanticModel>>>; /** * List of siri vehicle locations. * List */ siriVehicleLocationsListGet(requestParameters: SiriVehicleLocationsListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SiriVehicleLocationWithRelatedPydanticModel>>; /** * * @summary Siri Velocity Aggregation * @param {Date} recordedFrom start of recorded_at_time range, inclusive * @param {number} [lonMin] minimum longitude bound * @param {number} [lonMax] maximum longitude bound * @param {number} [latMin] minimum latitude bound * @param {number} [latMax] maximum latitude bound * @param {number} [roundingPrecision] lon/lat scaling factor, in powers of 2 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SiriApiInterface */ velocityAggregationSiriVelocityAggregationSiriVelocityAggregationGetRaw(requestParameters: VelocityAggregationSiriVelocityAggregationSiriVelocityAggregationGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SiriVelocityAggregationPydanticModel>>>; /** * Siri Velocity Aggregation */ velocityAggregationSiriVelocityAggregationSiriVelocityAggregationGet(requestParameters: VelocityAggregationSiriVelocityAggregationSiriVelocityAggregationGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SiriVelocityAggregationPydanticModel>>; } /** * */ export class SiriApi extends runtime.BaseAPI implements SiriApiInterface { /** * Return a single siri ride stop based on id * Get */ async siriRideStopsGetGetRaw(requestParameters: SiriRideStopsGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SiriRideStopPydanticModel>> { if (requestParameters['id'] == null) { throw new runtime.RequiredError( 'id', 'Required parameter "id" was null or undefined when calling siriRideStopsGetGet().' ); } const queryParameters: any = {}; if (requestParameters['id'] != null) { queryParameters['id'] = requestParameters['id']; } const headerParameters: runtime.HTTPHeaders = {}; let urlPath = `/siri_ride_stops/get`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => SiriRideStopPydanticModelFromJSON(jsonValue)); } /** * Return a single siri ride stop based on id * Get */ async siriRideStopsGetGet(requestParameters: SiriRideStopsGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SiriRideStopPydanticModel> { const response = await this.siriRideStopsGetGetRaw(requestParameters, initOverrides); return await response.value(); } /** * List of siri ride stops. * List */ async siriRideStopsListGetRaw(requestParameters: SiriRideStopsListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SiriRideStopWithRelatedPydanticModel>>> { 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['siriStopIds'] != null) { queryParameters['siri_stop_ids'] = requestParameters['siriStopIds']; } if (requestParameters['siriRideIds'] != null) { queryParameters['siri_ride_ids'] = requestParameters['siriRideIds']; } if (requestParameters['siriVehicleLocationLonGreaterOrEqual'] != null) { queryParameters['siri_vehicle_location__lon__greater_or_equal'] = requestParameters['siriVehicleLocationLonGreaterOrEqual']; } if (requestParameters['siriVehicleLocationLonLowerOrEqual'] != null) { queryParameters['siri_vehicle_location__lon__lower_or_equal'] = requestParameters['siriVehicleLocationLonLowerOrEqual']; } if (requestParameters['siriVehicleLocationLatGreaterOrEqual'] != null) { queryParameters['siri_vehicle_location__lat__greater_or_equal'] = requestParameters['siriVehicleLocationLatGreaterOrEqual']; } if (requestParameters['siriVehicleLocationLatLowerOrEqual'] != null) { queryParameters['siri_vehicle_location__lat__lower_or_equal'] = requestParameters['siriVehicleLocationLatLowerOrEqual']; } if (requestParameters['siriVehicleLocationRecordedAtTimeFrom'] != null) { queryParameters['siri_vehicle_location__recorded_at_time_from'] = (requestParameters['siriVehicleLocationRecordedAtTimeFrom'] as any).toISOString(); } if (requestParameters['siriVehicleLocationRecordedAtTimeTo'] != null) { queryParameters['siri_vehicle_location__recorded_at_time_to'] = (requestParameters['siriVehicleLocationRecordedAtTimeTo'] as any).toISOString(); } if (requestParameters['siriRideScheduledStartTimeFrom'] != null) { queryParameters['siri_ride__scheduled_start_time_from'] = (requestParameters['siriRideScheduledStartTimeFrom'] as any).toISOString(); } if (requestParameters['siriRideScheduledStartTimeTo'] != null) { queryParameters['siri_ride__scheduled_start_time_to'] = (requestParameters['siriRideScheduledStartTimeTo'] as any).toISOString(); } if (requestParameters['gtfsStopLatGreaterOrEqual'] != null) { queryParameters['gtfs_stop__lat__greater_or_equal'] = requestParameters['gtfsStopLatGreaterOrEqual']; } if (requestParameters['gtfsStopLatLowerOrEqual'] != null) { queryParameters['gtfs_stop__lat__lower_or_equal'] = requestParameters['gtfsStopLatLowerOrEqual']; } if (requestParameters['gtfsStopLonGreaterOrEqual'] != null) { queryParameters['gtfs_stop__lon__greater_or_equal'] = requestParameters['gtfsStopLonGreaterOrEqual']; } if (requestParameters['gtfsStopLonLowerOrEqual'] != null) { queryParameters['gtfs_stop__lon__lower_or_equal'] = requestParameters['gtfsStopLonLowerOrEqual']; } if (requestParameters['gtfsDateFrom'] != null) { queryParameters['gtfs_date_from'] = (requestParameters['gtfsDateFrom'] as any).toISOString().substring(0,10); } if (requestParameters['gtfsDateTo'] != null) { queryParameters['gtfs_date_to'] = (requestParameters['gtfsDateTo'] as any).toISOString().substring(0,10); } if (requestParameters['orderBy'] != null) { queryParameters['order_by'] = requestParameters['orderBy']; } const headerParameters: runtime.HTTPHeaders = {}; let urlPath = `/siri_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(SiriRideStopWithRelatedPydanticModelFromJSON)); } /** * List of siri ride stops. * List */ async siriRideStopsListGet(requestParameters: SiriRideStopsListGetRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SiriRideStopWithRelatedPydanticModel>> { const response = await this.siriRideStopsListGetRaw(requestParameters, initOverrides); return await response.value(); } /** * Return a single siri ride based on id * Get */ async siriRidesGetGetRaw(requestParameters: SiriRidesGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SiriRidePydanticModel>> { if (requestParameters['id'] == null) { throw new runtime.RequiredError( 'id', 'Required parameter "id" was null or undefined when calling siriRidesGetGet().' ); } const queryParameters: any = {}; if (requestParameters['id'] != null) { queryParameters['id'] = requestParameters['id']; } const headerParameters: runtime.HTTPHeaders = {}; let urlPath = `/siri_rides/get`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => SiriRidePydanticModelFromJSON(jsonValue)); } /** * Return a single siri ride based on id * Get */ async siriRidesGetGet(requestParameters: SiriRidesGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SiriRidePydanticModel> { const response = await this.siriRidesGetGetRaw(requestParameters, initOverrides); return await response.value(); } /** * List of siri rides. * List */ async siriRidesListGetRaw(requestParameters: SiriRidesListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SiriRideWithRelatedPydanticModel>>> { 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['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['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['siriRouteIds'] != null) { queryParameters['siri_route_ids'] = requestParameters['siriRouteIds']; } if (requestParameters['siriRouteLineRefs'] != null) { queryParameters['siri_route__line_refs'] = requestParameters['siriRouteLineRefs']; } if (requestParameters['siriRouteOperatorRefs'] != null) { queryParameters['siri_route__operator_refs'] = requestParameters['siriRouteOperatorRefs']; } if (requestParameters['journeyRefPrefix'] != null) { queryParameters['journey_ref_prefix'] = requestParameters['journeyRefPrefix']; } if (requestParameters['journeyRefs'] != null) { queryParameters['journey_refs'] = requestParameters['journeyRefs']; } if (requestParameters['vehicleRefs'] != null) { queryParameters['vehicle_refs'] = requestParameters['vehicleRefs']; } if (requestParameters['scheduledStartTimeFrom'] != null) { queryParameters['scheduled_start_time_from'] = (requestParameters['scheduledStartTimeFrom'] as any).toISOString(); } if (requestParameters['scheduledStartTimeTo'] != null) { queryParameters['scheduled_start_time_to'] = (requestParameters['scheduledStartTimeTo'] as any).toISOString(); } if (requestParameters['orderBy'] != null) { queryParameters['order_by'] = requestParameters['orderBy']; } const headerParameters: runtime.HTTPHeaders = {}; let urlPath = `/siri_rides/list`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(SiriRideWithRelatedPydanticModelFromJSON)); } /** * List of siri rides. * List */ async siriRidesListGet(requestParameters: SiriRidesListGetRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SiriRideWithRelatedPydanticModel>> { const response = await this.siriRidesListGetRaw(requestParameters, initOverrides); return await response.value(); } /** * Return a single siri route based on id * Get */ async siriRoutesGetGetRaw(requestParameters: SiriRoutesGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SiriRoutePydanticModel>> { if (requestParameters['id'] == null) { throw new runtime.RequiredError( 'id', 'Required parameter "id" was null or undefined when calling siriRoutesGetGet().' ); } const queryParameters: any = {}; if (requestParameters['id'] != null) { queryParameters['id'] = requestParameters['id']; } const headerParameters: runtime.HTTPHeaders = {}; let urlPath = `/siri_routes/get`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => SiriRoutePydanticModelFromJSON(jsonValue)); } /** * Return a single siri route based on id * Get */ async siriRoutesGetGet(requestParameters: SiriRoutesGetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SiriRoutePydanticModel> { const response = await this.siriRoutesGetGetRaw(requestParameters, initOverrides); return await response.value(); } /** * List of siri routes. * List */ async siriRoutesListGetRaw(requestParameters: SiriRoutesListGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SiriRoutePydanticModel>>> { 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['lineRefs'] != null) { queryParameters['line_refs'] = requestParameters['lineRefs']; } if (requestParameters['operatorRefs'] != null) { queryParameters['operator_refs'] = requestParameters['operatorRefs']; } if (requestParameters['orderBy'] != null) { queryParameters['order_by'] = requestParameters['orderBy']; } const headerParameters: runtime.HTTPHeaders = {}; let urlPath = `/siri_routes/list`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(SiriRoutePydanticModelFromJSON)); } /**