API_SERVICE
API_SERVICE
The API service used in this class.
Class AdventureResReservationService
$httpClient : \AdventureRes\HttpClients\AdventureResHttpClientInterface
$client : \AdventureRes\AdventureResClient
$app : \AdventureRes\AdventureResApp
__construct(\AdventureRes\AdventureResApp $app, \AdventureRes\HttpClients\AdventureResHttpClientInterface|null $client = null, boolean $shouldValidateSessionIds = true)
AbstractAdventureResService constructor.
| \AdventureRes\AdventureResApp | $app | The configuration app. |
| \AdventureRes\HttpClients\AdventureResHttpClientInterface|null | $client | Optionally pass in a pre-configured HttpClient. |
| boolean | $shouldValidateSessionIds | This should only be used for testing. |
setApp(\AdventureRes\AdventureResApp $app)
Sets the configuration app.
| \AdventureRes\AdventureResApp | $app |
setHttpClient(\AdventureRes\HttpClients\AdventureResHttpClientInterface $httpClient)
Sets the HTTP client to be used in requests.
| \AdventureRes\HttpClients\AdventureResHttpClientInterface | $httpClient |
getReservationPolicies(\AdventureRes\Models\Input\ReservationItineraryInputModel $input) : array
Gets applicable policies for a reservations.
| \AdventureRes\Models\Input\ReservationItineraryInputModel | $input |
[\AdventureRes\Models\Output\ReservationPolicyModel]
getItinerary(\AdventureRes\Models\Input\ReservationItineraryInputModel $inputModel) : array
Gets the items stored in the user's itinerary.
| \AdventureRes\Models\Input\ReservationItineraryInputModel | $inputModel |
[\AdventureRes\Models\Output\ReservationItemModel]
getCostSummary(\AdventureRes\Models\Input\ReservationItineraryInputModel $inputModel) : \AdventureRes\Models\Output\CostSummaryModel
Gets the cost summary for an itinerary.
| \AdventureRes\Models\Input\ReservationItineraryInputModel | $inputModel |
getPaymentMethods(\AdventureRes\Services\ServiceClassificationInputModel $inputModel) : array
Gets the accepted payment methods for the configured location.
| \AdventureRes\Services\ServiceClassificationInputModel | $inputModel |
[\AdventureRes\Models\Output\PaymentMethodModel]
addPayment(\AdventureRes\Models\Input\ReservationPaymentAddInputModel $inputModel) : \AdventureRes\Models\Output\ReservationModel
Adds a payment to the reservation.
| \AdventureRes\Models\Input\ReservationPaymentAddInputModel | $inputModel |
getPaymentDue(\AdventureRes\Models\Input\ReservationItineraryInputModel $inputModel) : \AdventureRes\Models\Output\PaymentDueModel
Gets the payment due for a reservation.
| \AdventureRes\Models\Input\ReservationItineraryInputModel | $inputModel |
addPromoCode(\AdventureRes\Models\Input\ReservationPromoCodeAddInputModel $inputModel) : \AdventureRes\Models\AbstractAdventureResModel
Adds a promo code to a reservation.
| \AdventureRes\Models\Input\ReservationPromoCodeAddInputModel | $inputModel |
getConfirmationMessage(\AdventureRes\Models\Input\ReservationConfirmationInputModel $inputModel) : \AdventureRes\Models\AbstractAdventureResModel
Gets the confirmation message for a reservation.
| \AdventureRes\Models\Input\ReservationConfirmationInputModel | $inputModel |
saveReservationAsQuote(\AdventureRes\Models\Input\ReservationQuoteInputModel $inputModel) : \AdventureRes\Models\Output\ReservationModel
Provides the ability to Save a Reservation as a Quote.
| \AdventureRes\Models\Input\ReservationQuoteInputModel | $inputModel |
listFees(\AdventureRes\Models\Input\ReservationItineraryInputModel $inputModel) : array
Provides the ability to list online fees for Cancellation or Insurance, etc.
| \AdventureRes\Models\Input\ReservationItineraryInputModel | $inputModel |
[AdventureRes\Models\Output\FeeModel]
removeFee(\AdventureRes\Models\Input\ReservationFeeRemoveInputModel $inputModel) : \AdventureRes\Models\Output\FeeModel
Provides ability to remove online fees for cancellation or insurance, etc.
| \AdventureRes\Models\Input\ReservationFeeRemoveInputModel | $inputModel |
makeApiCall( $method, $endpoint, $params) : \AdventureRes\Http\AdventureResResponse
Generates an AdventureResRequest and sends it via the client.
| $method | ||
| $endpoint | ||
| $params |