bookalimo 1.0.1__py3-none-any.whl → 1.0.2__py3-none-any.whl

bookalimo/schemas/requests.py

@@ -0,0 +1,214 @@
+"""
+Request models for Book-A-Limo API operations.
+These models serialize to camelCase by default for API compatibility.
+"""
+
+from typing import Optional
+
+from pydantic import Field, model_validator
+from typing_extensions import Self
+
+from .base import RequestModel
+from .shared import (
+    AccountBase,
+    AddressBase,
+    AirportBase,
+    BreakdownItemBase,
+    CityBase,
+    CreditCardBase,
+    LocationBase,
+    MeetGreetAdditionalBase,
+    MeetGreetBase,
+    PassengerBase,
+    PriceBase,
+    RateType,
+    ReservationBase,
+    RewardBase,
+    StopBase,
+)
+
+
+# Request versions of shared models (serialize to camelCase)
+class City(CityBase, RequestModel):
+    """City information for requests."""
+
+    pass
+
+
+class Address(AddressBase, RequestModel):
+    """Address information for requests."""
+
+    city: Optional[City] = Field(
+        default=None, description="Use only if google_geocode not available"
+    )
+
+
+class Airport(AirportBase, RequestModel):
+    """Airport information for requests."""
+
+    arriving_from_city: Optional[City] = None
+
+
+class Location(LocationBase, RequestModel):
+    """Location (address or airport) for requests."""
+
+    address: Optional[Address] = None
+    airport: Optional[Airport] = None
+
+
+class Stop(StopBase, RequestModel):
+    """Stop information for requests."""
+
+    pass
+
+
+class Account(AccountBase, RequestModel):
+    """Travel agency or corporate account info for requests."""
+
+    pass
+
+
+class Passenger(PassengerBase, RequestModel):
+    """Passenger information for requests."""
+
+    pass
+
+
+class Reward(RewardBase, RequestModel):
+    """Reward account information for requests."""
+
+    pass
+
+
+class CreditCard(CreditCardBase, RequestModel):
+    """Credit card information for requests."""
+
+    pass
+
+
+class BreakdownItem(BreakdownItemBase, RequestModel):
+    """Price breakdown item for requests."""
+
+    pass
+
+
+class MeetGreetAdditional(MeetGreetAdditionalBase, RequestModel):
+    """Additional meet & greet charges for requests."""
+
+    pass
+
+
+class MeetGreet(MeetGreetBase, RequestModel):
+    """Meet & greet option for requests."""
+
+    pass
+
+
+class Price(PriceBase, RequestModel):
+    """Car class pricing information for requests."""
+
+    pass
+
+
+class Reservation(ReservationBase, RequestModel):
+    """Basic reservation information for requests."""
+
+    pass
+
+
+class EditReservationRequest(RequestModel):
+    """Editable reservation for modifications (requests)."""
+
+    confirmation: str
+    is_cancel_request: bool = False
+    rate_type: Optional[RateType] = None
+    pickup_date: Optional[str] = Field(default=None, description="MM/dd/yyyy format")
+    pickup_time: Optional[str] = Field(default=None, description="hh:mm tt format")
+    stops: Optional[list[Stop]] = None
+    credit_card: Optional[CreditCard] = None
+    passengers: Optional[int] = None
+    luggage: Optional[int] = None
+    pets: Optional[int] = None
+    car_seats: Optional[int] = None
+    boosters: Optional[int] = None
+    infants: Optional[int] = None
+    other: Optional[str] = Field(default=None, description="Other changes not listed")
+
+
+# Pure Request Models
+class PriceRequest(RequestModel):
+    """Request for getting prices."""
+
+    rate_type: RateType
+    date_time: str = Field(..., description="MM/dd/yyyy hh:mm tt format")
+    pickup: Location
+    dropoff: Location
+    hours: Optional[int] = Field(default=None, description="For hourly rate_type only")
+    passengers: int
+    luggage: int
+    stops: Optional[list[Stop]] = None
+    account: Optional[Account] = Field(
+        default=None, description="TAs must provide for commission"
+    )
+    passenger: Optional[Passenger] = None
+    rewards: Optional[list[Reward]] = None
+    car_class_code: Optional[str] = Field(
+        default=None, description="e.g., 'SD' for specific car class"
+    )
+    pets: Optional[int] = None
+    car_seats: Optional[int] = None
+    boosters: Optional[int] = None
+    infants: Optional[int] = None
+    customer_comment: Optional[str] = None
+
+
+class DetailsRequest(RequestModel):
+    """Request for setting reservation details."""
+
+    token: str
+    car_class_code: Optional[str] = None
+    pickup: Optional[Location] = None
+    dropoff: Optional[Location] = None
+    stops: Optional[list[Stop]] = None
+    account: Optional[Account] = None
+    passenger: Optional[Passenger] = None
+    rewards: Optional[list[Reward]] = None
+    pets: Optional[int] = None
+    car_seats: Optional[int] = None
+    boosters: Optional[int] = None
+    infants: Optional[int] = None
+    customer_comment: Optional[str] = None
+    ta_fee: Optional[float] = Field(
+        default=None, description="For Travel Agencies - additional fee in USD"
+    )
+
+
+class BookRequest(RequestModel):
+    """Request for booking reservation."""
+
+    token: str
+    promo: Optional[str] = None
+    method: Optional[str] = Field(
+        default=None, description="'charge' for charge accounts"
+    )
+    credit_card: Optional[CreditCard] = None
+
+    @model_validator(mode="after")
+    def validate_book_request(self) -> Self:
+        """Validate that either method or credit_card is provided."""
+        if not self.method and not self.credit_card:
+            raise ValueError("Either method='charge' or credit_card must be provided")
+
+        return self
+
+
+class ListReservationsRequest(RequestModel):
+    """Request for listing reservations."""
+
+    is_archive: bool = False
+
+
+class GetReservationRequest(RequestModel):
+    """Request for getting reservation details."""
+
+    confirmation: str

