Traveler Class Reference


                    
                    
                    identify(_:attributes:completion:)

This method stores the identity of the traveler internally. Once this identity is set, all subsequent calls to the this facade will be tracked under this traveler’s identity.

Declaration

Swift

public static func identify(_ identifier: String?, attributes: [String : Any?]? = nil, completion: (() -> Void)? = nil)

Parameters

`identifier`	A unique string that you recieve from your own backend after it retrieves it using the partner API. Passing `nil` will clear the traveler identity from the SDK.
`attributes`	A `Dictionary<String, Any?>` of custom traveler attributes to keep for records.


                    
                    
                    fetchPointsWallet(delegate:)

Fetches the loyalty points wallet for the logged in user.

Declaration

Swift

public static func fetchPointsWallet(delegate: PointsWalletFetchDelegate)

Parameters


                                delegate

The PointsWalletFetchDelegate that is notified of the results


                    
                    
                    fetchPointsWallet(completion:)

Fetches the loyalty points wallet for the logged in user.

Declaration

Swift

public static func fetchPointsWallet(completion: @escaping (PointsWalletResult?, Error?) -> Void)

Parameters


                                completion

A completion block that is called when fetch is finished.


                    
                    
                    flightSearch(query:delegate:)

Performs a flight search for the given query.

Declaration

Swift

public static func flightSearch(query: FlightQuery, delegate: FlightSearchDelegate)

Parameters

`query`	A `FlightQuery` to search for.
`delegate`	The `FlightSearchDelegate` that is notified of the results


                    
                    
                    flightSearch(query:completion:)

Performs a flight search for the given query.

Declaration

Swift

public static func flightSearch(query: FlightQuery, completion: @escaping ([Flight]?, Error?) -> Void)

Parameters

`query`	A `FlightQuery` to search for.
`completion`	A completion block that is called when search is finished.


                    
                    
                    fetchCatalog(query:delegate:)

Fetches the Catalog for the given query.

Declaration

Swift

public static func fetchCatalog(query: CatalogQuery, delegate: CatalogFetchDelegate)

Parameters

`query`	A `CatalogQuery` to fetch for.
`delegate`	A `CatalogFetchDelegate` that is notified of the results.


                    
                    
                    fetchCatalog(query:completion:)

Fetches the Catalog for the given query.

Declaration

Swift

public static func fetchCatalog(query: CatalogQuery, completion: @escaping (Catalog?, Error?) -> Void)

Parameters

`query`	A `CatalogQuery` to fetch for.
`completion`	A completion block that is called when the results are ready.


                    
                    
                    fetchProductDetails(_:delegate:)

Fetches the CatalogItemDetails for a given Product.

Declaration

Swift

public static func fetchProductDetails(_ product: Product, delegate: CatalogItemDetailsFetchDelegate)

Parameters

`product`	A `Product` for which to fetch the details.
`delegate`	A `CatalogItemDetailsFetchDelegate` that is notified of the results.


                    
                    
                    fetchProductDetails(_:completion:)

Fetches the CatalogItemDetails for a given Product.

Declaration

Swift

public static func fetchProductDetails(_ catalogItem: Product, completion: @escaping (CatalogItemDetails?, Error?) -> Void)

Parameters

`product`	A `Product` for which to fetch the details.
`delegate`	A completion block that is called when the results are ready.


                    
                    
                    fetchPasses(product:availability:option:completion:)

Fetches the Passes associated with a given Product for a given Availability and BookingOption.

Declaration

Swift

public static func fetchPasses(product: BookingItem, availability: Availability, option: BookingOption?, completion: @escaping ([Pass]?, Error?) -> Void)

Parameters

`product`	The `Product` for which to fetch the passes for.
`availability`	The `Availability` for that Product to fetch the passes for.
`option`	An optional `BookingOption` to fetch passes for.
`completion`	A completion block that is called when the results are ready.


                    
                    
                    fetchPasses(product:availability:option:delegate:)

Fetches the Passes associated with a given Product for a given Availability and BookingOption.

Declaration

Swift

