gogol-qpxexpress-0.0.1: Google QPX Express SDK.

Copyright(c) 2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.QPXExpress

Contents

Description

Lets you find the least expensive flights between an origin and a destination.

See: QPX Express API Reference

Synopsis

Service Configuration

qPXExpressService :: Service Source

Default request referring to version v1 of the QPX Express API. This contains the host and root path used as a starting point for constructing service requests.

API Declaration

type QPXExpressAPI = TripsSearchResource Source

Represents the entirety of the methods and resources available for the QPX Express API service.

Resources

qpxExpress.trips.search

module Network.Google.Resource.QPXExpress.Trips.Search

Types

TripOptionsResponse

data TripOptionsResponse Source

A QPX Express search response.

See: tripOptionsResponse smart constructor.

Instances

tripOptionsResponse :: TripOptionsResponse Source

Creates a value of TripOptionsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

torRequestId :: Lens' TripOptionsResponse (Maybe Text) Source

An identifier uniquely identifying this response.

torKind :: Lens' TripOptionsResponse Text Source

Identifies this as a QPX Express trip response object, which consists of zero or more solutions. Value: the fixed string qpxexpress#tripOptions.

torData :: Lens' TripOptionsResponse (Maybe Data') Source

Informational data global to list of solutions.

torTripOption :: Lens' TripOptionsResponse [TripOption] Source

A list of priced itinerary solutions to the QPX Express query.

CarrierData

data CarrierData Source

Information about a carrier (ie. an airline, bus line, railroad, etc) that might be useful to display to an end-user.

See: carrierData smart constructor.

Instances

carrierData :: CarrierData Source

Creates a value of CarrierData with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cdKind :: Lens' CarrierData Text Source

Identifies this as a kind of carrier (ie. an airline, bus line, railroad, etc). Value: the fixed string qpxexpress#carrierData.

cdName :: Lens' CarrierData (Maybe Text) Source

The long, full name of a carrier. For example: American Airlines.

cdCode :: Lens' CarrierData (Maybe Text) Source

The IATA designator of a carrier (airline, etc). For example, for American Airlines, the code is AA.

FreeBaggageAllowance

data FreeBaggageAllowance Source

Information about free baggage allowed on one segment of a trip.

See: freeBaggageAllowance smart constructor.

Instances

freeBaggageAllowance :: FreeBaggageAllowance Source

Creates a value of FreeBaggageAllowance with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

fbaKind :: Lens' FreeBaggageAllowance Text Source

Identifies this as free baggage object, allowed on one segment of a trip. Value: the fixed string qpxexpress#freeBaggageAllowance.

fbaPounds :: Lens' FreeBaggageAllowance (Maybe Int32) Source

The number of pounds of free baggage allowed.

fbaBagDescriptor :: Lens' FreeBaggageAllowance [BagDescriptor] Source

A representation of a type of bag, such as an ATPCo subcode, Commercial Name, or other description.

fbaKilosPerPiece :: Lens' FreeBaggageAllowance (Maybe Int32) Source

The maximum number of kilos any one piece of baggage may weigh.

fbaKilos :: Lens' FreeBaggageAllowance (Maybe Int32) Source

The maximum number of kilos all the free baggage together may weigh.

fbaPieces :: Lens' FreeBaggageAllowance (Maybe Int32) Source

The number of free pieces of baggage allowed.

TimeOfDayRange

data TimeOfDayRange Source

Two times in a single day defining a time range.

See: timeOfDayRange smart constructor.

Instances

timeOfDayRange :: TimeOfDayRange Source

Creates a value of TimeOfDayRange with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

todrKind :: Lens' TimeOfDayRange Text Source

Identifies this as a time of day range object, representing two times in a single day defining a time range. Value: the fixed string qpxexpress#timeOfDayRange.

todrLatestTime :: Lens' TimeOfDayRange (Maybe Text) Source

The latest time of day in HH:MM format.

todrEarliestTime :: Lens' TimeOfDayRange (Maybe Text) Source

The earliest time of day in HH:MM format.

Data'

data Data' Source

Detailed information about components found in the solutions of this response, including a trip's airport, city, taxes, airline, and aircraft.

See: data' smart constructor.

Instances

Eq Data' Source 
Data Data' Source 
Show Data' Source 
Generic Data' Source 
ToJSON Data' Source 
FromJSON Data' Source 
type Rep Data' Source 

data' :: Data' Source

Creates a value of Data with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dCarrier :: Lens' Data' [CarrierData] Source

