com.bookeo.api.service

Class BookingsApi

java.lang.Object

com.bookeo.api.service.BookingsApi

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

Constructor Summary

Constructors

Constructor and Description
BookingsApi()
BookingsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Customer	bookingsBookingNumberCustomerGet(String bookingNumber) Retrieve the customer associated with a booking Retrieve the customer associated with a booking.
void	bookingsBookingNumberDelete(String bookingNumber, Boolean notifyUsers, Boolean notifyCustomer, Boolean applyCancellationPolicy, Boolean trackInCustomerHistory, Boolean cancelRemainingSeries, String reason) Cancel a booking Cancel a booking.
Booking	bookingsBookingNumberGet(String bookingNumber, Boolean expandCustomer, Boolean expandParticipants) Retrieve a booking Retrieve a booking by its booking number
PaymentsList	bookingsBookingNumberPaymentsGet(String bookingNumber, Integer itemsPerPage, String pageNavigationToken, Integer pageNumber) Get the payments received for a booking Get a list of all payments received for a booking.
void	bookingsBookingNumberPaymentsPost(Payment apiPayment, String bookingNumber) Add a payment to a booking Create a payment record associated with a booking
void	bookingsBookingNumberPut(Booking booking, String bookingNumber, Boolean notifyUsers, Boolean notifyCustomer) Update an existing booking
BookingsList	bookingsGet(Date startTime, Date endTime, Date lastUpdatedStartTime, Date lastUpdatedEndTime, String productId, Boolean includeCanceled, Boolean expandCustomer, Boolean expandParticipants, Integer itemsPerPage, String pageNavigationToken, Integer pageNumber) Retrieve bookings Retrieve existing bookings\n The result is limited by the permissions of the apiKey.\n <p/>\n It is possible to filter by time booked and/or time of the last change.\n To filter by time booked, the parameters startTime and endTime are required.\n To filter by last time changed, the parameters lastUpdatedStartTime and lastUpdatedEndTime are required.\n It is possible to filter by both at the same time.
void	bookingsPost(Booking booking, String previousHoldId, Boolean notifyUsers, Boolean notifyCustomer, Boolean sendCustomerReminders, Boolean sendCustomerThankyou) Create a new booking When creating a booking for a product of type \"fixed\" or \"fixedCourse\", the eventId is required.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

BookingsApi

public BookingsApi()

BookingsApi

public BookingsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

bookingsGet

public BookingsList bookingsGet(Date startTime,
                                Date endTime,
                                Date lastUpdatedStartTime,
                                Date lastUpdatedEndTime,
                                String productId,
                                Boolean includeCanceled,
                                Boolean expandCustomer,
                                Boolean expandParticipants,
                                Integer itemsPerPage,
                                String pageNavigationToken,
                                Integer pageNumber)
                         throws ApiException

Retrieve bookings Retrieve existing bookings\n The result is limited by the permissions of the apiKey.\n <p/>\n It is possible to filter by time booked and/or time of the last change.\n To filter by time booked, the parameters startTime and endTime are required.\n To filter by last time changed, the parameters lastUpdatedStartTime and lastUpdatedEndTime are required.\n It is possible to filter by both at the same time. At least one of the two filters must be used.\n <p/>\n It is further possible to filter by product id.

Parameters:

startTime - if specified, only include bookings that start on or after this time. If specified, endTime must be specified as well.

endTime - if specified, only include bookings that start on or before this time. If specified, startTime must be specified as well. The maximum allowed interval is 31 days.

lastUpdatedStartTime - if specified, only include bookings that were last changed (or created) on or after this time. If specified, lastUpdatedEndTime must be specified as well.

lastUpdatedEndTime - if specified, only include bookings that were last changed (or created) on or before this time. If specified, lastUpdatedStartTime must be specified as well. The maximum allowed interval is 31 days.

productId - if not specified, include bookings for all products. If specified, include only bookings for this product

includeCanceled - if true, canceled bookings are included. If false, only bookings that are not canceled are included

expandCustomer - if true, the full details of the customer are included (provided the application has read permission over the customer)

expandParticipants - if true, full details of the participants are included (provided the application has read permission over the participant)