public static func fetchPasses(product: BookingItem, availability: Availability, option: BookingOption?, delegate: PassFetchDelegate)

Parameters

`product`	The `Product` for which to fetch the passes for.
`availability`	The `Availability` for that Product to fetch the passes for.
`option`	An optional `BookingOption` to fetch passes for.
`delegate`	A `PassFetchDelegate` that is notified of the results.


                    
                    
                    fetchPartnerOfferings(product:delegate:)

Fetches the PartnerOfferings associated with a given PartnerOfferingItem

Declaration

Swift

public static func fetchPartnerOfferings(product: PartnerOfferingItem, delegate: FetchPartnerOfferingsDelegate)

Parameters

`product`	The `PartnerOfferingItem` for which to fetch the passes for.
`delegate`	A `FetchOfferingsDelegate` that is notified of the results


                    
                    
                    fetchPartnerOfferings(product:completion:)

Fetches the PartnerOfferings associated with a given PartnerOfferingsItem

Declaration

Swift

public static func fetchPartnerOfferings(product: PartnerOfferingItem, completion: @escaping ([PartnerOfferingGroup]?, Error?) -> Void)

Parameters

`product`	The `PartnerOfferingItem` for which to fetch the passes for.
`completion`	A completion block that is called when results are ready


                    
                    
                    fetchAvailablePaymentOptions(order:completion:)

Fetches available PaymentOptions associated with a given Order. Every Order can have a different PaymentOptions.

Declaration

Swift

public static func fetchAvailablePaymentOptions(order: Order, completion: @escaping ([PaymentOption]?, Error?) -> Void)

Parameters

`order`	The `Order` for which to fetch the payment options for.
`completion`	A completion block that is called when results are ready.


                    
                    
                    fetchAvailablePaymentOptions(order:delegate:)

Fetches available PaymentOptions associated with a given Order. Every Order can have a different PaymentOptions.

Declaration

Swift

public static func fetchAvailablePaymentOptions(order: Order, delegate: PaymentOptionsFetchDelegate)

Parameters

`order`	The `Order` for which to fetch the payment options for.
`delegate`	A `PaymentOptionsFetchDelegate` that is notified of the results.


                    
                    
                    createOrder(purchaseForm:in:delegate:)

Creates an Order for the supplied PurchaseForm.

Declaration

Swift

public static func createOrder(purchaseForm: PurchaseForm, in currency: Currency = .USD, delegate: OrderCreateDelegate)

Parameters

`purchaseForm`	A `PurchaseForm` for which to create the `Order` for.
`delgate`	An `OrderCreateDelegate` that is notified of the results.


                    
                    
                    createOrder(purchaseForm:in:completion:)

Creates an Order for the supplied PurchaseForm.

Declaration

Swift

public static func createOrder(purchaseForm: PurchaseForm, in currency: Currency = .USD, completion: @escaping (Order?, Error?) -> Void)

Parameters

`purchaseForm`	A `PurchaseForm` for which to create the `Order` for.
`completion`	A completion block that is called when the results are ready.


                    
                    
                    processOrder(_:payment:delegate:)

Processes the Payment for given Order.

Declaration

Swift

public static func processOrder(_ order: Order, payment: Payment, delegate: OrderProcessDelegate)

Parameters

`order`	The `Order` to process.
`payment`	The `Payment` instance that holds the payment information.
`delegate`	An `OrderProcessDelegate` that is notified of the results.


                    
                    
                    processOrder(_:payment:completion:)

Processes the Payment for given Order.

Declaration

Swift

public static func processOrder(_ order: Order, payment: Payment, completion: @escaping (Receipt?, Error?) -> Void)

Parameters

`order`	The `Order` to process.
`payment`	The `Payment` instance that holds the payment information.
`completion`	A completion block that is called when the results are ready.


                    
                    
                    fetchPurchaseForm(product:options:completion:)

Fetches the PurchaseForm for a given Product and array of Passes.

Declaration

Swift

public static func fetchPurchaseForm(product: Product, options: [ProductOffering] = [], completion: @escaping (PurchaseForm?, Error?) -> Void)

Parameters