bookalimo/schemas/responses.py

@@ -0,0 +1,196 @@
+"""
+Response models for Book-A-Limo API operations.
+These models serialize to snake_case by default for better Python DX.
+"""
+
+from typing import Optional
+
+from pydantic import Field
+
+from .base import ResponseModel
+from .shared import (
+    AccountBase,
+    AddressBase,
+    AirportBase,
+    BreakdownItemBase,
+    CityBase,
+    CreditCardBase,
+    LocationBase,
+    LocationType,
+    MeetGreetAdditionalBase,
+    MeetGreetBase,
+    PassengerBase,
+    PriceBase,
+    RateType,
+    ReservationBase,
+    ReservationStatus,
+    RewardBase,
+    StopBase,
+)
+
+
+# Response versions of shared models (serialize to snake_case)
+class City(CityBase, ResponseModel):
+    """City information for responses."""
+
+    pass
+
+
+class Address(AddressBase, ResponseModel):
+    """Address information for responses."""
+
+    city: Optional[City] = Field(
+        default=None, description="Use only if google_geocode not available"
+    )
+
+
+class Airport(AirportBase, ResponseModel):
+    """Airport information for responses."""
+
+    arriving_from_city: Optional[City] = None
+
+
+class Location(LocationBase, ResponseModel):
+    """Location (address or airport) for responses."""
+
+    address: Optional[Address] = None
+    airport: Optional[Airport] = None
+
+
+class Stop(StopBase, ResponseModel):
+    """Stop information for responses."""
+
+    pass
+
+
+class Account(AccountBase, ResponseModel):
+    """Travel agency or corporate account info for responses."""
+
+    pass
+
+
+class Passenger(PassengerBase, ResponseModel):
+    """Passenger information for responses."""
+
+    pass
+
+
+class Reward(RewardBase, ResponseModel):
+    """Reward account information for responses."""
+
+    pass
+
+
+class CreditCard(CreditCardBase, ResponseModel):
+    """Credit card information for responses."""
+
+    pass
+
+
+class BreakdownItem(BreakdownItemBase, ResponseModel):
+    """Price breakdown item for responses."""
+
+    pass
+
+
+class MeetGreetAdditional(MeetGreetAdditionalBase, ResponseModel):
+    """Additional meet & greet charges for responses."""
+
+    pass
+
+
+class MeetGreet(MeetGreetBase, ResponseModel):
+    """Meet & greet option for responses."""
+
+    pass
+
+
+class CarClassPrice(PriceBase, ResponseModel):
+    """Car class pricing information for responses."""
+
+    pass
+
+
+class Reservation(ReservationBase, ResponseModel):
+    """Basic reservation information for responses."""
+
+    pass
+
+
+# Pure Response Models
+class ReservationData(ResponseModel):
+    """Editable reservation data returned in get reservation response."""
+
+    confirmation: str
+    is_cancel_request: bool = False
+    rate_type: Optional[RateType] = None
+    pickup_date: Optional[str] = Field(default=None, description="MM/dd/yyyy format")
+    pickup_time: Optional[str] = Field(default=None, description="hh:mm tt format")
+    stops: Optional[list[Stop]] = None
+    credit_card: Optional[CreditCard] = Field(
+        default=None,
+        description="Conditionally required - unclear from API docs when exactly",
+    )
+    passengers: Optional[int] = None
+    luggage: Optional[int] = None
+    pets: Optional[int] = None
+    car_seats: Optional[int] = None
+    boosters: Optional[int] = None
+    infants: Optional[int] = None
+    other: Optional[str] = Field(default=None, description="Other changes not listed")
+
+
+class PriceResponse(ResponseModel):
+    """Response from get prices."""
+
+    token: str
+    prices: list[CarClassPrice]
+
+
+class DetailsResponse(ResponseModel):
+    """Response from set details."""
+
+    price: float
+    breakdown: list[BreakdownItem]
+
+
+class BookResponse(ResponseModel):
+    """Response from book reservation."""
+
+    reservation_id: str
+
+
+class ListReservationsResponse(ResponseModel):
+    """Response from list reservations."""
+
+    success: bool
+    reservations: list[Reservation] = Field(default_factory=list)
+    error: Optional[str] = None
+
+
+class GetReservationResponse(ResponseModel):
+    """Response from get reservation."""
+
+    reservation: "ReservationData"
+    is_editable: bool
+    status: Optional[ReservationStatus] = None
+    is_cancellation_pending: bool
+    car_description: Optional[str] = None
+    cancellation_policy: Optional[str] = None
+    pickup_type: LocationType
+    pickup_description: str
+    dropoff_type: LocationType
+    dropoff_description: str
+    additional_services: Optional[str] = None
+    payment_method: Optional[str] = None
+    breakdown: list[BreakdownItem] = Field(default_factory=list)
+    passenger_name: Optional[str] = None
+    evoucher_url: Optional[str] = None
+    receipt_url: Optional[str] = None
+    pending_changes: list[list[str]] = Field(default_factory=list)
+
+
+class EditReservationResponse(ResponseModel):
+    """Response from edit reservation."""
+
+    success: bool