Interface CheckoutService

interface CheckoutService {
    createBooking(
        booking: models.checkout.BookingCreateParams,
    ): Promise<BookingCreateResult>;
    createInsuranceQuotes(
        booking: BookingInsuranceQuotesRequest,
    ): Promise<BookingInsuranceQuotes>;
    getBookingOffTheWaitlist(booking: BaseBooking): Promise<null | BaseBooking>;
    getOrCreateUsersFromBooking(
        travelersInfo: TravelerInfo[],
    ): Promise<
        { additionalParticipants: BookingUser[]; customer: BookingUser },
    >;
    getTripCheckoutInformation(tripId: string): Promise<TripCheckout>;
    getWaitlistedBookingForCustomer(
        tripId: string,
        customer: TravelerCheckout,
    ): Promise<null | SavedBooking>;
    validateBooking(
        booking: models.checkout.BookingCreateParams,
    ): Promise<void>;
    validateTravelers(
        travelers: TravelerCheckout[],
        tripId: string,
    ): Promise<void>;
}

Index

Methods

createBooking createInsuranceQuotes getBookingOffTheWaitlist getOrCreateUsersFromBooking getTripCheckoutInformation getWaitlistedBookingForCustomer validateBooking validateTravelers

Methods

createBooking

createBooking(
booking: models.checkout.BookingCreateParams,
): Promise<BookingCreateResult>
Creates a booking instance from the BookingCreateParams
Parameters
- booking: models.checkout.BookingCreateParams
Returns Promise<BookingCreateResult>
- Defined in packages/services/src/services/Checkout/CheckoutService.ts:71

createInsuranceQuotes

createInsuranceQuotes(
booking: BookingInsuranceQuotesRequest,
): Promise<BookingInsuranceQuotes>
Create insurance quotes for an in-progress booking
Parameters
- booking: BookingInsuranceQuotesRequest
Returns Promise<BookingInsuranceQuotes>
- Defined in packages/services/src/services/Checkout/CheckoutService.ts:77

getBookingOffTheWaitlist

getBookingOffTheWaitlist(booking: BaseBooking): Promise<null | BaseBooking>
Given a booking id, it updates the booking appropriately to be considered as an actual traveler on the trip (not longer in the waitlist)
Parameters
- booking: BaseBooking
  the booking object to get off the waitlist
Returns Promise<null | BaseBooking>
- Defined in packages/services/src/services/Checkout/CheckoutService.ts:43

getOrCreateUsersFromBooking

getOrCreateUsersFromBooking(
travelersInfo: TravelerInfo[],
): Promise<{ additionalParticipants: BookingUser[]; customer: BookingUser }>
Get or create users from travelers information *
Parameters
- travelersInfo: TravelerInfo[]
Returns Promise<{ additionalParticipants: BookingUser[]; customer: BookingUser }>
- Defined in packages/services/src/services/Checkout/CheckoutService.ts:20

getTripCheckoutInformation

getTripCheckoutInformation(tripId: string): Promise<TripCheckout>
Returns the trip checkout information for a given tripId. Will throw an exception if doesn't find the trip
Parameters
- tripId: string
Returns Promise<TripCheckout>
- Defined in packages/services/src/services/Checkout/CheckoutService.ts:50

getWaitlistedBookingForCustomer

getWaitlistedBookingForCustomer(
tripId: string,
customer: TravelerCheckout,
): Promise<null | SavedBooking>
Returns the waitlisted booking for the customer in case it exists
Parameters
- tripId: string
- customer: TravelerCheckout
Returns Promise<null | SavedBooking>
- Defined in packages/services/src/services/Checkout/CheckoutService.ts:32

validateBooking

validateBooking(booking: models.checkout.BookingCreateParams): Promise<void>
Validates a booking before its creation
Parameters
- booking: models.checkout.BookingCreateParams
Returns Promise<void>
- Defined in packages/services/src/services/Checkout/CheckoutService.ts:65

validateTravelers

validateTravelers(travelers: TravelerCheckout[], tripId: string): Promise<void>
Validates the travelers associated with a Booking
Parameters
- travelers: TravelerCheckout[]
- tripId: string
Returns Promise<void>
- Defined in packages/services/src/services/Checkout/CheckoutService.ts:56

Interface CheckoutService

Index

Methods

Methods

createBooking

Parameters

Returns Promise<BookingCreateResult>

createInsuranceQuotes

Parameters

Returns Promise<BookingInsuranceQuotes>

getBookingOffTheWaitlist

Parameters

Returns Promise<null | BaseBooking>

getOrCreateUsersFromBooking

Parameters

Returns Promise<{ additionalParticipants: BookingUser[]; customer: BookingUser }>

getTripCheckoutInformation

Parameters

Returns Promise<TripCheckout>

getWaitlistedBookingForCustomer

Parameters

Returns Promise<null | SavedBooking>

validateBooking

Parameters

Returns Promise<void>

validateTravelers

Parameters

Returns Promise<void>

Settings

On This Page