`product`	A `Product` for which to fetch the `PurchaseForm`.
`passes`	An `Array<Pass>` for which to fetch the `PurchaseForm`.
`completion`	A completion block that is called when the results are ready.


                    
                    
                    fetchPurchaseForm(product:options:delegate:)

Fetches the PurchaseForm for a given Product and array of Passes.

Declaration

Swift

public static func fetchPurchaseForm(product: Product, options: [ProductOffering] = [], delegate: PurchaseFormFetchDelegate)

Parameters

`product`	A `Product` for which to fetch the `PurchaseForm`.
`passes`	An `Array<Pass>` for which to fetch the `PurchaseForm`.
`delegate`	A `PurchaseFormFetchDelegate` that is notified of the results.


                    
                    
                    fetchAvailabilities(product:startDate:endDate:completion:)

Fetches an Array<Availability> that represents all the available dates between the given start and end date for a given Product.

Declaration

Swift

public static func fetchAvailabilities(product: Product, startDate: Date, endDate: Date, completion: @escaping ([Availability]?, Error?) -> Void)

Parameters

`product`	The `Product` for which to fetch the availabilities for.
`startDate`	The lower bound of the date range for which to fetch availabilities for.
`endDate`	The upper bound of the date range for which to fetch availabilties for.
`completion`	A completion block that is called when the results are ready.


                    
                    
                    fetchAvailabilities(product:startDate:endDate:delegate:)

Fetches an Array<Availability> that represents all the available dates between the given start and end date for a given Product.

Declaration

Swift

public static func fetchAvailabilities(product: Product, startDate: Date, endDate: Date, delegate: AvailabilitiesFetchDelegate)

Parameters

`product`	The `Product` for which to fetch the availabilities for.
`startDate`	The lower bound of the date range for which to fetch availabilities for.
`endDate`	The upper bound of the date range for which to fetch availabilties for.
`delegate`	A `AvailaibilitiesFetchDelegate` that is notified of the results.


                    
                    
                    fetchOrders(_:identifier:delegate:)

Fetches an OrderResult corresponding to the given OrderQuery.

query: The OrderQuery to filter.
identifier: An optional hash identifying the request. This value is returned back in the delegates. Use this to distinguish between different requests
delegate: An OrderFetchDelegate that is notified of the results.

Declaration

Swift

public static func fetchOrders(_ query: OrderQuery, identifier: AnyHashable?, delegate: OrderFetchDelegate)


                    
                    
                    fetchOrders(_:identifier:previousResultBlock:resultBlock:completion:)

Fetches an OrderResult corresponding to the given OrderQuery.

query: The OrderQuery to filter.
identifier: An optional hash identifying the request. This value is returned back in the callbacks. Use this to distinguish between different requests
previousResultBlock: A block called (on a worker thread) to return any previous results that are to be merged
resultBlock: A block called (on a worker thread) with the final merged results
completion: A completion block that is called when the results are ready.

Declaration

Swift

public static func fetchOrders(_ query: OrderQuery, identifier: AnyHashable?, previousResultBlock: (() -> OrderResult?)?, resultBlock: ((OrderResult, AnyHashable?) -> Void)?, completion: @escaping (OrderResult?, Error?, AnyHashable?) -> Void)


                    
                    
                    fetchCancellationQuote(order:delegate:)

Fetches a CancellationQuote for a given Order

order: The Order for which to get a quote
delegate: A CancellationQuoteFetchDelegate that is notified of the results.

Declaration

Swift

public static func fetchCancellationQuote(order: Order, delegate: CancellationQuoteFetchDelegate)


                    
                    
                    fetchCancellationQuote(order:completion:)

Fetches a CancellationQuote for a given Order

order: The Order for which to get a quote
completion: A completion block that is called when the results are ready

Declaration

Swift

public static func fetchCancellationQuote(order: Order, completion: @escaping (CancellationQuote?, Error?) -> Void)


                    
                    
                    cancelOrder(_:delegate:)

Cancels an Order, given the CancellationQuote

quote: The CancellationQuote corresponding to the Order that is to be cancelled
delegate: A CancellationDelegate that is notified of the results A CancellationError.expiredQuote will be thrown if the quote has expired.

