golemio-sdk

/** * 🚋 Public Transport | Golemio API * <p><img src=\"https://storage.golemio.cz/golemiocz/images/golemioapi_logos.png\" alt=\"Logos\" /></p> <p><b>Toto je část dokumentace REST API projektu pražské datové platformy Golemio, která obsahuje popis Public Transport Output Gateway API.</b></p> <p>Veškeré dotazy prosím směřujte na <a href=\"mailto:golemio@operatorict.cz?subject=golemioapi\">golemio@operatorict.cz</a>.</p> <p>Dokumentace je v anglickém jazyce. Více informací o projektu naleznete na <a href=\"https://www.golemio.cz/\">www.golemio.cz</a>.</p> <H1>Description</H1> <p><b>This documentation covers the RESTful API of the Golemio Prague Data Platform project, specifically detailing the Public Transport Output Gateway API.</b></p> <p>Support is accessible via <a href=\"mailto:golemio@operatorict.cz?subject=golemioapi\">golemio@operatorict.cz</a>.</p> <p>For more information about Golemio, please visit the website <a href=\"https://www.golemio.cz/\">www.golemio.cz</a>.</p> <H2>Golemio API documentation:</H2> <li><a href=\"https://api.golemio.cz/docs/openapi/\">Main Golemio API</a></li> <li><a href=\"https://api.golemio.cz/docs/public-openapi/\">Open Data Golemio API</a></li> <li><a href=\"https://api.golemio.cz/input-gateway/docs/openapi/\">Golemio Input Gateway API</a></li> <li>👉 Public Transport Golemio API</li> <li><a href=\"https://api.golemio.cz/pid/input-gateway/docs/openapi/\">Public Transport Golemio Input Gateway API</a></li> <H1>General info</H1> <H2>Authorization</H2> <p>Generate your token at <a href=\"https://api.golemio.cz/api-keys\">api.golemio.cz/api-keys</a>.</p> <p><b>Use the token as the value of the X-Access-Token header.</b></p> <H1>Usage</H1> <H2>Pagination</H2> <p>The API returns a maximum of 10,000 objects/rows per request. You can specify a lower number by adding the <code>?limit</code> URL parameter.</p> <p> This limit may vary depending on the specific route; please refer to the description of parameters for each route. To retrieve more data, use multiple requests with the <code>?limit&offset</code> parameters. Refer to the examples below. </p> <H2>Requests rate</H2> <p>By default, each API key has a rate limit of 20 requests per 8 seconds.</p> <H2>Compression</H2> <p>By default, the Content-Encoding header is set to gzip (if requested). If the raw response is less than 1 KB, the data is returned uncompressed, and the Content-Encoding header is not set.</p> <H2>General Transit Feed Specification</H2> <p>Access GTFS (<a href=\"https://developers.google.com/transit/gtfs\">General Transit Feed Specification</a>) data on the city\'s public transportation schedules through this API.</p> <p>The data is published by ROPID and remains valid for the upcoming ~12 days, subject to daily updates.</p> <p>Learn more at <a href=\"https://pid.cz/o-systemu/opendata/\">pid.cz</a>.</p> <H2>Open Data</H2> <p><img src=\"https://img.shields.io/badge/opendata-available-green\" alt=\"golemioapi-opendata-badge\" /></p> <p>This badge means it is available for public use as Open Data.</p> * * The version of the OpenAPI document: 1.0.0 * Contact: golemio@operatorict.cz * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { ConfigurationParameters as GolemioPublicTransportApiConfiguration } from './configuration'; import type { AxiosInstance, AxiosRequestConfig } from 'axios'; import { BaseAPI } from './base'; export { ConfigurationParameters as GolemioPublicTransportApiConfiguration } from './configuration'; export declare class GolemioPublicTransportApi { GTFSRealtimeV2Api: GolemioPublicTransportApi.GTFSRealtimeV2Api; GTFSStaticV2Api: GolemioPublicTransportApi.GTFSStaticV2Api; JISV1Api: GolemioPublicTransportApi.JISV1Api; PIDDepartureBoardsV2Api: GolemioPublicTransportApi.PIDDepartureBoardsV2Api; PIDDepartureBoardsV3Api: GolemioPublicTransportApi.PIDDepartureBoardsV3Api; PIDDepartureBoardsV3InternalApi: GolemioPublicTransportApi.PIDDepartureBoardsV3InternalApi; PIDRealtimePositionsV2Api: GolemioPublicTransportApi.PIDRealtimePositionsV2Api; PublicDeparturesV2Api: GolemioPublicTransportApi.PublicDeparturesV2Api; PublicGTFSStaticLookupV2Api: GolemioPublicTransportApi.PublicGTFSStaticLookupV2Api; PublicVehiclePositionsV2Api: GolemioPublicTransportApi.PublicVehiclePositionsV2Api; constructor(configurationParams: GolemioPublicTransportApiConfiguration, axios?: AxiosInstance); } export declare namespace GolemioPublicTransportApi { /** * * @export * @interface ASWid */ interface ASWid { /** * ASW ID of node * @type {number} * @memberof ASWid */ 'node': number; /** * Identification of the stop within the node. * @type {number} * @memberof ASWid */ 'stop': number; } /** * * @export * @interface Effect */ interface Effect { /** * * @type {string} * @memberof Effect */ 'cs': string; /** * * @type {string} * @memberof Effect */ 'en'?: string | null; } /** * * @export * @interface EventCustomFormat */ interface EventCustomFormat { /** * * @type {string} * @memberof EventCustomFormat */ 'id': string; /** * * @type {string} * @memberof EventCustomFormat */ 'type': EventCustomFormatTypeEnum; /** * * @type {EventCustomFormatHeaderText} * @memberof EventCustomFormat */ 'header_text': EventCustomFormatHeaderText; /** * * @type {EventCustomFormatCause} * @memberof EventCustomFormat */ 'cause': EventCustomFormatCause; /** * * @type {EventCustomFormatCauseDetail} * @memberof EventCustomFormat */ 'cause_detail': EventCustomFormatCauseDetail; /** * INFO - priority 3 \\ WARNING - priority 2 \\ SEVERE - priority 1 * @type {string} * @memberof EventCustomFormat */ 'severity_level': EventCustomFormatSeverityLevelEnum; /** * * @type {EventCustomFormatActivePeriod} * @memberof EventCustomFormat */ 'active_period': EventCustomFormatActivePeriod; /** * * @type {EventCustomFormatDisplayPeriod} * @memberof EventCustomFormat */ 'display_period': EventCustomFormatDisplayPeriod; /** * * @type {Array<Effect>} * @memberof EventCustomFormat */ 'effects': Array<Effect>; /** * * @type {EventCustomFormatDescriptionText} * @memberof EventCustomFormat */ 'description_text': EventCustomFormatDescriptionText; /** * * @type {EventCustomFormatDescriptionHtml} * @memberof EventCustomFormat */ 'description_html': EventCustomFormatDescriptionHtml; /** * * @type {string} * @memberof EventCustomFormat */ 'organization_name': string; /** * * @type {EventCustomFormatInformedEntity} * @memberof EventCustomFormat */ 'informed_entity': EventCustomFormatInformedEntity | null; /** * Timestamp from when the event was last modified in VYMI * @type {string} * @memberof EventCustomFormat */ 'last_modified_timestamp': string; /** * Timestamp from when the event was created in VYMI * @type {string} * @memberof EventCustomFormat */ 'created_timestamp': string; } const EventCustomFormatTypeEnum: { readonly Incident: "INCIDENT"; readonly Disruption: "DISRUPTION"; readonly ServiceChange: "SERVICE_CHANGE"; }; type EventCustomFormatTypeEnum = typeof EventCustomFormatTypeEnum[keyof typeof EventCustomFormatTypeEnum]; const EventCustomFormatSeverityLevelEnum: { readonly Info: "INFO"; readonly Warning: "WARNING"; readonly Severe: "SEVERE"; }; type EventCustomFormatSeverityLevelEnum = typeof EventCustomFormatSeverityLevelEnum[keyof typeof EventCustomFormatSeverityLevelEnum]; /** * The start and end date/time of the event validity * @export * @interface EventCustomFormatActivePeriod */ interface EventCustomFormatActivePeriod { /** * * @type {string} * @memberof EventCustomFormatActivePeriod */ 'start': string; /** * * @type {string} * @memberof EventCustomFormatActivePeriod */ 'end': string | null; } /** * * @export * @interface EventCustomFormatCause */ interface EventCustomFormatCause { /** * * @type {string} * @memberof EventCustomFormatCause */ 'cs': string; /** * * @type {string} * @memberof EventCustomFormatCause */ 'en'?: string | null; } /** * * @export * @interface EventCustomFormatCauseDetail */ interface EventCustomFormatCauseDetail { /** * * @type {string} * @memberof EventCustomFormatCauseDetail */ 'cs': string; /** * * @type {string} * @memberof EventCustomFormatCauseDetail */ 'en'?: string | null; } /** * Localized descriptions of the event in HTML format * @export * @interface EventCustomFormatDescriptionHtml */ interface EventCustomFormatDescriptionHtml { /** * Event description in Czech in HTML format * @type {string} * @memberof EventCustomFormatDescriptionHtml */ 'cs': string; /** * Event description in English in HTML format * @type {string} * @memberof EventCustomFormatDescriptionHtml */ 'en'?: string | null; } /** * Localized descriptions of the event in plain text * @export * @interface EventCustomFormatDescriptionText */ interface EventCustomFormatDescriptionText { /** * Event description in Czech in plain text * @type {string} * @memberof EventCustomFormatDescriptionText */ 'cs': string; /** * Event description in English in plain text * @type {string} * @memberof EventCustomFormatDescriptionText */ 'en'?: string | null; } /** * The start and end date/time when the event should be displayed * @export * @interface EventCustomFormatDisplayPeriod */ interface EventCustomFormatDisplayPeriod { /** * * @type {string} * @memberof EventCustomFormatDisplayPeriod */ 'start': string; /** * * @type {string} * @memberof EventCustomFormatDisplayPeriod */ 'end': string | null; } /** * * @export * @interface EventCustomFormatHeaderText */ interface EventCustomFormatHeaderText { /** * * @type {string} * @memberof EventCustomFormatHeaderText */ 'cs': string; /** * * @type {string} * @memberof EventCustomFormatHeaderText */ 'en'?: string | null; } /** * * @export * @interface EventCustomFormatInformedEntity */ interface EventCustomFormatInformedEntity { /** * * @type {Array<InformedEntityRoute>} * @memberof EventCustomFormatInformedEntity */ 'routes'?: Array<InformedEntityRoute> | null; } /** * * @export * @interface FeaturePoint */ interface FeaturePoint { /** * * @type {FeaturePointGeometry} * @memberof FeaturePoint */ 'geometry': FeaturePointGeometry; /** * * @type {object} * @memberof FeaturePoint */ 'properties': object; /** * * @type {string} * @memberof FeaturePoint */ 'type': string; } /** * * @export * @interface FeaturePointGeometry */ interface FeaturePointGeometry { /** * * @type {string} * @memberof FeaturePointGeometry */ 'type': string; /** * * @type {Array<number>} * @memberof FeaturePointGeometry */ 'coordinates': Array<number>; } /** * * @export * @interface GTFSRoute */ interface GTFSRoute { /** * * @type {string} * @memberof GTFSRoute */ 'agency_id': string; /** * * @type {boolean} * @memberof GTFSRoute */ 'is_night': boolean; /** * * @type {boolean} * @memberof GTFSRoute */ 'is_regional': boolean; /** * * @type {boolean} * @memberof GTFSRoute */ 'is_substitute_transport': boolean; /** * * @type {string} * @memberof GTFSRoute */ 'last_modify'?: string | null; /** * * @type {string} * @memberof GTFSRoute */ 'route_color': string; /** * * @type {string} * @memberof GTFSRoute */ 'route_desc'?: string | null; /** * * @type {string} * @memberof GTFSRoute */ 'route_id': string; /** * * @type {string} * @memberof GTFSRoute */ 'route_long_name': string; /** * * @type {string} * @memberof GTFSRoute */ 'route_short_name': string; /** * * @type {string} * @memberof GTFSRoute */ 'route_text_color': string; /** * * @type {number} * @memberof GTFSRoute */ 'route_type': number; /** * * @type {string} * @memberof GTFSRoute */ 'route_url': string; } /** * * @export * @interface GTFSService */ interface GTFSService { /** * * @type {string} * @memberof GTFSService */ 'end_date': string; /** * * @type {string} * @memberof GTFSService */ 'last_modify'?: string | null; /** * * @type {number} * @memberof GTFSService */ 'monday': number; /** * * @type {number} * @memberof GTFSService */ 'tuesday': number; /** * * @type {number} * @memberof GTFSService */ 'wednesday': number; /** * * @type {number} * @memberof GTFSService */ 'thursday': number; /** * * @type {number} * @memberof GTFSService */ 'friday': number; /** * * @type {number} * @memberof GTFSService */ 'saturday': number; /** * * @type {number} * @memberof GTFSService */ 'sunday': number; /** * * @type {string} * @memberof GTFSService */ 'service_id'?: string; /** * * @type {string} * @memberof GTFSService */ 'start_date'?: string; } /** * * @export * @interface GTFSShape */ interface GTFSShape { /** * * @type {number} * @memberof GTFSShape */ 'shape_dist_traveled': number; /** * * @type {string} * @memberof GTFSShape */ 'shape_id': string; /** * * @type {number} * @memberof GTFSShape */ 'shape_pt_sequence': number; } /** * * @export * @interface GTFSStop */ interface GTFSStop { /** * * @type {number} * @memberof GTFSStop */ 'location_type': number; /** * * @type {string} * @memberof GTFSStop */ 'parent_station': string | null; /** * * @type {string} * @memberof GTFSStop */ 'platform_code': string; /** * * @type {string} * @memberof GTFSStop */ 'stop_id': string; /** * * @type {string} * @memberof GTFSStop */ 'stop_name': string; /** * * @type {number} * @memberof GTFSStop */ 'wheelchair_boarding': number; /** * * @type {string} * @memberof GTFSStop */ 'zone_id': string; /** * * @type {string} * @memberof GTFSStop */ 'level_id': string | null; } /** * * @export * @interface GTFSStopTime */ interface GTFSStopTime { /** * * @type {string} * @memberof GTFSStopTime */ 'arrival_time': string; /** * * @type {string} * @memberof GTFSStopTime */ 'departure_time': string; /** * * @type {string} * @memberof GTFSStopTime */ 'drop_off_type': string; /** * * @type {string} * @memberof GTFSStopTime */ 'last_modify'?: string | null; /** * * @type {string} * @memberof GTFSStopTime */ 'pickup_type': string; /** * * @type {number} * @memberof GTFSStopTime */ 'shape_dist_traveled': number; /** * * @type {string} * @memberof GTFSStopTime */ 'stop_headsign'?: string; /** * * @type {string} * @memberof GTFSStopTime */ 'stop_id': string; /** * * @type {number} * @memberof GTFSStopTime */ 'stop_sequence': number; /** * * @type {string} * @memberof GTFSStopTime */ 'trip_id': string; } /** * * @export * @interface GTFSTrip */ interface GTFSTrip { /** * * @type {string} * @memberof GTFSTrip */ 'trip_id': string; /** * * @type {number} * @memberof GTFSTrip */ 'bikes_allowed': number; /** * * @type {string} * @memberof GTFSTrip */ 'block_id'?: string | null; /** * * @type {number} * @memberof GTFSTrip */ 'direction_id'?: number; /** * * @type {number} * @memberof GTFSTrip */ 'exceptional'?: number; /** * * @type {string} * @memberof GTFSTrip */ 'last_modify'?: string | null; /** * * @type {string} * @memberof GTFSTrip */ 'route_id': string; /** * * @type {string} * @memberof GTFSTrip */ 'service_id': string; /** * * @type {string} * @memberof GTFSTrip */ 'shape_id': string; /** * * @type {string} * @memberof GTFSTrip */ 'trip_headsign': string; /** * * @type {number} * @memberof GTFSTrip */ 'wheelchair_accessible': number; } /** * GeoJson point * @export * @interface GeometryPoint */ interface GeometryPoint { /** * Point * @type {Array<number>} * @memberof GeometryPoint */ 'coordinates'?: Array<number>; /** * * @type {string} * @memberof GeometryPoint */ 'type'?: GeometryPointTypeEnum; } const GeometryPointTypeEnum: { readonly Point: "Point"; }; type GeometryPointTypeEnum = typeof GeometryPointTypeEnum[keyof typeof GeometryPointTypeEnum]; /** * * @export * @interface InformedEntityRoute */ interface InformedEntityRoute { /** * * @type {string} * @memberof InformedEntityRoute */ 'id': string; /** * * @type {string} * @memberof InformedEntityRoute */ 'route_short_name': string; /** * * @type {string} * @memberof InformedEntityRoute */ 'route_long_name': string; /** * * @type {RouteType} * @memberof InformedEntityRoute */ 'route_type': RouteType; } /** * * @export * @interface InlineObject */ interface InlineObject { /** * * @type {string} * @memberof InlineObject */ 'error_message': string; /** * * @type {number} * @memberof InlineObject */ 'error_status': number; /** * * @type {string} * @memberof InlineObject */ 'error_info'?: string | null; } /** * * @export * @interface InlineObject1 */ interface InlineObject1 { /** * * @type {string} * @memberof InlineObject1 */ 'error_message': string; /** * * @type {number} * @memberof InlineObject1 */ 'error_status': number; } /** * * @export * @interface PIDDepartureBoard */ interface PIDDepartureBoard { /** * List of stops in the requested set and their properties. * @type {Array<PIDDepartureBoardStop>} * @memberof PIDDepartureBoard */ 'stops'?: Array<PIDDepartureBoardStop>; /** * List of departures. * @type {Array<PIDDepartureBoardDeparture>} * @memberof PIDDepartureBoard */ 'departures'?: Array<PIDDepartureBoardDeparture>; /** * List of active infotexts for selected stops. * @type {Array<PIDDepartureBoardInfotextsInner>} * @memberof PIDDepartureBoard */ 'infotexts'?: Array<PIDDepartureBoardInfotextsInner>; } /** * * @export * @interface PIDDepartureBoardDelay */ interface PIDDepartureBoardDelay { /** * True if information about trip\'s delay is available. * @type {boolean} * @memberof PIDDepartureBoardDelay */ 'is_available': boolean; /** * Delay rounded down to minutes. * @type {number} * @memberof PIDDepartureBoardDelay */ 'minutes': number | null; /** * Delay in seconds. * @type {number} * @memberof PIDDepartureBoardDelay */ 'seconds': number | null; } /** * * @export * @interface PIDDepartureBoardDeparture */ interface PIDDepartureBoardDeparture { /** * * @type {PIDDepartureBoardStopTime} * @memberof PIDDepartureBoardDeparture */ 'arrival_timestamp'?: PIDDepartureBoardStopTime; /** * * @type {PIDDepartureBoardDelay} * @memberof PIDDepartureBoardDeparture */ 'delay'?: PIDDepartureBoardDelay; /** * * @type {PIDDepartureBoardStopTime} * @memberof PIDDepartureBoardDeparture */ 'departure_timestamp'?: PIDDepartureBoardStopTime; /** * * @type {PIDDepartureBoardLastStop} * @memberof PIDDepartureBoardDeparture */ 'last_stop'?: PIDDepartureBoardLastStop; /** * * @type {PIDDepartureBoardRoute} * @memberof PIDDepartureBoardDeparture */ 'route'?: PIDDepartureBoardRoute; /** * * @type {PIDDepartureBoardStopReference} * @memberof PIDDepartureBoardDeparture */ 'stop'?: PIDDepartureBoardStopReference; /** * * @type {PIDDepartureBoardTrip} * @memberof PIDDepartureBoardDeparture */ 'trip'?: PIDDepartureBoardTrip; } /** * * @export * @interface PIDDepartureBoardInfotext */ interface PIDDepartureBoardInfotext { /** * Intended time of infotext publishing in ISO String. * @type {string} * @memberof PIDDepartureBoardInfotext */ 'valid_from': string | null; /** * Intended time of infotext removal in ISO String. If `null`, the infotext is valid indefinitely * @type {string} * @memberof PIDDepartureBoardInfotext */ 'valid_to': string | null; /** * Information text in Czech. * @type {string} * @memberof PIDDepartureBoardInfotext */ 'text': string; /** * Information text in English. * @type {string} * @memberof PIDDepartureBoardInfotext */ 'text_en': string | null; /** * Type of display on board by the intended form of presentation (where applicable). Enumerating `inline` (to be presented along with departures, usually in a marquee), `general` (to be displayed full screen instead of departures). * @type {string} * @memberof PIDDepartureBoardInfotext */ 'display_type': PIDDepartureBoardInfotextDisplayTypeEnum; } const PIDDepartureBoardInfotextDisplayTypeEnum: { readonly Inline: "inline"; readonly General: "general"; }; type PIDDepartureBoardInfotextDisplayTypeEnum = typeof PIDDepartureBoardInfotextDisplayTypeEnum[keyof typeof PIDDepartureBoardInfotextDisplayTypeEnum]; /** * * @export * @interface PIDDepartureBoardInfotextsInner */ interface PIDDepartureBoardInfotextsInner { /** * Intended time of infotext publishing in ISO String. * @type {string} * @memberof PIDDepartureBoardInfotextsInner */ 'valid_from': string | null; /** * Intended time of infotext removal in ISO String. If `null`, the infotext is valid indefinitely * @type {string} * @memberof PIDDepartureBoardInfotextsInner */ 'valid_to': string | null; /** * Information text in Czech. * @type {string} * @memberof PIDDepartureBoardInfotextsInner */ 'text': string; /** * Information text in English. * @type {string} * @memberof PIDDepartureBoardInfotextsInner */ 'text_en': string | null; /** * Type of display on board by the intended form of presentation (where applicable). Enumerating `inline` (to be presented along with departures, usually in a marquee), `general` (to be displayed full screen instead of departures). * @type {string} * @memberof PIDDepartureBoardInfotextsInner */ 'display_type': PIDDepartureBoardInfotextsInnerDisplayTypeEnum; /** * * @type {Array<string>} * @memberof PIDDepartureBoardInfotextsInner */ 'related_stops'?: Array<string>; } const PIDDepartureBoardInfotextsInnerDisplayTypeEnum: { readonly Inline: "inline"; readonly General: "general"; }; type PIDDepartureBoardInfotextsInnerDisplayTypeEnum = typeof PIDDepartureBoardInfotextsInnerDisplayTypeEnum[keyof typeof PIDDepartureBoardInfotextsInnerDisplayTypeEnum]; /** * * @export * @interface PIDDepartureBoardLastStop */ interface PIDDepartureBoardLastStop { /** * Name of the last stop the vehicle reported from. * @type {string} * @memberof PIDDepartureBoardLastStop */ 'name': string | null; /** * GTFS ID of the stop. * @type {string} * @memberof PIDDepartureBoardLastStop */ 'id': string | null; } /** * * @export * @interface PIDDepartureBoardRoute */ interface PIDDepartureBoardRoute { /** * Route designation used by PID. * @type {string} * @memberof PIDDepartureBoardRoute */ 'short_name': string | null; /** * GTFS route type. `0` – tram, `1` – metro, `2` – train, `3` – bus, `4` – ferry, `7` – funicular, `11` – trolleybus * @type {number} * @memberof PIDDepartureBoardRoute */ 'type': number | null; /** * True if route is a designated night route. * @type {boolean} * @memberof PIDDepartureBoardRoute */ 'is_night': boolean; /** * True if route serves areas outside Prague boundaries. * @type {boolean} * @memberof PIDDepartureBoardRoute */ 'is_regional': boolean; /** * True if route provides substitute service for another route. * @type {boolean} * @memberof PIDDepartureBoardRoute */ 'is_substitute_transport': boolean; } /** * * @export * @interface PIDDepartureBoardStop */ interface PIDDepartureBoardStop { /** * Level of metro stops. * @type {string} * @memberof PIDDepartureBoardStop */ 'level_id': string | null; /** * Describes the type of stop, is always `0`. * @type {number} * @memberof PIDDepartureBoardStop */ 'location_type': number; /** * A GTFS identifier of the parent station for metro platforms. * @type {string} * @memberof PIDDepartureBoardStop */ 'parent_station': string; /** * Human-friendly code used to distinguish a stop inside a node. Multiple GTFS codes can share a platform code. * @type {string} * @memberof PIDDepartureBoardStop */ 'platform_code': string; /** * Latitude of the stop marker or the center of metro or train station platform. * @type {number} * @memberof PIDDepartureBoardStop */ 'stop_lat': number; /** * Longitude of the stop marker or the center of metro or train station platform. * @type {number} * @memberof PIDDepartureBoardStop */ 'stop_lon': number; /** * * @type {ASWid} * @memberof PIDDepartureBoardStop */ 'asw_id': ASWid; /** * GTFS ID of the stop. Stops that will be valid in the future have the date of the start of their validity appended, i.e. `U476Z51P_210401`. * @type {string} * @memberof PIDDepartureBoardStop */ 'stop_id': string; /** * Name of the stop. * @type {string} * @memberof PIDDepartureBoardStop */ 'stop_name': string; /** * Indicates accessibility of the stop by wheelchairs. `0` – unknown, `1` – accessible, `2` – inaccessible * @type {number} * @memberof PIDDepartureBoardStop */ 'wheelchair_boarding': number; /** * PID fare zone. Multiple zones are separated by a comma. * @type {string} * @memberof PIDDepartureBoardStop */ 'zone_id': string; } /** * * @export * @interface PIDDepartureBoardStopReference */ interface PIDDepartureBoardStopReference { /** * GTFS ID of the stop the vehicle is stopping at. * @type {string} * @memberof PIDDepartureBoardStopReference */ 'id': string; /** * For trains it is the platform number the train is stopping at. Is `null` if not known. For other modes of transport, returns the platform code from `stops[]`. * @type {string} * @memberof PIDDepartureBoardStopReference */ 'platform_code': string | null; } /** * * @export * @interface PIDDepartureBoardStopTime */ interface PIDDepartureBoardStopTime { /** * Time of arrival/departure including realtime delay as an ISO String (UTC). Is `null` on start/end stops. Is same as scheduled time when no delay is available. Is `null` on first/last stops. * @type {string} * @memberof PIDDepartureBoardStopTime */ 'predicted': string; /** * Time of arrival/departure as ISO string (UTC). * @type {string} * @memberof PIDDepartureBoardStopTime */ 'scheduled': string; /** * Number of minutes till departure. If it is less than 30 second it returns value \"<1\". * @type {string} * @memberof PIDDepartureBoardStopTime */ 'minutes'?: string; } /** * * @export * @interface PIDDepartureBoardTrip */ interface PIDDepartureBoardTrip { /** * The equivalent of arrows that are printed on stop signs. Indicates the direction the vehicle will continue at stops where routes split up relative to the direction of motion of the vehicle. Valid values: `null` (do not display the arrow), `top`, `top-right`, `right`, `bottom-right`, `bottom`, `bottom-left`, `left`, `top-left`. * @type {string} * @memberof PIDDepartureBoardTrip */ 'direction': string | null; /** * Trip headsign (usually the final stop). * @type {string} * @memberof PIDDepartureBoardTrip */ 'headsign': string; /** * GTFS trip ID. * @type {string} * @memberof PIDDepartureBoardTrip */ 'id': string; /** * True if vehicle is physically present in the stop. Applicable only to connections with delay available. * @type {boolean} * @memberof PIDDepartureBoardTrip */ 'is_at_stop': boolean; /** * True if the trip is canceled. * @type {boolean} * @memberof PIDDepartureBoardTrip */ 'is_canceled': boolean; /** * True if the vehicle being used on this trip is wheelchair accessible. Metro trips are deemed accessible if the station is accessible. * @type {boolean} * @memberof PIDDepartureBoardTrip */ 'is_wheelchair_accessible': boolean; /** * Determines whether the vehicle has air conditioning. If `null`, the information is not available or the vehicle\'s registration number is not known. * @type {boolean} * @memberof PIDDepartureBoardTrip */ 'is_air_conditioned': boolean | null; /** * The number of a particular train, otherwise `null`. * @type {string} * @memberof PIDDepartureBoardTrip */ 'short_name': string | null; } /** * * @export * @interface PublicDeparture */ interface PublicDeparture { /** * * @type {string} * @memberof PublicDeparture */ 'timestamp_scheduled': string; /** * * @type {string} * @memberof PublicDeparture */ 'timestamp_predicted': string; /** * Delay in seconds * @type {number} * @memberof PublicDeparture */ 'delay_seconds'?: number | null; /** * Minutes until the departure * @type {number} * @memberof PublicDeparture */ 'minutes': number; } /** * * @export * @interface PublicDepartureGroupInner */ interface PublicDepartureGroupInner { /** * * @type {PublicDeparture} * @memberof PublicDepartureGroupInner */ 'departure': PublicDeparture; /** * * @type {PublicDepartureStop} * @memberof PublicDepartureGroupInner */ 'stop': PublicDepartureStop; /** * * @type {PublicDepartureRoute} * @memberof PublicDepartureGroupInner */ 'route': PublicDepartureRoute; /** * * @type {PublicDepartureTrip} * @memberof PublicDepartureGroupInner */ 'trip': PublicDepartureTrip; /** * * @type {PublicDepartureVehicle} * @memberof PublicDepartureGroupInner */ 'vehicle': PublicDepartureVehicle; } /** * * @export * @interface PublicDepartureRoute */ interface PublicDepartureRoute { /** * * @type {string} * @memberof PublicDepartureRoute */ 'type': PublicDepartureRouteTypeEnum; /** * * @type {string} * @memberof PublicDepartureRoute */ 'short_name': string; } const PublicDepartureRouteTypeEnum: { readonly Tram: "tram"; readonly Metro: "metro"; readonly Train: "train"; readonly Bus: "bus"; readonly Ferry: "ferry"; readonly Funicular: "funicular"; readonly Trolleybus: "trolleybus"; readonly ExtMiscellaneous: "ext_miscellaneous"; }; type PublicDepartureRouteTypeEnum = typeof PublicDepartureRouteTypeEnum[keyof typeof PublicDepartureRouteTypeEnum]; /** * * @export * @interface PublicDepartureStop */ interface PublicDepartureStop { /** * * @type {string} * @memberof PublicDepartureStop */ 'id': string; /** * * @type {number} * @memberof PublicDepartureStop */ 'sequence': number; /** * * @type {string} * @memberof PublicDepartureStop */ 'platform_code'?: string | null; } /** * * @export * @interface PublicDepartureTrip */ interface PublicDepartureTrip { /** * * @type {string} * @memberof PublicDepartureTrip */ 'id': string; /** * * @type {string} * @memberof PublicDepartureTrip */ 'headsign': string; /** * * @type {boolean} * @memberof PublicDepartureTrip */ 'is_canceled'?: boolean | null; } /** * * @export * @interface PublicDepartureVehicle */ interface PublicDepartureVehicle { /** * * @type {string} * @memberof PublicDepartureVehicle */ 'id'?: string | null; /** * * @type {boolean} * @memberof PublicDepartureVehicle */ 'is_wheelchair_accessible'?: boolean | null; /** * * @type {boolean} * @memberof PublicDepartureVehicle */ 'is_air_conditioned'?: boolean | null; /** * * @type {boolean} * @memberof PublicDepartureVehicle */ 'has_charger'?: boolean | null; } /** * * @export * @interface PublicTripShapeFeatureCollection */ interface PublicTripShapeFeatureCollection { /** * * @type {Array<PublicTripShapeFeatureCollectionFeaturesInner>} * @memberof PublicTripShapeFeatureCollection */ 'features'?: Array<PublicTripShapeFeatureCollectionFeaturesInner>; /** * * @type {string} * @memberof PublicTripShapeFeatureCollection */ 'type'?: string; } /** * * @export * @interface PublicTripShapeFeatureCollectionFeaturesInner */ interface PublicTripShapeFeatureCollectionFeaturesInner { /** * * @type {GeometryPoint} * @memberof PublicTripShapeFeatureCollectionFeaturesInner */ 'geometry'?: GeometryPoint; /** * * @type {PublicTripShapeFeatureCollectionFeaturesInnerProperties} * @memberof PublicTripShapeFeatureCollectionFeaturesInner */ 'properties'?: PublicTripShapeFeatureCollectionFeaturesInnerProperties; /** * * @type {string} * @memberof PublicTripShapeFeatureCollectionFeaturesInner */ 'type'?: string; } /** * * @export * @interface PublicTripShapeFeatureCollectionFeaturesInnerProperties */ interface PublicTripShapeFeatureCollectionFeaturesInnerProperties { /** * Distance from the first stop of the trip. * @type {number} * @memberof PublicTripShapeFeatureCollectionFeaturesInnerProperties */ 'shape_dist_traveled'?: number; } /** * List of stop and arrival, departure times for the trip. No stop waypoints are not included. * @export * @interface PublicTripStaticStopTimeFeatureCollection */ interface PublicTripStaticStopTimeFeatureCollection { /** * * @type {Array<PublicTripStaticStopTimeFeatureCollectionFeaturesInner>} * @memberof PublicTripStaticStopTimeFeatureCollection */ 'features'?: Array<PublicTripStaticStopTimeFeatureCollectionFeaturesInner>; /** * * @type {string} * @memberof PublicTripStaticStopTimeFeatureCollection */ 'type'?: string; } /** * * @export * @interface PublicTripStaticStopTimeFeatureCollectionFeaturesInner */ interface PublicTripStaticStopTimeFeatureCollectionFeaturesInner { /** * * @type {GeometryPoint} * @memberof PublicTripStaticStopTimeFeatureCollectionFeaturesInner */ 'geometry'?: GeometryPoint; /** * * @type {PublicTripStaticStopTimeFeatureCollectionFeaturesInnerProperties} * @memberof PublicTripStaticStopTimeFeatureCollectionFeaturesInner */ 'properties'?: PublicTripStaticStopTimeFeatureCollectionFeaturesInnerProperties; /** * * @type {string} * @memberof PublicTripStaticStopTimeFeatureCollectionFeaturesInner */ 'type'?: string; } /** * * @export * @interface PublicTripStaticStopTimeFeatureCollectionFeaturesInnerProperties */ interface PublicTripStaticStopTimeFeatureCollectionFeaturesInnerProperties { /** * * @type {string} * @memberof PublicTripStaticStopTimeFeatureCollectionFeaturesInnerProperties */ 'stop_name'?: string; /** * * @type {number} * @memberof PublicTripStaticStopTimeFeatureCollectionFeaturesInnerProperties */ 'stop_sequence'?: number; /** * * @type {string} * @memberof PublicTripStaticStopTimeFeatureCollectionFeaturesInnerProperties */ 'zone_id'?: string | null; /** * * @type {boolean} * @memberof PublicTripStaticStopTimeFeatureCollectionFeaturesInnerProperties */ 'is_wheelchair_accessible'?: boolean | null; /** * * @type {number} * @memberof PublicTripStaticStopTimeFeatureCollectionFeaturesInnerProperties */ 'shape_dist_traveled'?: number; /** * Time for arrival to the stop according to trip schedule. * @type {string} * @memberof PublicTripStaticStopTimeFeatureCollectionFeaturesInnerProperties */ 'arrival_time'?: string; /** * Time for departure from the stop according to trip schedule. * @type {string} * @memberof PublicTripStaticStopTimeFeatureCollectionFeaturesInnerProperties */ 'departure_time'?: string; } /** * List of stop and arrival, departure times for the trip. * @export * @interface PublicTripStopTimeFeatureCollection */ interface PublicTripStopTimeFeatureCollection { /** * * @type {Array<PublicTripStopTimeFeatureCollectionFeaturesInner>} * @memberof PublicTripStopTimeFeatureCollection */ 'features'?: Array<PublicTripStopTimeFeatureCollectionFeaturesInner>; /** * * @type {string} * @memberof PublicTripStopTimeFeatureCollection */ 'type'?: string; } /** * * @export * @interface PublicTripStopTimeFeatureCollectionFeaturesInner */ interface PublicTripStopTimeFeatureCollectionFeaturesInner { /** * * @type {GeometryPoint} * @memberof PublicTripStopTimeFeatureCollectionFeaturesInner */ 'geometry'?: GeometryPoint; /** * * @type {PublicTripStopTimeFeatureCollectionFeaturesInnerProperties} * @memberof PublicTripStopTimeFeatureCollectionFeaturesInner */ 'properties'?: PublicTripStopTimeFeatureCollectionFeaturesInnerProperties; /** * * @type {string} * @memberof PublicTripStopTimeFeatureCollectionFeaturesInner */ 'type'?: string; } /** * * @export * @interface PublicTripStopTimeFeatureCollectionFeaturesInnerProperties */ interface PublicTripStopTimeFeatureCollectionFeaturesInnerProperties { /** * * @type {string} * @memberof PublicTripStopTimeFeatureCollectionFeaturesInnerProperties */ 'stop_name'?: string; /** * * @type {number} * @memberof PublicTripStopTimeFeatureCollectionFeaturesInnerProperties */ 'stop_sequence'?: number; /** * * @type {string} * @memberof PublicTripStopTimeFeatureCollectionFeaturesInnerProperties */ 'zone_id'?: string | null; /** * * @type {boolean} * @memberof PublicTripStopTimeFeatureCollectionFeaturesInnerProperties */ 'is_wheelchair_accessible'?: boolean | null; /** * * @type {number} * @memberof PublicTripStopTimeFeatureCollectionFeaturesInnerProperties */ 'shape_dist_traveled'?: number; /** * Time for arrival to the stop according to trip schedule. * @type {string} * @memberof PublicTripStopTimeFeatureCollectionFeaturesInnerProperties */ 'arrival_time'?: string; /** * Time for departure from the stop according to trip schedule. * @type {string} * @memberof PublicTripStopTimeFeatureCollectionFeaturesInnerProperties */ 'departure_time'?: string; /** * Time for arrival to the stop according to realtime data or prediction based on current delay. * @type {string} * @memberof PublicTripStopTimeFeatureCollectionFeaturesInnerProperties */ 'realtime_arrival_time'?: string | null; /** * Time for departure from the stop according to realtime data or prediction based on current delay. * @type {string} * @memberof PublicTripStopTimeFeatureCollectionFeaturesInnerProperties */ 'realtime_departure_time'?: string | null; } /** * 0 - tram \\ 1 - metro \\ 2 - rail \\ 3 - bus \\ 4 - ferry \\ 7 - funicular \\ 11 - trolleybus * @export * @enum {number} */ const RouteType: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; readonly NUMBER_2: 2; readonly NUMBER_3: 3; readonly NUMBER_4: 4; readonly NUMBER_7: 7; readonly NUMBER_11: 11; }; type RouteType = typeof RouteType[keyof typeof RouteType]; /** * * @export * @interface ScopeInfo */ interface ScopeInfo { /** * * @type {string} * @memberof ScopeInfo */ 'gtfs_trip_id'?: string; /** * * @type {string} * @memberof ScopeInfo */ 'route_type'?: ScopeInfoRouteTypeEnum; /** * * @type {string} * @memberof ScopeInfo */ 'route_short_name'?: string; /** * * @type {string} * @memberof ScopeInfo */ 'shape_id'?: string | null; /** * * @type {string} * @memberof ScopeInfo */ 'origin_route_name'?: string | null; /** * * @type {number} * @memberof ScopeInfo */ 'run_number'?: number | null; /** * * @type {string} * @memberof ScopeInfo */ 'trip_headsign'?: string | null; /** * * @type {GeometryPoint} * @memberof ScopeInfo */ 'geometry'?: GeometryPoint; /** * Distance travelled from the first stop of the trip. * @type {number} * @memberof ScopeInfo */ 'shape_dist_traveled'?: number | null; /** * Bearing of the veh