\AdventureRes\Services AdventureResServiceService

Class AdventureResServiceService

Summary

Methods

Properties

Constants

__construct()
setApp()
setHttpClient()
getSessionId()
setSessionId()
__call()
getClassifications()
getServiceGroups()
getService()
getServiceAvailability()
addServiceToReservation()
removeServiceFromReservation()

No public properties found

API_SERVICE
CLASSIFICATION_ENDPOINT
SERVICE_GROUP_ENDPOINT
SERVICE_DISPLAY_ENDPOINT
SERVICE_AVAILABILITY_ENDPOINT
SERVICE_ADD_ENDPOINT
SERVICE_REMOVE_ENDPOINT

makeApiCall()

$httpClient
$client
$app
$sessionId
$shouldValidateSessionIds

N/A

No private methods found

No private properties found

N/A

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

\AdventureRes\Services\AbstractAdventureResService

\AdventureRes\Services\AdventureResServiceService

Constants

API_SERVICE

API_SERVICE

The API service used in this class.

CLASSIFICATION_ENDPOINT

CLASSIFICATION_ENDPOINT

SERVICE_GROUP_ENDPOINT

SERVICE_GROUP_ENDPOINT

SERVICE_DISPLAY_ENDPOINT

SERVICE_DISPLAY_ENDPOINT

SERVICE_AVAILABILITY_ENDPOINT

SERVICE_AVAILABILITY_ENDPOINT

SERVICE_ADD_ENDPOINT

SERVICE_ADD_ENDPOINT

SERVICE_REMOVE_ENDPOINT

SERVICE_REMOVE_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

getClassifications()

getClassifications() : array

Gets service classifications from the API.

Throws

\AdventureRes\Exceptions\AdventureResResponseException

Returns

array —

[AdventureRes\Models\Output\ClassificationModel]

getServiceGroups()

getServiceGroups() : array

Gets service groups from the API. Nearly identical to `getClassifications`.

Throws

\AdventureRes\Exceptions\AdventureResResponseException

Returns

array —

[AdventureRes\Models\Output\ClassificationModel]

getService()

getService(\AdventureRes\Models\Input\ServiceDisplayInputModel  $inputModel) : \AdventureRes\Models\AbstractAdventureResModel

Gets information about a service.

Parameters

\AdventureRes\Models\Input\ServiceDisplayInputModel

$inputModel

Throws

\AdventureRes\Exceptions\AdventureResSDKException

Returns

\AdventureRes\Models\AbstractAdventureResModel

getServiceAvailability()

getServiceAvailability(\AdventureRes\Models\Input\ServiceAvailabilityInputModel  $inputModel) : array

Gets all availability options for a service by provided date.

Parameters

\AdventureRes\Models\Input\ServiceAvailabilityInputModel

$inputModel

Throws

\AdventureRes\Exceptions\AdventureResSDKException

Returns

array —

[AdventureRes\Models\Output\ServiceModel]

addServiceToReservation()

addServiceToReservation(\AdventureRes\Models\Input\ServiceAddInputModel  $inputModel) : \AdventureRes\Models\AbstractAdventureResModel

Adds a service to a customer's reservation. If the reservation hasn't been set, it creates a new reservation ID.

Parameters

\AdventureRes\Models\Input\ServiceAddInputModel

$inputModel

Throws

\AdventureRes\Exceptions\AdventureResSDKException

Returns

\AdventureRes\Models\AbstractAdventureResModel

removeServiceFromReservation()

removeServiceFromReservation(\AdventureRes\Models\Input\ServiceRemoveInputModel  $inputModel) : mixed

Removes a service from a reservation. If the result of the call leaves the reservation with zero services, the reservation id in the session is set back to 0.

Parameters

\AdventureRes\Models\Input\ServiceRemoveInputModel

$inputModel

Throws

\AdventureRes\Exceptions\AdventureResSDKException

Returns

mixed

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