Declaration

Swift

public static func cancelOrder(_ request: CancellationRequest, delegate: CancellationDelegate)


                    
                    
                    cancelOrder(_:completion:)

Cancels an Order, given the CancellationQuote

quote: The CancellationQuote corresponding to the Order that is to be cancelled
completion: A completion block that is called when the results are ready. A CancellationError.expiredQuote will be thrown if the quote has expired.

Declaration

Swift

public static func cancelOrder(_ request: CancellationRequest, completion: @escaping (Order?, Error?) -> Void)


                    
                    
                    emailOrderConfirmation(order:delegate:)

Emails order confirmation to email used in purchase, given the Order

order: The Order with the tickets to be sent
delegate: A EmailTicketsDelegate that is notified if the tickets were sent successfuly

Declaration

Swift

public static func emailOrderConfirmation(order: Order, delegate: EmailOrderConfirmationDelegate)


                    
                    
                    emailOrderConfirmation(order:completion:)

Emails order confirmation to email used in purchase, given the Order

order: The Order with the tickets to be sent
completion: A completion block that is called when the email is sent

Declaration

Swift

public static func emailOrderConfirmation(order: Order, completion: @escaping (Error?) -> Void)


                    
                    
                    addToWishlist(_:delegate:)

Adds the given CatalogItem into the traveler’s wishlist

item: The Product that needs to be wishlisted
delegate: A WishlistAddDelegate that is notified if the items were wishlisted successfuly

Declaration

Swift

public static func addToWishlist(_ item: Product, delegate: WishlistAddDelegate)


                    
                    
                    addToWishlist(_:completion:)

Adds the given Product into the traveler’s wishlist

item: The Product thats need to be wishlisted
completion: A completion block that is called when the items are wishlisted

Declaration

Swift

public static func addToWishlist(_ item: Product, completion: @escaping (Product, CatalogItemDetails?, Error?) -> Void)


                    
                    
                    removeFromWishlist(_:result:delegate:)

Removes the given Product from the traveler’s wishlist

item: The Product that needs to be removed from the wishlist
delegate: A WishlistRemoveDelegate that is notified if the item is removed from the wishlist successfuly

Declaration

Swift

@discardableResult
public static func removeFromWishlist(_ item: Product, result: WishlistResult?, delegate: WishlistRemoveDelegate) -> WishlistResult?


                    
                    
                    removeFromWishlist(_:result:completion:)

Removes the given Product from the traveler’s wishlist

item: The Product that needs to be removed from the wishlist
completion: A completion block that is called when the item is removed from the wishlist

Declaration

Swift

@discardableResult
public static func removeFromWishlist(_ item: Product, result: WishlistResult?, completion: @escaping (Product, CatalogItemDetails?, WishlistResult?, Error?) -> Void) -> WishlistResult?


                    
                    
                    fetchWishlist(_:identifier:delegate:)

Fetches an WishlistResult corresponding to the given WishlistQuery.

query: The WishlistQuery to filter.
identifier: An optional hash identifying the request. This value is returned back in the delegates. Use this to distinguish between different requests
delegate: An WishlistFetchDelegate that is notified of the results.

Declaration

Swift

public static func fetchWishlist(_ query: WishlistQuery, identifier: AnyHashable?, delegate: WishlistFetchDelegate)


                    
                    
                    fetchWishlist(_:identfier:previousResultBlock:resultBlock:completion:)

Fetches an WishlistResult corresponding to the given WishlistQuery.

query: The WishlistQuery to filter.
identifier: An optional hash identifying the request. This value is returned back in the callbacks. Use this to distinguish between different requests
previousResultBlock: A block called (on a worker thread) to return any previous results that are to be merged
resultBlock: A block called (on a worker thread) with the final merged results
completion: A completion block that is called when the results are ready.

Declaration

Swift