The airline carrier of the aircraft flying between an origin and destination. Allowed values are IATA carrier codes.

dKind :: Lens' Data' Text Source

Identifies this as QPX Express response resource, including a trip's airport, city, taxes, airline, and aircraft. Value: the fixed string qpxexpress#data.

dAircraft :: Lens' Data' [AircraftData] Source

The aircraft that is flying between an origin and destination.

dAirport :: Lens' Data' [AirportData] Source

The airport of an origin or destination.

dCity :: Lens' Data' [CityData] Source

The city that is either the origin or destination of part of a trip.

dTax :: Lens' Data' [TaxData] Source

The taxes due for flying between an origin and a destination.

AircraftData

data AircraftData Source

The make, model, and type of an aircraft.

See: aircraftData smart constructor.

Instances

aircraftData :: AircraftData Source

Creates a value of AircraftData with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

adKind :: Lens' AircraftData Text Source

Identifies this as an aircraftData object. Value: the fixed string qpxexpress#aircraftData

adName :: Lens' AircraftData (Maybe Text) Source

The name of an aircraft, for example Boeing 777.

adCode :: Lens' AircraftData (Maybe Text) Source

The aircraft code. For example, for a Boeing 777 the code would be 777.

LegInfo

data LegInfo Source

Information about a leg. (A leg is the smallest unit of travel, in the case of a flight a takeoff immediately followed by a landing at two set points on a particular carrier with a particular flight number.)

See: legInfo smart constructor.

Instances

legInfo :: LegInfo Source

Creates a value of LegInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

liDestination :: Lens' LegInfo (Maybe Text) Source

The leg destination as a city and airport.

liOrigin :: Lens' LegInfo (Maybe Text) Source

The leg origin as a city and airport.

liSecure :: Lens' LegInfo (Maybe Bool) Source

Whether passenger information must be furnished to the United States Transportation Security Administration (TSA) prior to departure.

liKind :: Lens' LegInfo Text Source

Identifies this as a leg object. A leg is the smallest unit of travel, in the case of a flight a takeoff immediately followed by a landing at two set points on a particular carrier with a particular flight number. Value: the fixed string qpxexpress#legInfo.

liAircraft :: Lens' LegInfo (Maybe Text) Source

The aircraft (or bus, ferry, railcar, etc) travelling between the two points of this leg.

liArrivalTime :: Lens' LegInfo (Maybe Text) Source

The scheduled time of arrival at the destination of the leg, local to the point of arrival.

liOnTimePerformance :: Lens' LegInfo (Maybe Int32) Source

In percent, the published on time performance on this leg.

liOperatingDisclosure :: Lens' LegInfo (Maybe Text) Source

Department of Transportation disclosure information on the actual operator of a flight in a code share. (A code share refers to a marketing agreement between two carriers, where one carrier will list in its schedules (and take bookings for) flights that are actually operated by another carrier.)

liMeal :: Lens' LegInfo (Maybe Text) Source

A simple, general description of the meal(s) served on the flight, for example: "Hot meal".

liId :: Lens' LegInfo (Maybe Text) Source

An identifier that uniquely identifies this leg in the solution.

liOriginTerminal :: Lens' LegInfo (Maybe Text) Source

The terminal the flight is scheduled to depart from.

liChangePlane :: Lens' LegInfo (Maybe Bool) Source

Whether you have to change planes following this leg. Only applies to the next leg.

liDestinationTerminal :: Lens' LegInfo (Maybe Text) Source

The terminal the flight is scheduled to arrive at.

liConnectionDuration :: Lens' LegInfo (Maybe Int32) Source

Duration of a connection following this leg, in minutes.

liDuration :: Lens' LegInfo (Maybe Int32) Source

The scheduled travelling time from the origin to the destination.

liMileage :: Lens' LegInfo (Maybe Int32) Source

The number of miles in this leg.

liDePartureTime :: Lens' LegInfo (Maybe Text) Source

The scheduled departure time of the leg, local to the point of departure.

AirportData

data AirportData Source

An airport.

See: airportData smart constructor.

Instances

airportData :: AirportData Source

Creates a value of AirportData with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

aKind :: Lens' AirportData Text Source

Identifies this as an airport object. Value: the fixed string qpxexpress#airportData.

aName :: Lens' AirportData (Maybe Text) Source

The name of an airport. For example, for airport BOS the name is "Boston Logan International".

aCity :: Lens' AirportData (Maybe Text) Source

