com.bookeo.api.service

Class HoldsApi

java.lang.Object

com.bookeo.api.service.HoldsApi

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2015-12-03T18:48:57.986-05:00")
public class HoldsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
HoldsApi()
HoldsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	holdsIdDelete(String id) Delete a temporary hold Delete a temporary hold previously created.\n Note that you can also delete a hold when creating a new hold (ex.
Hold	holdsIdGet(String id) Retrieve a hold previously generated
void	holdsPost(Booking booking, Integer holdDurationSeconds, String previousHoldId) Create a temporary hold to finalize the booking Performs a final check of the booking, and reserves required resources/seats to allow finalization of the booking process (ex.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HoldsApi

public HoldsApi()

HoldsApi

public HoldsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

holdsPost

public void holdsPost(Booking booking,
                      Integer holdDurationSeconds,
                      String previousHoldId)
               throws ApiException

Create a temporary hold to finalize the booking Performs a final check of the booking, and reserves required resources/seats to allow finalization of the booking process (ex. process payment).\n The returned object also contains the updated price calculations.\n Normally your application should have no more than one hold in place during a customer booking process.\n Make sure to not leave many holds around. In any case, holds are deleted automatically after a fixed time from creation.\n Note that when creating a hold, the customer field of the booking can be missing, in which case Bookeo will assume a default customer coming from the same country as the account.

Parameters:

booking -

holdDurationSeconds - the required seats/resources will be reserved for the specified time, ensuring that they cannot be taken by other bookings during this time. The hold cannot be for more than 10 minutes.

previousHoldId - if a previous hold was created during the same session with the customer, it will be automatically removed and replaced by the new one.

Throws:

ApiException

holdsIdGet

public Hold holdsIdGet(String id)
                throws ApiException

Retrieve a hold previously generated

Parameters:

id -

Returns:

Hold

Throws:

ApiException

holdsIdDelete

public void holdsIdDelete(String id)
                   throws ApiException

Delete a temporary hold Delete a temporary hold previously created.\n Note that you can also delete a hold when creating a new hold (ex. when the customer goes back in the booking process and selects a different time), or when creating a booking (i.e. when the customer checks out), without having to make a separate call to this endpoint.

Parameters:

id -

Throws:

ApiException