public static func fetchWishlist(_ query: WishlistQuery, identfier: AnyHashable?, previousResultBlock: (() -> WishlistResult?)?, resultBlock: ((WishlistResult, AnyHashable?) -> Void)?, completion: @escaping (WishlistResult?, Error?, AnyHashable?) -> Void)


                    
                    
                    searchBookingItems(_:identifier:delegate:)

Makes a search in the API catalog given a BookingItemSearchQuery

searchQuery: The BookingItemSearchQuery with the search parameters
delegate: A BookingItemSearchDelegate that is notified if the search is successful

Declaration

Swift

public static func searchBookingItems(_ searchQuery: BookingItemQuery, identifier: AnyHashable?, delegate: BookingItemSearchDelegate)


                    
                    
                    searchBookingItems(_:identifier:previousResultBlock:resultBlock:completion:)

Makes a search in the API catalog given a BookingItemSearchQuery

searchQuery: The BookingItemSearchQuery with the search parameters
identifier: An optional hash identifying the request. This value is returned back in the callbacks. Use this to distinguish between different requests
previousResultBlock: A block called (on a worker thread) to return any previous results that are to be merged
resultBlock: A block called (on a worker thread) with the final merged results
completion: A completion block that is called when the results are ready.

Declaration

Swift

public static func searchBookingItems(_ searchQuery: BookingItemQuery, identifier: AnyHashable?, previousResultBlock: (() -> BookingItemSearchResult?)?, resultBlock: ((BookingItemSearchResult?, AnyHashable?) -> Void)?, completion: @escaping (BookingItemSearchResult?, Error?, AnyHashable?) -> Void)


                    
                    
                    searchParkingItems(_:identifier:delegate:)

Makes a search in the API catalog given a ParkingItemSearchQuery

searchQuery: The ParkingItemSearchQuery with the search parameters
delegate: A ParkingItemSearchDelegate that is notified if the search is successful

Declaration

Swift

public static func searchParkingItems(_ searchQuery: ParkingItemQuery, identifier: AnyHashable?, delegate: ParkingItemSearchDelegate)


                    
                    
                    searchParkingItems(_:identifier:previousResultBlock:resultBlock:completion:)

Makes a search in the API catalog given a ParkingItemSearchQuery

searchQuery: The ParkingItemSearchQuery with the search parameters
identifier: An optional hash identifying the request. This value is returned back in the callbacks. Use this to distinguish between different requests
previousResultBlock: A block called (on a worker thread) to return any previous results that are to be merged
resultBlock: A block called (on a worker thread) with the final merged results
completion: A completion block that is called when the results are ready.

Declaration

Swift

public static func searchParkingItems(_ searchQuery: ParkingItemQuery, identifier: AnyHashable?, previousResultBlock: (() -> ParkingItemSearchResult?)?, resultBlock: ((ParkingItemSearchResult?, AnyHashable?) -> Void)?, completion: @escaping (ParkingItemSearchResult?, Error?, AnyHashable?) -> Void)


                    
                    
                    fetchEphemeralStripeCustomerKey(forVersion:completion:)

Returns a traveler authenticated URLRequest that fetches the ephemeral Stripe Customer key

apiVersion: The API Version of the Stripe SDK you need to fetch the key for
completion: A completion block that is called when the results are ready

Declaration

Swift

public static func fetchEphemeralStripeCustomerKey(forVersion apiVersion: String, completion: @escaping (EphemeralKey?, Error?) -> Void)


                    
                    
                    fetchEphemeralStripeCustomerKey(forVersion:delegate:)

Returns a traveler authenticated URLRequest that fetches the ephemeral Stripe Customer key

apiVersion: The API Version of the Stripe SDK you need to fetch the key for
delegate: A EphemeralKeyFetchDelegate that is notified if the fetch is successful

Declaration

Swift

public static func fetchEphemeralStripeCustomerKey(forVersion apiVersion: String, delegate: EphemeralKeyFetchDelegate)


                    
                    
                    fetchItinerary(_:delegate:)

Returns an ItineraryResult containing similar items given an ItineraryQuery

query: The reference ItineraryQuery
delegate: A ItineraryFetchDelegate that is notified if the fetch is successful

Declaration

Swift