The city code an airport is located in. For example, for JFK airport, this is NYC.

aCode :: Lens' AirportData (Maybe Text) Source

An airport's code. For example, for Boston Logan airport, this is BOS.

SegmentPricing

data SegmentPricing Source

The price of this segment.

See: segmentPricing smart constructor.

Instances

segmentPricing :: SegmentPricing Source

Creates a value of SegmentPricing with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

spFreeBaggageOption :: Lens' SegmentPricing [FreeBaggageAllowance] Source

Details of the free baggage allowance on this segment.

spKind :: Lens' SegmentPricing Text Source

Identifies this as a segment pricing object, representing the price of this segment. Value: the fixed string qpxexpress#segmentPricing.

spFareId :: Lens' SegmentPricing (Maybe Text) Source

A segment identifier unique within a single solution. It is used to refer to different parts of the same solution.

spSegmentId :: Lens' SegmentPricing (Maybe Text) Source

Unique identifier in the response of this segment.

SliceInfo

data SliceInfo Source

Information about a slice. A slice represents a traveller's intent, the portion of a low-fare search corresponding to a traveler's request to get between two points. One-way journeys are generally expressed using 1 slice, round-trips using 2. For example, if a traveler specifies the following trip in a user interface: | Origin | Destination | Departure Date | | BOS | LAX | March 10, 2007 | | LAX | SYD | March 17, 2007 | | SYD | BOS | March 22, 2007 | then this is a three slice trip.

See: sliceInfo smart constructor.

Instances

sliceInfo :: SliceInfo Source

Creates a value of SliceInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

siKind :: Lens' SliceInfo Text Source

Identifies this as a slice object. A slice represents a traveller's intent, the portion of a low-fare search corresponding to a traveler's request to get between two points. One-way journeys are generally expressed using 1 slice, round-trips using 2. Value: the fixed string qpxexpress#sliceInfo.

siSegment :: Lens' SliceInfo [SegmentInfo] Source

The segment(s) constituting the slice.

siDuration :: Lens' SliceInfo (Maybe Int32) Source

The duration of the slice in minutes.

TripsSearchResponse

data TripsSearchResponse Source

A QPX Express search response.

See: tripsSearchResponse smart constructor.

Instances

tripsSearchResponse :: TripsSearchResponse Source

Creates a value of TripsSearchResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tsrTrips :: Lens' TripsSearchResponse (Maybe TripOptionsResponse) Source

All possible solutions to the QPX Express search request.

tsrKind :: Lens' TripsSearchResponse Text Source

Identifies this as a QPX Express API search response resource. Value: the fixed string qpxExpress#tripsSearch.

TripOption

data TripOption Source

Trip information.

See: tripOption smart constructor.

Instances

tripOption :: TripOption Source

Creates a value of TripOption with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

toPricing :: Lens' TripOption [PricingInfo] Source

Per passenger pricing information.

toKind :: Lens' TripOption Text Source

Identifies this as a trip information object. Value: the fixed string qpxexpress#tripOption.

toId :: Lens' TripOption (Maybe Text) Source

Identifier uniquely identifying this trip in a response.

toSlice :: Lens' TripOption [SliceInfo] Source

The slices that make up this trip's itinerary.

toSaleTotal :: Lens' TripOption (Maybe Text) Source

The total price for all passengers on the trip, in the form of a currency followed by an amount, e.g. USD253.35.

BagDescriptor

data BagDescriptor Source

Information about an item of baggage.

See: bagDescriptor smart constructor.

Instances

bagDescriptor :: BagDescriptor Source

Creates a value of BagDescriptor with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

bdKind :: Lens' BagDescriptor Text Source

Identifies this as a baggage object. Value: the fixed string qpxexpress#bagDescriptor.

bdCommercialName :: Lens' BagDescriptor (Maybe Text) Source

Provides the commercial name for an optional service.

bdCount :: Lens' BagDescriptor (Maybe Int32) Source

How many of this type of bag will be checked on this flight.

bdDescription :: Lens' BagDescriptor [Text] Source

A description of the baggage.

bdSubcode :: Lens' BagDescriptor (Maybe Text) Source

The standard IATA subcode used to identify this optional service.

CityData

data CityData Source

Information about a city that might be useful to an end-user; typically the city of an airport.

See: cityData smart constructor.

Instances

cityData :: CityData Source

Creates a value of CityData with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cCountry :: Lens' CityData (Maybe Text) Source

