Interface GroundTransfersService

interface GroundTransfersService {
    bookGroundTransfers(
        bookRequest: GroundTransfersBookRequest,
    ): Promise<GroundTransfersBookResponse[]>;
    cancelGroundTransfer(
        groundTransferId: string,
        cancelRequest?: GroundTransferCancelRequest,
    ): Promise<null | models.groundTransfers.SavedGroundTransfer>;
    createGroundTransferService(): Promise<models.services.SavedGroundTransfer>;
    getGroundTransferById(
        groundTransferId: string,
        listQueryOptions?: ListQueryOptions<
            models.groundTransfers.SavedGroundTransfer,
        >,
    ): Promise<null | models.groundTransfers.SavedGroundTransfer>;
    getQuotes(
        quotesRequest: GroundTransfersQuotesRequest,
    ): Promise<GroundTransfersQuotesResponse>;
    listGroundTransfersByIds(
        groundTransferIds: string[],
    ): Promise<models.groundTransfers.SavedGroundTransfer[]>;
    listGroundTransfersForUser(
        tripId: string,
    ): Promise<models.groundTransfers.SavedGroundTransfer[]>;
    syncGroundTransfers(
        syncJourneysWithin24Hours: boolean,
    ): Promise<models.groundTransfers.SavedGroundTransfer[]>;
    updateGroundTransferJourney(
        groundTransferId: string,
        updateGroundTransferParams: UpdateGroundTransferParams,
    ): Promise<models.groundTransfers.SavedGroundTransfer>;
}

Index

Methods

bookGroundTransfers cancelGroundTransfer createGroundTransferService getGroundTransferById getQuotes listGroundTransfersByIds listGroundTransfersForUser syncGroundTransfers updateGroundTransferJourney

Methods

bookGroundTransfers

bookGroundTransfers(
bookRequest: GroundTransfersBookRequest,
): Promise<GroundTransfersBookResponse[]>
Creates and pays ground transfers for a traveler or a host
Parameters
- bookRequest: GroundTransfersBookRequest
  The request to book ground transfers
Returns Promise<GroundTransfersBookResponse[]>
- Defined in packages/services/src/services/GroundTransfers/GroundTransfersService.ts:31

cancelGroundTransfer

cancelGroundTransfer(
groundTransferId: string,
cancelRequest?: GroundTransferCancelRequest,
): Promise<null | models.groundTransfers.SavedGroundTransfer>
Cancels all journeys related to the ground transfer. If journeyId is supplied, only that journey will be canceled
Parameters
- groundTransferId: string
  The ID of the ground transfer
- OptionalcancelRequest: GroundTransferCancelRequest
  The cancel request parameters
Returns Promise<null | models.groundTransfers.SavedGroundTransfer>
- Defined in packages/services/src/services/GroundTransfers/GroundTransfersService.ts:40

createGroundTransferService

createGroundTransferService(): Promise<models.services.SavedGroundTransfer>
Creates a ground transfer service during trip creation

Returns Promise<models.services.SavedGroundTransfer>
- Defined in packages/services/src/services/GroundTransfers/GroundTransfersService.ts:48

getGroundTransferById

getGroundTransferById(
    groundTransferId: string,
    listQueryOptions?: ListQueryOptions<
        models.groundTransfers.SavedGroundTransfer,
    >,
): Promise<null | models.groundTransfers.SavedGroundTransfer>
Returns a ground transfer booking instance by its internal id
Parameters
- groundTransferId: string
- OptionallistQueryOptions: ListQueryOptions<models.groundTransfers.SavedGroundTransfer>
Returns Promise<null | models.groundTransfers.SavedGroundTransfer>
- Defined in packages/services/src/services/GroundTransfers/GroundTransfersService.ts:53

getQuotes

getQuotes(
quotesRequest: GroundTransfersQuotesRequest,
): Promise<GroundTransfersQuotesResponse>
Retrieves a set of quotes for the provided input parameters
Parameters
- quotesRequest: GroundTransfersQuotesRequest
  The quotes request parameters
Returns Promise<GroundTransfersQuotesResponse>
- Defined in packages/services/src/services/GroundTransfers/GroundTransfersService.ts:23

listGroundTransfersByIds

listGroundTransfersByIds(
groundTransferIds: string[],
): Promise<models.groundTransfers.SavedGroundTransfer[]>
Returns a list of ground transfer bookings by a list of ids
Parameters
- groundTransferIds: string[]
  list of ground transfer booking ids
Returns Promise<models.groundTransfers.SavedGroundTransfer[]>
- Defined in packages/services/src/services/GroundTransfers/GroundTransfersService.ts:62

listGroundTransfersForUser

listGroundTransfersForUser(
tripId: string,
): Promise<models.groundTransfers.SavedGroundTransfer[]>
Returns a list of ground transfers by trip id for a logged in user
Parameters
- tripId: string
Returns Promise<models.groundTransfers.SavedGroundTransfer[]>
- Defined in packages/services/src/services/GroundTransfers/GroundTransfersService.ts:70

syncGroundTransfers

syncGroundTransfers(
syncJourneysWithin24Hours: boolean,
): Promise<models.groundTransfers.SavedGroundTransfer[]>
Updates persisted ground transfers with the latest data from the provider
Parameters
- syncJourneysWithin24Hours: boolean
  If true, only syncs ground transfers with journeys that are within 24 hours of the current time
Returns Promise<models.groundTransfers.SavedGroundTransfer[]>
- Defined in packages/services/src/services/GroundTransfers/GroundTransfersService.ts:76

updateGroundTransferJourney

updateGroundTransferJourney(
groundTransferId: string,
updateGroundTransferParams: UpdateGroundTransferParams,
): Promise<models.groundTransfers.SavedGroundTransfer>
Updates a ground transfer's journey details
Parameters
- groundTransferId: string
  id for the ground transfer to update
- updateGroundTransferParams: UpdateGroundTransferParams
  update ground transfer journey parameters
Returns Promise<models.groundTransfers.SavedGroundTransfer>
- Defined in packages/services/src/services/GroundTransfers/GroundTransfersService.ts:85

Interface GroundTransfersService

Index

Methods

Methods

bookGroundTransfers

Parameters

Returns Promise<GroundTransfersBookResponse[]>

cancelGroundTransfer

Parameters

Returns Promise<null | models.groundTransfers.SavedGroundTransfer>

createGroundTransferService

Returns Promise<models.services.SavedGroundTransfer>

getGroundTransferById

Parameters

Returns Promise<null | models.groundTransfers.SavedGroundTransfer>

getQuotes

Parameters

Returns Promise<GroundTransfersQuotesResponse>

listGroundTransfersByIds

Parameters

Returns Promise<models.groundTransfers.SavedGroundTransfer[]>

listGroundTransfersForUser

Parameters

Returns Promise<models.groundTransfers.SavedGroundTransfer[]>

syncGroundTransfers

Parameters

Returns Promise<models.groundTransfers.SavedGroundTransfer[]>

updateGroundTransferJourney

Parameters

Returns Promise<models.groundTransfers.SavedGroundTransfer>

Settings

On This Page