itemsPerPage - maximum: 100

pageNavigationToken -

pageNumber -

Returns:

BookingsList

Throws:

ApiException

bookingsPost

public void bookingsPost(Booking booking,
                         String previousHoldId,
                         Boolean notifyUsers,
                         Boolean notifyCustomer,
                         Boolean sendCustomerReminders,
                         Boolean sendCustomerThankyou)
                  throws ApiException

Create a new booking When creating a booking for a product of type \"fixed\" or \"fixedCourse\", the eventId is required. eventIds are obtained by calling /availability/slots or /availability/matchingSlots .\n When creating a booking for a product of type \"flexibleTime\", you can either specify the eventId or the startTime (in which case you can optionally specify the endTime. If no endTime is specified, Bookeo will automatically calculate the duration based on the options chosen)

Parameters:

booking -

previousHoldId - if specified, deletes the hold with the given id

notifyUsers -

notifyCustomer -

sendCustomerReminders -

sendCustomerThankyou -

Throws:

ApiException

bookingsBookingNumberGet

public Booking bookingsBookingNumberGet(String bookingNumber,
                                        Boolean expandCustomer,
                                        Boolean expandParticipants)
                                 throws ApiException

Retrieve a booking Retrieve a booking by its booking number

Parameters:

bookingNumber -

expandCustomer - if true, the full details of the customer are included (provided the application has read permission over the customer)

expandParticipants - if true, full details of the participants are included (provided the application has read permission over the participant)

Returns:

Booking

Throws:

ApiException

bookingsBookingNumberPut

public void bookingsBookingNumberPut(Booking booking,
                                     String bookingNumber,
                                     Boolean notifyUsers,
                                     Boolean notifyCustomer)
                              throws ApiException

Update an existing booking

Parameters:

booking -

bookingNumber -

notifyUsers -

notifyCustomer -

Throws:

ApiException

bookingsBookingNumberDelete

public void bookingsBookingNumberDelete(String bookingNumber,
                                        Boolean notifyUsers,
                                        Boolean notifyCustomer,
                                        Boolean applyCancellationPolicy,
                                        Boolean trackInCustomerHistory,
                                        Boolean cancelRemainingSeries,
                                        String reason)
                                 throws ApiException

Cancel a booking Cancel a booking. Cancelled bookings remain in the system, but no longer show up in the calendar or take up seats.

Parameters:

bookingNumber -

notifyUsers - if true, notification emails and SMS are sent to authorized users

notifyCustomer - if true, a notification email is sent to the customer

applyCancellationPolicy - if true, the default cancellation policy is applied. This may cause a charge on the credit card on file, if a cancellation fee is due

trackInCustomerHistory - if true, the cancellation will be tracked in the customer's stats

cancelRemainingSeries - if true, and this booking is part of a recurring series, all following bookings will be cancelled as well

reason - an optional reason that explains why the booking was cancelled

Throws:

ApiException

bookingsBookingNumberCustomerGet

public Customer bookingsBookingNumberCustomerGet(String bookingNumber)
                                          throws ApiException

Retrieve the customer associated with a booking Retrieve the customer associated with a booking.

Parameters:

bookingNumber -

Returns:

Customer

Throws:

ApiException

bookingsBookingNumberPaymentsGet

public PaymentsList bookingsBookingNumberPaymentsGet(String bookingNumber,
                                                     Integer itemsPerPage,
                                                     String pageNavigationToken,
                                                     Integer pageNumber)
                                              throws ApiException

Get the payments received for a booking Get a list of all payments received for a booking. Only payments for which the apiKey has at least read permission will be included

Parameters:

bookingNumber -

itemsPerPage - .\nmaximum: 100

pageNavigationToken -

pageNumber -

Returns:

PaymentsList

Throws:

ApiException

bookingsBookingNumberPaymentsPost

public void bookingsBookingNumberPaymentsPost(Payment apiPayment,
                                              String bookingNumber)
                                       throws ApiException

Add a payment to a booking Create a payment record associated with a booking

Parameters:

apiPayment -

bookingNumber -

Throws:

ApiException