The two-character country code of the country the city is located in. For example, US for the United States of America.

cKind :: Lens' CityData Text Source

Identifies this as a city, typically with one or more airports. Value: the fixed string qpxexpress#cityData.

cName :: Lens' CityData (Maybe Text) Source

The full name of a city. An example would be: New York.

cCode :: Lens' CityData (Maybe Text) Source

The IATA character ID of a city. For example, for Boston this is BOS.

PassengerCounts

data PassengerCounts Source

The number and type of passengers. Unfortunately the definition of an infant, child, adult, and senior citizen varies across carriers and reservation systems.

See: passengerCounts smart constructor.

Instances

passengerCounts :: PassengerCounts Source

Creates a value of PassengerCounts with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pcSeniorCount :: Lens' PassengerCounts (Maybe Int32) Source

The number of passengers that are senior citizens.

pcKind :: Lens' PassengerCounts Text Source

Identifies this as a passenger count object, representing the number of passengers. Value: the fixed string qpxexpress#passengerCounts.

pcInfantInLapCount :: Lens' PassengerCounts (Maybe Int32) Source

The number of passengers that are infants travelling in the lap of an adult.

pcChildCount :: Lens' PassengerCounts (Maybe Int32) Source

The number of passengers that are children.

pcInfantInSeatCount :: Lens' PassengerCounts (Maybe Int32) Source

The number of passengers that are infants each assigned a seat.

pcAdultCount :: Lens' PassengerCounts (Maybe Int32) Source

The number of passengers that are adults.

SegmentInfo

data SegmentInfo Source

Details of a segment of a flight; a segment is one or more consecutive legs on the same flight. For example a hypothetical flight ZZ001, from DFW to OGG, would have one segment with two legs: DFW to HNL (leg 1), HNL to OGG (leg 2), and DFW to OGG (legs 1 and 2).

See: segmentInfo smart constructor.

Instances

segmentInfo :: SegmentInfo Source

Creates a value of SegmentInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sBookingCode :: Lens' SegmentInfo (Maybe Text) Source

The booking code or class for this segment.

sCabin :: Lens' SegmentInfo (Maybe Text) Source

The cabin booked for this segment.

sBookingCodeCount :: Lens' SegmentInfo (Maybe Int32) Source

The number of seats available in this booking code on this segment.

sSubjectToGovernmentApproval :: Lens' SegmentInfo (Maybe Bool) Source

Whether the operation of this segment remains subject to government approval.

sKind :: Lens' SegmentInfo Text Source

Identifies this as a segment object. A segment is one or more consecutive legs on the same flight. For example a hypothetical flight ZZ001, from DFW to OGG, could have one segment with two legs: DFW to HNL (leg 1), HNL to OGG (leg 2). Value: the fixed string qpxexpress#segmentInfo.

sFlight :: Lens' SegmentInfo (Maybe FlightInfo) Source

The flight this is a segment of.

sId :: Lens' SegmentInfo (Maybe Text) Source

An id uniquely identifying the segment in the solution.

sMarriedSegmentGroup :: Lens' SegmentInfo (Maybe Text) Source

The solution-based index of a segment in a married segment group. Married segments can only be booked together. For example, an airline might report a certain booking code as sold out from Boston to Pittsburgh, but as available as part of two married segments Boston to Chicago connecting through Pittsburgh. For example content of this field, consider the round-trip flight ZZ1 PHX-PHL ZZ2 PHL-CLT ZZ3 CLT-PHX. This has three segments, with the two outbound ones (ZZ1 ZZ2) married. In this case, the two outbound segments belong to married segment group 0, and the return segment belongs to married segment group 1.

sConnectionDuration :: Lens' SegmentInfo (Maybe Int32) Source

In minutes, the duration of the connection following this segment.

sDuration :: Lens' SegmentInfo (Maybe Int32) Source

The duration of the flight segment in minutes.

sLeg :: Lens' SegmentInfo [LegInfo] Source

The legs composing this segment.

TaxData

data TaxData Source

Tax data.

See: taxData smart constructor.

Instances

taxData :: TaxData Source

Creates a value of TaxData with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tdKind :: Lens' TaxData Text Source

Identifies this as a tax data object, representing some tax. Value: the fixed string qpxexpress#taxData.

tdName :: Lens' TaxData (Maybe Text) Source

The name of a tax.

tdId :: Lens' TaxData (Maybe Text) Source

An identifier uniquely identifying a tax in a response.

