| Package | Description |
|---|---|
| com.bookeo.api.request | |
| com.bookeo.api.service |
| Modifier and Type | Method and Description |
|---|---|
<T> T |
ApiClient.deserialize(javax.ws.rs.core.Response response,
TypeRef returnType)
Deserialize response body to Java object according to the Content-Type.
|
<T> T |
JSON.deserialize(String body,
TypeRef returnType)
Deserialize the given JSON string to Java object.
|
<T> T |
ApiClient.invokeAPI(String path,
String method,
List<Pair> queryParams,
Object body,
Map<String,String> headerParams,
Map<String,Object> formParams,
String accept,
String contentType,
String[] authNames,
TypeRef returnType)
Invoke API by sending HTTP request with the given options.
|
String |
JSON.serialize(Object obj)
Serialize the given Java object into JSON string.
|
javax.ws.rs.client.Entity<String> |
ApiClient.serialize(Object obj,
String contentType)
Serialize the given Java object into string entity according the given
Content-Type (only JSON is supported for now).
|
| Modifier and Type | Method and Description |
|---|---|
MatchingSlotList |
AvailabilityApi.availabilityMatchingslotsPageNavigationTokenGet(String pageNavigationToken,
Integer pageNumber)
Navigate results of a matching slots search
|
void |
AvailabilityApi.availabilityMatchingslotsPost(MatchingSlotsSearchParameters search,
Integer itemsPerPage)
Find available slots matching given search parameters
Create a search for available slots that match the given search parameters.\n Note that there are two different searches possible, /availability/slots and /availability/matchingslots (this endpoint).\n The former simply shows the number of available seats for each available slot.
|
SlotList |
AvailabilityApi.availabilitySlotsGet(String productId,
Date startTime,
Date endTime,
Integer itemsPerPage,
String pageNavigationToken,
Integer pageNumber)
Get information about the availability of a product
Performs a basic search to find available slots and number of seats in each.\n Note that there are two different searches possible, /availability/slots (this endpoint) and /availability/matchingslots .\n The former simply shows the number of available seats for each available slot.
|
Customer |
BookingsApi.bookingsBookingNumberCustomerGet(String bookingNumber)
Retrieve the customer associated with a booking
Retrieve the customer associated with a booking.
|
void |
BookingsApi.bookingsBookingNumberDelete(String bookingNumber,
Boolean notifyUsers,
Boolean notifyCustomer,
Boolean applyCancellationPolicy,
Boolean trackInCustomerHistory,
Boolean cancelRemainingSeries,
String reason)
Cancel a booking
Cancel a booking.
|
Booking |
BookingsApi.bookingsBookingNumberGet(String bookingNumber,
Boolean expandCustomer,
Boolean expandParticipants)
Retrieve a booking
Retrieve a booking by its booking number
|
PaymentsList |
BookingsApi.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 |
BookingsApi.bookingsBookingNumberPaymentsPost(Payment apiPayment,
String bookingNumber)
Add a payment to a booking
Create a payment record associated with a booking
|
void |
BookingsApi.bookingsBookingNumberPut(Booking booking,
String bookingNumber,
Boolean notifyUsers,
Boolean notifyCustomer)
Update an existing booking
|
BookingsList |
BookingsApi.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 |
BookingsApi.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.
|
void |
CustomersApi.customersCustomeridLinkedpeopleIdDelete(String customerid,
String id)
Delete a person linked to a customer
|
CustomersList |
CustomersApi.customersGet(Boolean currentMembers,
Boolean currentNonMembers,
Date createdSince,
String searchField,
String searchText,
Integer itemsPerPage,
String pageNavigationToken,
Integer pageNumber)
Retrieve customers
Get a list of customers.
|
void |
CustomersApi.customersIdAuthenticateGet(String id,
String password)
Check a customer's password
The customer's email address is the \"username\" used by Bookeo to authenticate customers.\n So to authenticate a customer your application would typically use GET /customers to search for customers with a given email address, and then GET /customers/{id}/authenticate to authenticate.\n Remember that there may be duplicate customer records with the same email address, ex.
|
BookingsList |
CustomersApi.customersIdBookingsGet(String id,
Date beginDate,
Date endDate,
Boolean expandParticipants,
Integer itemsPerPage,
String pageNavigationToken,
Integer pageNumber)
Retrieve a customer's bookings
Get a customer's bookings.
|
void |
CustomersApi.customersIdDelete(String id)
Delete a customer
Delete a customer.\n Please note it is not possible to delete customers that have bookings in the future, and that are not cancelled.\n If your application needs to delete a customer with future bookings, make sure to cancel all future bookings for that customer first.
|
Customer |
CustomersApi.customersIdGet(String id)
Retrieve a customer
Retrieve a customer by its id
|
LinkedPersonList |
CustomersApi.customersIdLinkedpeopleGet(String id,
Integer itemsPerPage,
String pageNavigationToken,
Integer pageNumber)
Get the people linked to a customer
|
void |
CustomersApi.customersIdPut(Customer customer,
String id)
Update an existing customer
|
void |
CustomersApi.customersPost(Customer customer)
Create a new customer
|
void |
HoldsApi.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 |
HoldsApi.holdsIdGet(String id)
Retrieve a hold previously generated
|
void |
HoldsApi.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.
|
PaymentsList |
PaymentsApi.paymentsGet(String paymentMethod,
String paymentMethodOther,
Date startTime,
Date endTime,
Integer itemsPerPage,
String pageNavigationToken,
Integer pageNumber)
Get a list of payments received
|
Payment |
PaymentsApi.paymentsIdGet(String id)
Retrieve a specific payment
|
ResourceBlocksList |
ResourceBlocksApi.resourceblocksGet(Date startTime,
Date endTime,
Date lastUpdatedStartTime,
Date lastUpdatedEndTime,
String resourceId,
Integer itemsPerPage,
String pageNavigationToken,
Integer pageNumber)
Retrieve resource blocks
Retrieve existing resource blocks\n The result is limited by the permissions of the apiKey.\n <p/>\n It is possible to filter by time blocked and/or time of the last change.\n To filter by time blocked, 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 |
ResourceBlocksApi.resourceblocksIdDelete(String id)
Delete a block
|
ResourceBlock |
ResourceBlocksApi.resourceblocksIdGet(String id)
Retrieve a block
Retrieve a block by its id
|
void |
ResourceBlocksApi.resourceblocksIdPut(ResourceBlock block,
String id)
Update an existing block
A resource block must be for at least one resource, but it can block more than one.\n When setting the resources in the block, only the id is required.
|
void |
ResourceBlocksApi.resourceblocksPost(ResourceBlock block)
Create a new resource block
\"blocks\" time for one or more resources, so that they're not available for booking.\n A resource block must be for at least one resource, but it can block more than one.\n When setting the resources in the block, only the id is required.
|
SeatBlocksList |
SeatBlocksApi.seatblocksGet(Date startTime,
Date endTime,
Date lastUpdatedStartTime,
Date lastUpdatedEndTime,
String productId,
Integer itemsPerPage,
String pageNavigationToken,
Integer pageNumber)
Retrieve seat blocks
Retrieve existing seat blocks\n The result is limited by the permissions of the apiKey.\n <p/>\n It is possible to filter by time blocked and/or time of the last change.\n To filter by time blocked, 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 |
SeatBlocksApi.seatblocksIdDelete(String id)
Delete a block
|
ResourceBlock |
SeatBlocksApi.seatblocksIdGet(String id)
Retrieve a block
Retrieve a block by its id
|
void |
SeatBlocksApi.seatblocksIdPut(ResourceBlock block,
String id)
Update an existing block
Updates an existing seat block
|
void |
SeatBlocksApi.seatblocksPost(ResourceBlock block)
Create a new seat block
\"blocks\" a given number of seats, so that they're not available for booking.
|
ApiKeyInfo |
SettingsApi.settingsApikeyinfoGet()
Get information about your own API Key
|
Business |
SettingsApi.settingsBusinessGet()
Get information, location and contact details about the business
|
LanguagesList |
SettingsApi.settingsLanguagesGet()
Retrieve all supported languages
|
PeopleCategoryList |
SettingsApi.settingsPeoplecategoriesGet()
Retrieve all supported people categories
Retrieve the people categories supported by this account.\n This can include the default ones (\"Adults\",\"Children\",\"Infants\") and also custom ones defined by the account (\"Students\", ...)
|
ProductList |
SettingsApi.settingsProductsGet(String type,
Integer itemsPerPage,
String pageNavigationToken,
Integer pageNumber)
Get information about the products offered
Get information about all the products (things that can be booked) offered.\n 3 types of product are available:\n - fixed are products with a fixed schedule and a given number of seats.
|
ResourceTypesList |
SettingsApi.settingsResourcesGet(Integer itemsPerPage,
String pageNavigationToken,
Integer pageNumber)
Retrieve all available resources
|
PortalSubaccountsList |
SubaccountsApi.subaccountsGet(Integer itemsPerPage,
String pageNavigationToken,
Integer pageNumber)
List all subaccounts in the portal
Retrieve all the webhooks for this api key
|
void |
SubaccountsApi.subaccountsSubaccountIdApikeysApiKeyDelete(String subaccountId,
String apiKey)
Delete the API Key for this application from a subaccount
Uninstall this application from a subaccount.
|
void |
SubaccountsApi.subaccountsSubaccountIdApikeysPost(String subaccountId)
Create a new API Key for this application to access a subaccount
Install this application in a subaccount.\n Note that the API key used in this call must be that of the portal manager account.
|
WebhooksList |
WebhooksApi.webhooksGet()
List all webhooks
Retrieve all the webhooks for this api key
|
void |
WebhooksApi.webhooksPost(Webhook webhook)
Create a new webhook
Note that if an existing webhook for the same domain and type was already set for this api key, it will be automatically replaced by this new webhook.\n In other words, there can be only one webhook for each combination of domain and type, for an API key.\n So to upgrade an existing webhook URL, simply create a new one with the same domain and type, but a different URL.\n\n For webhook with domain \"bookings\" and type \"deleted\", the notification will be sent whether the booking is canceled or completely deleted.\n Users can delete bookings by, for example, deleting their associated customer.\n Also note that these \"bookings\" \"deleted\" notifications are sent even for bookings in the past.
|
void |
WebhooksApi.webhooksWebhookIdDelete(String webhookId)
Delete a webhook
Delete a webhook
|
Webhook |
WebhooksApi.webhooksWebhookIdGet(String webhookId)
Retrieve a webhook
Retrieve a webhook
|
Copyright © 2015. All rights reserved.