@hasadna/open-bus-api-client/dist/apis/SiriApi.d.ts

A client library for interacting with the Open-Bus API.

/**
 * Open Bus Stride API
 * ### Follow planned and real-time bus statistics 🚌  Welcome to The Public Knowledge Workshop\'s Stride project. We provide usable and accurate data about the Israeli public transportation system.  For background on the project and some more detailed documentation and usage guides, see [STRIDE.md](https://github.com/hasadna/open-bus-pipelines/blob/main/STRIDE.md).  Looking for a specific use-case?  * Take a look at the **user cases** APIs below. * Try one of our existing [jupyter notebooks](https://github.com/hasadna/open-bus-stride-client/blob/main/README.md#using-the-interactive-jupyter-notebooks). * Don\'t see your use-case covered here? Please [open us a ticket](https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fhasadna%2Fopen-bus%2Fissues%2Fnew)!  Queries are by default limited to 100 results per query, this limit can be increased up to 500,000 results. Please try to set appropriate query parameters to limit the results to reduce load on our DB. If you do need to get large number of results (up to 500,000) it\'s recommended to use one of these methods:  1. Use HTTP streaming and JSON streaming decoder, this method is most efficient and provide accurate results.    Our [Stride Python Client iterate method](https://github.com/hasadna/open-bus-stride-client#usage) uses this method. 2. Use combination of limit / offset parameters to get results by page. This method may be less accurate because    it depends on data remaining unchanged between requests.  For more advanced usage-  * Use **gtfs** for data about the planned lines timetables.  * Use **siri** for data about lines real-time * See [Open Bus Stride Data Model](https://github.com/hasadna/open-bus-stride-db/blob/main/DATA_MODEL.md) for description of field and table names. * See [Open Bus Stride ETL Processes](https://github.com/hasadna/open-bus-pipelines/blob/main/STRIDE_ETL_PROCESSES.md) for description of the ETL processes which fetch and aggregate the data. * See [MOT Developer Information](https://www.gov.il/BlobFolder/generalpage/gtfs_general_transit_feed_specifications/he/GTFS%20-%20Developer%20Information.pdf) for description of the source fields as published by the Israel Ministry of Transportation.
 *
 * The version of the OpenAPI document: 6909b3db7b8bfa5ac3f3c4aeb3de80d2a2c75810
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import * as runtime from '../runtime';
import type { SiriRidePydanticModel, SiriRideStopPydanticModel, SiriRideStopWithRelatedPydanticModel, SiriRideWithRelatedPydanticModel, SiriRoutePydanticModel, SiriSnapshotPydanticModel, SiriStopPydanticModel, SiriVehicleLocationPydanticModel, SiriVehicleLocationWithRelatedPydanticModel } 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 declare class SiriApi extends runtime.BaseAPI {
    /**
     * Return a single siri ride stop based on id
     * Get
     */
    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.
     * List
     */
    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
     * Get
     */
    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.
     * List
     */
    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
     * Get
     */
    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.
     * List
     */
    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
     * Get
     */
    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.
     * List
     */
    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
     * Get
     */
    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.
     * List
     */
    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
     * Get
     */
    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.
     * List
     */
    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>>;
}