\AdventureRes\Services AdventureResReservationService

Class AdventureResReservationService

Summary

Methods

Properties

Constants

__construct()
setApp()
setHttpClient()
getSessionId()
setSessionId()
__call()
getReservationPolicies()
getItinerary()
getCostSummary()
getPaymentMethods()
addPayment()
getPaymentDue()
addPromoCode()
getConfirmationMessage()

No public properties found

API_SERVICE
POLICIES_ENDPOINT
ITINERARY_DISPLAY_ENDPOINT
COST_SUMMARY_ENDPOINT
PAYMENT_METHODS_ENDPOINT
PAYMENT_ADD_ENDPOINT
PAYMENT_DUE_ENDPOINT
PROMO_CODE_ENDPOINT
CONFIRMATION_ENDPOINT

makeApiCall()

$httpClient
$client
$app
$sessionId
$shouldValidateSessionIds

N/A

No private methods found

No private properties found

N/A

File: Services/AdventureResReservationService.php
Package: AdventureRes\Services
Class hierarchy: \AdventureRes\AbstractAdventureResBase

\AdventureRes\Services\AbstractAdventureResService

\AdventureRes\Services\AdventureResReservationService

Constants

API_SERVICE

API_SERVICE

The API service used in this class.

POLICIES_ENDPOINT

POLICIES_ENDPOINT

ITINERARY_DISPLAY_ENDPOINT

ITINERARY_DISPLAY_ENDPOINT

COST_SUMMARY_ENDPOINT

COST_SUMMARY_ENDPOINT

PAYMENT_METHODS_ENDPOINT

PAYMENT_METHODS_ENDPOINT

PAYMENT_ADD_ENDPOINT

PAYMENT_ADD_ENDPOINT

PAYMENT_DUE_ENDPOINT

PAYMENT_DUE_ENDPOINT

PROMO_CODE_ENDPOINT

PROMO_CODE_ENDPOINT

CONFIRMATION_ENDPOINT

CONFIRMATION_ENDPOINT

Properties

$httpClient

$httpClient : \AdventureRes\HttpClients\AdventureResHttpClientInterface

Type

\AdventureRes\HttpClients\AdventureResHttpClientInterface

$client

$client : \AdventureRes\AdventureResClient

Type

\AdventureRes\AdventureResClient

$app

$app : \AdventureRes\AdventureResApp

Type

\AdventureRes\AdventureResApp

$sessionId

$sessionId : string

Type

string

$shouldValidateSessionIds

$shouldValidateSessionIds : boolean

Type

boolean — This should only be used for testing.

Methods

__construct()

__construct(\AdventureRes\AdventureResApp  $app, \AdventureRes\HttpClients\AdventureResHttpClientInterface|null  $client = null, boolean  $shouldValidateSessionIds = true)

AbstractAdventureResService constructor.

Parameters

\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()

setApp(\AdventureRes\AdventureResApp  $app)

Sets the configuration app.

Parameters

\AdventureRes\AdventureResApp

$app

setHttpClient()

setHttpClient(\AdventureRes\HttpClients\AdventureResHttpClientInterface  $httpClient)

Sets the HTTP client to be used in requests.

Parameters

\AdventureRes\HttpClients\AdventureResHttpClientInterface

$httpClient

getSessionId()

getSessionId() : string

Gets the session ID to be used in requests. Uses the AdventureResSession class to validate and/or generate a session ID.

Returns

string

setSessionId()

setSessionId(string  $sessionId)

Sets the session ID.

Parameters

string

$sessionId

__call()

__call(  $command,   $arguments)

Parameters

	$command
	$arguments

getReservationPolicies()

getReservationPolicies(\AdventureRes\Models\Input\ItineraryInputModel  $input) : array

Gets applicable policies for a reservations.

Parameters

\AdventureRes\Models\Input\ItineraryInputModel

$input

Throws

\AdventureRes\Exceptions\AdventureResSDKException

Returns

array —

[\AdventureRes\Models\Output\ReservationPolicyModel]

getItinerary()

getItinerary(\AdventureRes\Models\Input\ItineraryInputModel  $inputModel) : array

Gets the items stored in the user's itinerary.

Parameters

\AdventureRes\Models\Input\ItineraryInputModel

$inputModel

Throws

\AdventureRes\Exceptions\AdventureResSDKException

Returns

array —

[\AdventureRes\Models\Output\ReservationItemModel]

getCostSummary()

getCostSummary(\AdventureRes\Models\Input\ItineraryInputModel  $inputModel) : \AdventureRes\Models\Output\CostSummaryModel

Gets the cost summary for an itinerary.

Parameters

\AdventureRes\Models\Input\ItineraryInputModel

$inputModel

Throws

\AdventureRes\Exceptions\AdventureResSDKException

Returns

\AdventureRes\Models\Output\CostSummaryModel

getPaymentMethods()

getPaymentMethods() : array

Gets the accepted payment methods for the configured location.

Returns

array —

[\AdventureRes\Models\Output\PaymentMethodModel]

addPayment()

addPayment(\AdventureRes\Models\Input\PaymentInputModel  $inputModel) : \AdventureRes\Models\Output\ReservationModel

Adds a payment to the reservation.

Parameters

\AdventureRes\Models\Input\PaymentInputModel

$inputModel

Throws

\AdventureRes\Exceptions\AdventureResSDKException

Returns

\AdventureRes\Models\Output\ReservationModel

getPaymentDue()

getPaymentDue(\AdventureRes\Models\Input\ItineraryInputModel  $inputModel) : \AdventureRes\Models\Output\PaymentDueModel

Gets the payment due for a reservation.

Parameters

\AdventureRes\Models\Input\ItineraryInputModel

$inputModel

Throws

\AdventureRes\Exceptions\AdventureResSDKException

Returns

\AdventureRes\Models\Output\PaymentDueModel

addPromoCode()

addPromoCode(\AdventureRes\Models\Input\PromoCodeInputModel  $inputModel) : \AdventureRes\Models\AbstractAdventureResModel

Adds a promo code to a reservation.

Parameters

\AdventureRes\Models\Input\PromoCodeInputModel

$inputModel

Throws

\AdventureRes\Exceptions\AdventureResSDKException

Returns

\AdventureRes\Models\AbstractAdventureResModel

getConfirmationMessage()

getConfirmationMessage(\AdventureRes\Models\Input\ItineraryInputModel  $inputModel) : \AdventureRes\Models\AbstractAdventureResModel

Gets the confirmation message for a reservation.

Parameters

\AdventureRes\Models\Input\ItineraryInputModel

$inputModel

Throws

\AdventureRes\Exceptions\AdventureResSDKException

Returns

\AdventureRes\Models\AbstractAdventureResModel

makeApiCall()

makeApiCall(  $method,   $endpoint,   $params) : \AdventureRes\Http\AdventureResResponse

Generates an AdventureResRequest and sends it via the client.

Parameters

	$method
	$endpoint
	$params

Throws

\AdventureRes\Exceptions\AdventureResResponseException

Returns

\AdventureRes\Http\AdventureResResponse