@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen", date="2015-12-03T18:48:57.986-05:00") public class BookingsApi extends Object
| Constructor and Description |
|---|
BookingsApi() |
BookingsApi(ApiClient apiClient) |
| 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) |
public BookingsApi()
public BookingsApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
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
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 productincludeCanceled - if true, canceled bookings are included. If false, only bookings that are not canceled are includedexpandCustomer - 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: 100pageNavigationToken - pageNumber - ApiExceptionpublic void bookingsPost(Booking booking, String previousHoldId, Boolean notifyUsers, Boolean notifyCustomer, Boolean sendCustomerReminders, Boolean sendCustomerThankyou) throws ApiException
booking - previousHoldId - if specified, deletes the hold with the given idnotifyUsers - notifyCustomer - sendCustomerReminders - sendCustomerThankyou - ApiExceptionpublic Booking bookingsBookingNumberGet(String bookingNumber, Boolean expandCustomer, Boolean expandParticipants) throws ApiException
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)ApiExceptionpublic void bookingsBookingNumberPut(Booking booking, String bookingNumber, Boolean notifyUsers, Boolean notifyCustomer) throws ApiException
booking - bookingNumber - notifyUsers - notifyCustomer - ApiExceptionpublic void bookingsBookingNumberDelete(String bookingNumber, Boolean notifyUsers, Boolean notifyCustomer, Boolean applyCancellationPolicy, Boolean trackInCustomerHistory, Boolean cancelRemainingSeries, String reason) throws ApiException
bookingNumber - notifyUsers - if true, notification emails and SMS are sent to authorized usersnotifyCustomer - if true, a notification email is sent to the customerapplyCancellationPolicy - if true, the default cancellation policy is applied. This may cause a charge on the credit card on file, if a cancellation fee is duetrackInCustomerHistory - if true, the cancellation will be tracked in the customer's statscancelRemainingSeries - if true, and this booking is part of a recurring series, all following bookings will be cancelled as wellreason - an optional reason that explains why the booking was cancelledApiExceptionpublic Customer bookingsBookingNumberCustomerGet(String bookingNumber) throws ApiException
bookingNumber - ApiExceptionpublic PaymentsList bookingsBookingNumberPaymentsGet(String bookingNumber, Integer itemsPerPage, String pageNavigationToken, Integer pageNumber) throws ApiException
bookingNumber - itemsPerPage - .\nmaximum: 100pageNavigationToken - pageNumber - ApiExceptionpublic void bookingsBookingNumberPaymentsPost(Payment apiPayment, String bookingNumber) throws ApiException
apiPayment - bookingNumber - ApiExceptionCopyright © 2015. All rights reserved.