Typedef

Static Public Summary
public	XMLHttpRequest: Object XMLHttpRequest is a global object with a Fake XMLHttpRequest function ( useFakeXMLHttpRequest() ) to run the SDK test cases.
public	dataObjects: Object dataObjects is a global object, which returns a new instance of each class.
public	dataObjects.data: Object
public	dataObjects.date: Object dataObjects.date returns a new instance of Date class.
public	dataObjects.dateOfBirth: Object dataObjects.dateOfBirth returns a new instance of DateOfBirth class.
public	dataObjects.flight: Object dataObjects.flight returns a new instance of Flight class.
public	dataObjects.leg: Object dataObjects.leg returns a new instance of Leg class.
public	dataObjects.passengerCounts: Object dataObjects.passengerCounts returns a new instance of PassengerCount class.
public	dataObjects.personInfo: Object dataObjects.personInfo returns a new instance of PersonInfo class.
public	dataObjects.purchaseData: Object dataObjects.purchaseData returns a new instance of PurchaseData class.
public	dataObjects.segment: Object dataObjects.segment returns a new instance of Segment class.
public	dataObjects.slice: Object dataObjects.slice returns a new instance of Slice class.
public	dataObjects.trip: Object dataObjects.trip returns a new instance of Trip class.
public	dataObjects.tripData: Object dataObjects.tripData returns a new instance of TripData class.
public	fBird: Object fBird is another global object including various calls like GET and POST calls.
public	fBird.get: fBird.get takes the auth Token and does the authentication for the user.
public	fBird.post: fBird.post returns with a request call on the pricing endpoint.

Static Public

public XMLHttpRequest: Object source

XMLHttpRequest is a global object with a Fake XMLHttpRequest function ( useFakeXMLHttpRequest() ) to run the SDK test cases.

public dataObjects: Object source

dataObjects is a global object, which returns a new instance of each class.

public dataObjects.data: Object source

public dataObjects.date: Object source

dataObjects.date returns a new instance of Date class.

Properties:

Name	Type	Attribute	Description
year	string		Year of booking
month	string		Month of booking
day	string		Date of booking

public dataObjects.dateOfBirth: Object source

dataObjects.dateOfBirth returns a new instance of DateOfBirth class.

Properties:

Name	Type	Attribute	Description
year	string		Birth year of the passenger
month	string		Birth month of the passenger
day	string		Birth date of the passenger

public dataObjects.flight: Object source

dataObjects.flight returns a new instance of Flight class.

Properties:

Name	Type	Attribute	Description
airlineCode	number		Airline code of the flight
flightNumber	number		Flight number of the flight
date	string		Departure date (format : YYYY-MM-DD)

public dataObjects.leg: Object source

dataObjects.leg returns a new instance of Leg class.

Properties:

Name	Type	Attribute	Description
aircraft	string		Aircraft is flying between an origin and destination.
arrival	string		Flight arrival date in Jodatime format
departure	string		Flight departure date in Jodatime format
origin	string		Source origin of the flight
destination	string		Flight Destination
operatingDisclosure	string		Department of Transportation disclosure information on the actual operator of a flight in a code share.
changePlane	boolean		Whether the passenger(s) have to change planes following this leg. Only applies to the next leg.
data	string		[OPTIONAL] any client specific key-value pair specific to leg

public dataObjects.passengerCounts: Object source

dataObjects.passengerCounts returns a new instance of PassengerCount class.

Properties:

Name	Type	Attribute	Description
adult	number		Count of adult passengers
child	number		Count of child passengers
infantInLap	number		Count of infant in lap passengers
infantInSeat	number		Count of infant in seat passengers
senior	number		Count of senior passengers

public dataObjects.personInfo: Object source

dataObjects.personInfo returns a new instance of PersonInfo class.

Properties:

Name	Type	Attribute	Description
gender	string		Gender of the passenger
firstName	string		First name of the passenger
lastName	string		Last name of the passenger
middleName	string		Middle name of the passenger
dateOfBirth	object		Date Of Birth of the passenger
phone	string		Phone number of the passenger
email	string		Email of the passenger
isDeciderToPay	boolean		Is he the decider to pay?
isPayer	boolean		Is he the Payer?
isPassenger	boolean		Is he the passenger himself?
isBookingPerson	boolean		Is he the booking person?

public dataObjects.purchaseData: Object source

dataObjects.purchaseData returns a new instance of PurchaseData class.

Properties:

Name	Type	Attribute	Description
priceRequestId	number		This is the pricing ID , received from the pricing API
clientNonce	string		ClientNonce can be GOLD, PREMIUM or PLATINUM
priceTier	string		PriceTier
tripData	object		This is received from the TripData Class
pciTransactionId	string		Payment Transaction ID
data	string		Data having payment related details of the purchased transaction

public dataObjects.segment: Object source

dataObjects.segment returns a new instance of Segment class.

Properties:

Name	Type	Attribute	Description
duration	number		Flight duration
flight	object		Flight object having flight details
cabin	string		Booked Cabin in the Flight
bookingCode	string		The booking code or class for this segment.
bookingCodeCount	number		The number of seats available in this booking code on this segment.
data	string		[OPTIONAL] any client specific key-value pair specific to segment
leg	object[]		Leg object comprising of the details about the hop taken by a flight.Segment can have multiple legs

public dataObjects.slice: Object source

dataObjects.slice returns a new instance of Slice class.

Properties:

Name	Type	Attribute	Description
duration	number		Flight duration (to reach from source to the destination)
segment	object[]		Segment object having flight data. Slice can have multiple segments

public dataObjects.trip: Object source

dataObjects.trip returns a new instance of Trip class.

Properties:

Name	Type	Attribute	Description
missedConnections	boolean		-
passengerCounts	object		Passenger count object having the total count of travelling passengers.
data	string		[OPTIONAL] any client specific key-value pair specific to trip.
slices	object[]		Slice object having trip info. Trip can have multiple slices.

public dataObjects.tripData: Object source

dataObjects.tripData returns a new instance of TripData class.

Properties:

Name	Type	Attribute	Description
id	string		Trip ID received from the Pricing API
personInfo	object		Person details received from PersonDetails class

public fBird: Object source

fBird is another global object including various calls like GET and POST calls.

public fBird.get: source

fBird.get takes the auth Token and does the authentication for the user.

Properties:

Name	Type	Attribute	Description
path	string		To the requested resource
params	object	optional	Object of additional parameters

public fBird.post: source

fBird.post returns with a request call on the pricing endpoint.

Properties:

Name	Type	Attribute	Description
path	string		To the requested resource
params	object	optional	Object of additional parameters