TripsSearchRequest

data TripsSearchRequest Source

A QPX Express search request.

See: tripsSearchRequest smart constructor.

Instances

tripsSearchRequest :: TripsSearchRequest Source

Creates a value of TripsSearchRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tsrRequest :: Lens' TripsSearchRequest (Maybe TripOptionsRequest) Source

A QPX Express search request. Required values are at least one adult or senior passenger, an origin, a destination, and a date.

TaxInfo

data TaxInfo Source

Tax information.

See: taxInfo smart constructor.

Instances

taxInfo :: TaxInfo Source

Creates a value of TaxInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tiChargeType :: Lens' TaxInfo (Maybe Text) Source

Whether this is a government charge or a carrier surcharge.

tiCountry :: Lens' TaxInfo (Maybe Text) Source

For government charges, the country levying the charge.

tiKind :: Lens' TaxInfo Text Source

Identifies this as a tax information object. Value: the fixed string qpxexpress#taxInfo.

tiSalePrice :: Lens' TaxInfo (Maybe Text) Source

The price of the tax in the sales or equivalent currency.

tiCode :: Lens' TaxInfo (Maybe Text) Source

The code to enter in the ticket's tax box.

tiId :: Lens' TaxInfo (Maybe Text) Source

Identifier uniquely identifying this tax in a response. Not present for unnamed carrier surcharges.

PricingInfo

data PricingInfo Source

The price of one or more travel segments. The currency used to purchase tickets is usually determined by the sale/ticketing city or the sale/ticketing country, unless none are specified, in which case it defaults to that of the journey origin country.

See: pricingInfo smart constructor.

Instances

pricingInfo :: PricingInfo Source

Creates a value of PricingInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

piSaleTaxTotal :: Lens' PricingInfo (Maybe Text) Source

The taxes in the sale or equivalent currency.

piRefundable :: Lens' PricingInfo (Maybe Bool) Source

Whether the fares on this pricing are refundable.

piPtc :: Lens' PricingInfo (Maybe Text) Source

The passenger type code for this pricing. An alphanumeric code used by a carrier to restrict fares to certain categories of passenger. For instance, a fare might be valid only for senior citizens.

piBaseFareTotal :: Lens' PricingInfo (Maybe Text) Source

The total fare in the base fare currency (the currency of the country of origin). This element is only present when the sales currency and the currency of the country of commencement are different.

piFare :: Lens' PricingInfo [FareInfo] Source

The fare used to price one or more segments.

piKind :: Lens' PricingInfo Text Source

Identifies this as a pricing object, representing the price of one or more travel segments. Value: the fixed string qpxexpress#pricingInfo.

piSegmentPricing :: Lens' PricingInfo [SegmentPricing] Source

The per-segment price and baggage information.

piPassengers :: Lens' PricingInfo (Maybe PassengerCounts) Source

The number of passengers to which this price applies.

piFareCalculation :: Lens' PricingInfo (Maybe Text) Source

The horizontal fare calculation. This is a field on a ticket that displays all of the relevant items that go into the calculation of the fare.

piLatestTicketingTime :: Lens' PricingInfo (Maybe Text) Source

The latest ticketing time for this pricing assuming the reservation occurs at ticketing time and there is no change in fares/rules. The time is local to the point of sale (POS).

piTax :: Lens' PricingInfo [TaxInfo] Source

The taxes used to calculate the tax total per ticket.

piSaleTotal :: Lens' PricingInfo (Maybe Text) Source

Total per-passenger price (fare and tax) in the sale or equivalent currency.

piSaleFareTotal :: Lens' PricingInfo (Maybe Text) Source

The total fare in the sale or equivalent currency.

FlightInfo

data FlightInfo Source

A flight is a sequence of legs with the same airline carrier and flight number. (A leg is the smallest unit of travel, in the case of a flight a takeoff immediately followed by a landing at two set points on a particular carrier with a particular flight number.) The naive view is that a flight is scheduled travel of an aircraft between two points, with possibly intermediate stops, but carriers will frequently list flights that require a change of aircraft between legs.

See: flightInfo smart constructor.

Instances

flightInfo :: FlightInfo Source

Creates a value of FlightInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

fiCarrier :: Lens' FlightInfo (Maybe Text) Source

fiNumber :: Lens' FlightInfo (Maybe Text) Source

The flight number.

FareInfo

data FareInfo Source