public static func fetchItinerary(_ query: ItineraryQuery, delegate: ItineraryFetchDelegate)


                    
                    
                    fetchItinerary(_:completion:)

Returns an ItineraryResult contaning similar items given an ItineraryQuery

query: The reference ItineraryQuery
completion: A completion block that is called when the results are ready

Declaration

Swift

public static func fetchItinerary(_ query: ItineraryQuery, completion: @escaping (ItineraryResult?, Error?) -> Void)


                    
                    
                    fetchPurchasedProductDetails(_:delegate:)

Fetches the AnyPurchasedProductDetails for given query.

Declaration

Swift

public static func fetchPurchasedProductDetails(_ query: PurchasedProductDetailsQuery, delegate: PurchasedProductDetailsFetchDelegate)

Parameters

`query`	The reference `PurchasedProductDetailsQuery`
`delegate`	A `PurchasedProductDetailsFetchDelegate` that is notified of the results.


                    
                    
                    fetchPurchasedProductDetails(_:completion:)

Fetches the AnyPurchasedProductDetails for given PurchasedProductDetailsQuery.

Declaration

Swift

public static func fetchPurchasedProductDetails(_ query: PurchasedProductDetailsQuery, completion: @escaping (AnyPurchasedProductDetails?, Error?) -> Void)

Parameters

`query`	The reference `PurchasedProductDetailsQuery`
`completion`	A completion block that is called when the results are ready.


                    
                    
                    fetchBookingItemCategories(completion:)

Fetches the available BookingItemCategories

Declaration

Swift

public static func fetchBookingItemCategories(completion: @escaping ([BookingItemCategory]?, Error?) -> Void)

Parameters


                                completion

A completion block that is called when the results are ready


                    
                    
                    fetchBookingItemCategories(delegate:)

Fetches the available BookingItemCategories

Declaration

Swift

public static func fetchBookingItemCategories(delegate: BookingItemCategoryFetchDelegate)

Parameters


                                delegate

A BookingItemCategoryFetchDelegate that is notified of the results


                    
                    
                    fetchFlightBookings(delegate:)

Fetches user’s saved FlightBooking‘s

Declaration

Swift

public static func fetchFlightBookings(delegate: FlightBookingFetchDelegate)

Parameters


                                delegate

A FlightBookingFetchDelegate that is notified of the results


                    
                    
                    fetchFlightBookings(completion:)

Fetches user’s saved FlightBooking‘s

Declaration

Swift

public static func fetchFlightBookings(completion: @escaping ([FlightBooking]?, Error?) -> Void)

Parameters


                                completion

A completion block that is called when the results are ready


                    
                    
                    addFlightBooking(forFlight:delegate:)

Creates a new FlightBooking

Declaration

Swift

public static func addFlightBooking(forFlight flight: Flight, delegate: FlightBookingCreateDelegate)

Parameters

`flight`	`Flight` for which user needs to create a `FlightBooking`
`delegate`	A `FlightBookingCreateDelegate` that is notified of the results.


                    
                    
                    addFlightBooking(forFlight:completion:)

Creates a new FlightBooking

Declaration

Swift

public static func addFlightBooking(forFlight flight: Flight, completion: @escaping (FlightBooking?, Error?) -> Void)

Parameters

`flight`	`Flight` for which user needs to create a `FlightBooking`
`completion`	A completion block that is called when results are ready.


                    
                    
                    removeFlightBooking(_:delegte:)

Deletes a FlightBooking

Declaration

Swift

public static func removeFlightBooking(_ flightBooking: FlightBooking, delegte: FlightBookingDeleteDelegate)

Parameters

`flightBooking`	A `FlightBooking` to delete
`delegate`	A `FlightBookingDeleteDelegate` notified of the results.


                    
                    
                    removeFlightBooking(_:completion:)

Deletes a FlightBooking

Declaration

Swift

public static func removeFlightBooking(_ flightBooking: FlightBooking, completion: @escaping (Error?) -> Void)

Parameters

`flightBooking`	A `FlightBooking` to delete
`completion`	A completion block that is called when results are ready.

Traveler

Declaration

Declaration

Public API

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters