koleo-cli 0.2.137.17__py3-none-any.whl → 0.2.137.18__py3-none-any.whl

koleo/api/types.py

@@ -0,0 +1,488 @@
+import typing as t
+
+
+class BaseStationInfo(t.TypedDict):
+    id: int
+    name: str
+    name_slug: str
+
+
+StationType = t.Literal["TopographicalPlace", "Quay", "StopPlace"]
+TransportMode = t.Literal[
+    "bus",
+    "rail",
+]
+
+
+# i want to kms
+class ExtendedStationInfo(BaseStationInfo):
+    latitude: float
+    longitude: float
+    hits: int
+    ibnr: int
+    city: str | None
+    region: str
+    country: str
+    localised_name: str
+    is_group: bool
+    has_announcements: bool
+    is_nearby_station_enabled: bool
+    is_livesearch_displayable: bool
+    type: StationType
+    transport_mode: TransportMode | None
+    time_zone: str  # Europe/Warsaw
+
+
+class SearchStationInfo(BaseStationInfo):
+    ibnr: int
+    localised_name: str
+    on_demand: bool
+    type: StationType
+
+
+class StationBannerClockHandsPositon(t.TypedDict):
+    x: float
+    y: float
+
+
+class StationBannerClockHands(t.TypedDict):
+    url: str | None
+    position: StationBannerClockHandsPositon
+
+
+class StationBannerClock(t.TypedDict):
+    visible: bool | None
+    hands: StationBannerClockHands
+
+
+class StationBanner(t.TypedDict):
+    url: str
+    clock: StationBannerClock
+
+
+class Address(t.TypedDict):
+    full: str
+    zip: str
+
+
+class Feature(t.TypedDict):
+    id: str
+    name: str
+    available: bool
+
+
+class StationOpeningHours(t.TypedDict):
+    day: int  # 0-6
+    open: str  # 00:00
+    close: str  # 24:00
+
+
+class StationDetails(t.TypedDict):
+    banner: StationBanner
+    address: Address
+    lat: float
+    lon: float
+    opening_hours: list[StationOpeningHours]
+    features: list[Feature]
+
+
+class StationLocalizedToTrain(BaseStationInfo):
+    train_id: int
+
+
+class ApiBrand(t.TypedDict):
+    id: int
+    name: str  # EIC, IC, IR, REG, ...
+    display_name: str
+    logo_text: str
+    color: str  # hex
+    carrier_id: int
+
+
+class Carrier(t.TypedDict):
+    id: int
+    name: str  # Koleje Dolnośląskie, POLREGIO
+    short_name: str  # KD, PR
+    slug: str
+    legal_name: str  # PKP Szybka Kolej Miejska w Trójmieście Sp.z o.o.
+
+
+class DiscountInfo(t.TypedDict):
+    id: int
+    passenger_percentage: int
+    display_passenger_percentage: float
+    flyer_second_class_percentage: int
+    flyer_first_class_percentage: int
+    express_second_class_percentage: int
+    express_first_class_percentage: int
+    dependent_on_ids: list[int]
+    name: str
+    rank: int
+    season_passenger_percentage: int
+    displayable: bool
+    is_company: bool
+
+
+class TrainOnStationInfo(t.TypedDict):
+    arrival: str | None  # first station
+    departure: str | None  # last station
+    stations: list[StationLocalizedToTrain]
+    train_full_name: str
+    brand_id: int
+    platform: str  # could be empty; some countries dont use arabic numerals or even tracks
+    track: str  # could be empty; some countries dont use arabic numerals or even tracks
+
+
+class TrainCalendar(t.TypedDict):
+    id: int
+    train_nr: int
+    train_name: str
+    trainBrand: int
+    dates: list[str]  # Y-M-D
+    train_ids: list[int]
+    date_train_map: dict[str, int]
+
+
+class TrainCalendarResponse(t.TypedDict):
+    train_calendars: list[TrainCalendar]
+
+
+class TimeDict(t.TypedDict):
+    hour: int
+    minute: int
+    second: int
+
+
+TrainAttributeTuple = t.Tuple[int, str, str, str, bool, str]
+# id, name, start_station, end_station, no idea, style?( <- "icon-warning"?)
+
+
+class TrainDetail(t.TypedDict):
+    id: int
+    train_nr: int
+    name: str | None
+    train_full_name: str
+    run_desc: str  # "09.09-15.09 - w pt - nd; 16.09-29.09, 14.10-03.11 - codziennie;"
+    carrier_id: int
+    brand_id: int
+    train_name: int  # wtf
+    duration_offset: int  # wtf?
+    db_train_nr: int  # lol
+    train_attributes: list[TrainAttributeTuple]
+
+
+class TrainStop(t.TypedDict):
+    id: int
+    station_id: int
+    station_name: str
+    station_slug: str
+    train_id: int
+    arrival: TimeDict
+    departure: TimeDict
+    position: int  # the stop nr
+    train_nr: int | None
+    brand_id: int
+    distance: int  # meters
+    entry_only: bool
+    exit_only: bool
+    station_display_name: str
+    platform: str
+    vehicle_type: str | None  # ED161
+
+
+class TrainDetailResponse(t.TypedDict):
+    train: TrainDetail
+    stops: list[TrainStop]
+
+
+class ConnectionTrainStop(t.TypedDict):
+    arrival: TimeDict | str  # WTF KOLEO!!!!
+    departure: TimeDict | str  # WTF KOLEO!!!!
+    distance: int
+    in_path: bool
+    station_id: int
+    next_day: bool
+    position: int
+    train_nr: int
+    brand_id: int
+    entry_only: bool
+    exit_only: bool
+    platform: str
+    track: str
+    on_demand: bool
+
+
+class ConnectionTrainDetail(TrainDetail):
+    arrival: TimeDict | str  # WTF KOLEO!!!!
+    departure: TimeDict | str  # WTF KOLEO!!!!
+    stops: list[ConnectionTrainStop]
+    bookable: bool
+    train_attribute_ids: list[int]
+    travel_time: int
+    direction: str
+    start_station_id: int
+    end_station_id: int
+    fixed_carriage_composition: bool
+    is_option_groups_available: bool
+    train_id: int  # wtf!!!!!!!!!!!
+
+
+class ErrorDict(t.TypedDict):
+    type: str
+    value: str
+
+
+class ConnectionDetail(t.TypedDict):
+    id: int
+    distance: int
+    purchasable: bool
+    purchasable_errors: list[ErrorDict]
+    travel_time: int
+    changes: int
+    needs_document: bool
+    brand_ids: list[int]
+    start_station_id: int
+    end_station_id: int
+    arrival: TimeDict | str  # WTF KOLEO!!!!
+    departure: TimeDict | str  # WTF KOLEO!!!!
+    bookable: bool
+    special_event_slug: str | None
+    is_advanced_travel_options: bool
+    is_child_birthday_required: bool
+    max_passengers_count: bool
+    constriction_info: list[str]
+    is_estimated_timetable_available: bool
+    trains: list[ConnectionTrainDetail]
+    eol_connection_uuid: str | None
+
+
+class SpecialCompartmentType(t.TypedDict):
+    id: int
+    icon: str
+    name: str
+    information: str
+    terms: str
+
+
+SeatState = t.Literal["FREE", "RESERVED", "BLOCKED"]
+
+
+class Seat(t.TypedDict):
+    carriage_nr: str  # number
+    seat_nr: str  # number
+    special_compartment_id: int
+    state: SeatState
+    placement_id: int  # 1 -> okno, 2 -> korytarz, 7 -> środek
+
+
+class SeatsAvailabilityResponse(t.TypedDict):
+    special_compartment_types: list[SpecialCompartmentType]
+    seats: list[Seat]
+
+
+class Price(t.TypedDict):
+    id: int
+    connection_id: int
+    value: str
+    tariff_ids: list[int]
+    tariff_names: list[str]
+    validity: str
+    area_extract: ...
+    document_required: bool
+    valid_hours: float
+    changes_allowed: bool
+    bike_price: str | None
+    luggage_price: str | None
+    dog_price: str | None
+    bike_available: bool
+    dog_available: bool
+    luggage_available: bool
+    two_way: bool
+    warning: str | None
+    is_bike: bool
+    main_ticket_nr_required: bool
+    allows_zero_price: bool
+    is_seat_booking: bool
+    is_booking_after_purchase_available: bool
+    is_two_way: bool
+    has_pr_tariff: bool
+    tariff_descriptions: list[str]
+    discount_percentage: int
+    uncertain_to: bool
+    dividable: bool
+    limited_bike_price: str | None
+    has_ic_tariff: bool
+    has_valid_anticommunist_passengers: bool
+    has_valid_baby_passengers: bool
+    is_luggage_plus_available: bool
+    kdr_bike_price_available: bool
+    available_return_days: list[str]
+
+
+class Placement(t.TypedDict):
+    id: int
+    name: str
+    key: str
+
+
+class CompartmentType(t.TypedDict):
+    id: int
+    rank: int | None
+    name: str
+    selected: bool
+    terms: str
+    information: str
+    placement_selection_for_each_passenger_possible: bool
+    placements: list[Placement]
+
+
+class ReservatioModePreference(t.TypedDict):
+    available: bool
+    compartment_types: list[CompartmentType]
+
+
+class ResevervationMode(t.TypedDict):
+    seat_map: bool
+    place_indication: bool
+    adjacent_place_indication: bool
+    preferences: ReservatioModePreference
+
+
+class PlaceType(t.TypedDict):
+    id: int | None
+    icon: str
+    place_types_label: str
+    name: str
+    price: float
+    base_price: float
+    unavailable_help_text: str
+    available: bool
+    selected: bool
+    uncertain: bool
+    capacity: int
+    place_types: "list[PlaceType]"
+
+
+class TrainPlaceType(t.TypedDict):
+    id: int
+    train_nr: int
+    place_type: PlaceType
+
+
+class NestedTrainPlaceTypesResponse(t.TypedDict):
+    train_place_types: list[TrainPlaceType]
+
+
+class CurrentSession(t.TypedDict):
+    id: t.Literal["current"]
+    email: str
+
+
+class TrainCompositonCarriage(t.TypedDict):
+    positon: int
+    number: str  # lol
+    carriage_type_id: int
+    bookable: bool
+    is_default: bool
+
+
+Direction = t.Literal["right", "left"]
+
+
+class SimpleTrainDirection(t.TypedDict):
+    type: t.Literal["simple"]
+    direction: Direction
+    reversingOnRoute: bool
+
+
+class TrainComposition(t.TypedDict):
+    direction: SimpleTrainDirection
+    carriages: list[TrainCompositonCarriage]
+
+
+class CarriageSeat(t.TypedDict):
+    nr: int
+    seat_type_id: int
+    x: int
+    y: int
+    color: str | None
+    compartment_type_id: (
+        int | None
+    )  # not implemented by koleo, returns 1: "wagon bezprzedziałowy" for "wagon przedziałowy"
+    placement_id: int | None
+
+
+class CarriageSeatType(t.TypedDict):
+    id: int
+    key: str
+    width: int
+    height: int
+
+
+class CarriageType(t.TypedDict):
+    id: int
+    key: str
+    image_key: str
+    seats: list[CarriageSeat]
+    seat_types: list[CarriageSeatType]
+
+
+class Passenger(t.TypedDict):
+    id: int
+    first_name: str
+    last_name: str
+    discount_id: int
+    discount_card_ids: list[int]
+    birthday: str
+    fellow: bool
+    is_selected: bool
+    avatar_url: str | None
+    active: bool
+    identity_document_type_id: int | None
+    identity_document_number: str | None
+    company_code: str | None
+    has_big_discount: bool
+
+
+class User(CurrentSession):
+    locale: Placement
+    passenger_id: int
+    consent_to_terms: bool
+    consent_to_privacy: bool
+    consent_to_trade_info: bool | None
+    constriction_notifications: bool
+    wallet_id: int
+    lka_wallet_id: int
+    money_back: bool
+    masscollect_account_number: str | None
+    affiliate_code: str | None
+    application_installed: bool
+    has_exchange_order: bool | None
+    should_use_new_travel_options: bool
+
+
+class Wallet(t.TypedDict):
+    id: int
+    balance: int  # 8.75 -> 875
+    last_transaction: str | None
+
+
+class CurrentUser(t.TypedDict):
+    passengers: list[Passenger]
+    users: list[User]
+    wallets: list[Wallet]
+    lka_wallets: list[Wallet]
+
+
+class StationKeyword(t.TypedDict):
+    id: int
+    keyword: str
+    station_id: int
+
+
+class TrainAttribute(t.TypedDict):
+    id: int
+    name: str
+    short_name: str
+    rank: int
+    warning: bool