Complete information about a fare used in the solution to a low-fare search query. In the airline industry a fare is a price an airline charges for one-way travel between two points. A fare typically contains a carrier code, two city codes, a price, and a fare basis. (A fare basis is a one-to-eight character alphanumeric code used to identify a fare.)

See: fareInfo smart constructor.

Instances

fareInfo :: FareInfo Source

Creates a value of FareInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

fCarrier :: Lens' FareInfo (Maybe Text) Source

The carrier of the aircraft or other vehicle commuting between two points.

fDestination :: Lens' FareInfo (Maybe Text) Source

The city code of the city the trip ends at.

fOrigin :: Lens' FareInfo (Maybe Text) Source

The city code of the city the trip begins at.

fPrivate :: Lens' FareInfo (Maybe Bool) Source

Whether this is a private fare, for example one offered only to select customers rather than the general public.

fKind :: Lens' FareInfo Text Source

Identifies this as a fare object. Value: the fixed string qpxexpress#fareInfo.

fBasisCode :: Lens' FareInfo (Maybe Text) Source

fId :: Lens' FareInfo (Maybe Text) Source

A unique identifier of the fare.

TripOptionsRequest

data TripOptionsRequest Source

A QPX Express search request, which will yield one or more solutions.

See: tripOptionsRequest smart constructor.

Instances

tripOptionsRequest :: TripOptionsRequest Source

Creates a value of TripOptionsRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

torRefundable :: Lens' TripOptionsRequest (Maybe Bool) Source

Return only solutions with refundable fares.

torSaleCountry :: Lens' TripOptionsRequest (Maybe Text) Source

IATA country code representing the point of sale. This determines the "equivalent amount paid" currency for the ticket.

torPassengers :: Lens' TripOptionsRequest (Maybe PassengerCounts) Source

Counts for each passenger type in the request.

torSolutions :: Lens' TripOptionsRequest (Maybe Int32) Source

The number of solutions to return, maximum 500.

torSlice :: Lens' TripOptionsRequest [SliceInput] Source

The slices that make up the itinerary of this trip. A slice represents a traveler's intent, the portion of a low-fare search corresponding to a traveler's request to get between two points. One-way journeys are generally expressed using one slice, round-trips using two. An example of a one slice trip with three segments might be BOS-SYD, SYD-LAX, LAX-BOS if the traveler only stopped in SYD and LAX just long enough to change planes.

torMaxPrice :: Lens' TripOptionsRequest (Maybe Text) Source

Do not return solutions that cost more than this price. The alphabetical part of the price is in ISO 4217. The format, in regex, is [A-Z]{3}\d+(\.\d+)? Example: $102.07

SliceInput

data SliceInput Source

Criteria a desired slice must satisfy.

See: sliceInput smart constructor.

Instances

sliceInput :: SliceInput Source

Creates a value of SliceInput with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sliDestination :: Lens' SliceInput (Maybe Text) Source

Airport or city IATA designator of the destination.

sliOrigin :: Lens' SliceInput (Maybe Text) Source

Airport or city IATA designator of the origin.

sliMaxStops :: Lens' SliceInput (Maybe Int32) Source

The maximum number of stops you are willing to accept in this slice.

sliKind :: Lens' SliceInput Text Source

Identifies this as a slice input object, representing the criteria a desired slice must satisfy. Value: the fixed string qpxexpress#sliceInput.

sliProhibitedCarrier :: Lens' SliceInput [Text] Source

A list of 2-letter IATA airline designators. Exclude slices that use these carriers.

sliDate :: Lens' SliceInput (Maybe Text) Source

Departure date in YYYY-MM-DD format.

sliMaxConnectionDuration :: Lens' SliceInput (Maybe Int32) Source

The longest connection between two legs, in minutes, you are willing to accept.

sliPreferredCabin :: Lens' SliceInput (Maybe Text) Source

Prefer solutions that book in this cabin for this slice. Allowed values are COACH, PREMIUM_COACH, BUSINESS, and FIRST.

sliPermittedDePartureTime :: Lens' SliceInput (Maybe TimeOfDayRange) Source

Slices must depart in this time of day range, local to the point of departure.

sliPermittedCarrier :: Lens' SliceInput [Text] Source

A list of 2-letter IATA airline designators. Slices with only these carriers should be returned.

sliAlliance :: Lens' SliceInput (Maybe Text) Source

Slices with only the carriers in this alliance should be returned; do not use this field with permittedCarrier. Allowed values are ONEWORLD, SKYTEAM, and STAR.