com.bookeo.api.service

Class CustomersApi

java.lang.Object

com.bookeo.api.service.CustomersApi

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

Constructor Summary

Constructors

Constructor and Description
CustomersApi()
CustomersApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	customersCustomeridLinkedpeopleIdDelete(String customerid, String id) Delete a person linked to a customer
CustomersList	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	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	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	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	customersIdGet(String id) Retrieve a customer Retrieve a customer by its id
LinkedPersonList	customersIdLinkedpeopleGet(String id, Integer itemsPerPage, String pageNavigationToken, Integer pageNumber) Get the people linked to a customer
void	customersIdPut(Customer customer, String id) Update an existing customer
void	customersPost(Customer customer) Create a new customer
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

CustomersApi

public CustomersApi()

CustomersApi

public CustomersApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

customersGet

public CustomersList customersGet(Boolean currentMembers,
                                  Boolean currentNonMembers,
                                  Date createdSince,
                                  String searchField,
                                  String searchText,
                                  Integer itemsPerPage,
                                  String pageNavigationToken,
                                  Integer pageNumber)
                           throws ApiException

Retrieve customers Get a list of customers.

Parameters:

currentMembers - if true, include customers that are current members. this is the default

currentNonMembers - if true, include customers that are not current members. this is the default

createdSince - if present, only include customers created since the given time

searchField - a field on which to apply the search filter. Used only if searchText is specified

searchText - the text to search for. If not present, all customers are returned

itemsPerPage - number of items per page.\nmaximum: 100

pageNavigationToken - if present, continues navigation after a previous call. pageNavigationToken is included in the response of the first call, if there are more results than itemsPerPage

pageNumber -

Returns:

CustomersList

Throws:

ApiException

customersPost

public void customersPost(Customer customer)
                   throws ApiException

Create a new customer

Parameters:

customer -

Throws:

ApiException

customersCustomeridLinkedpeopleIdDelete

public void customersCustomeridLinkedpeopleIdDelete(String customerid,
                                                    String id)
                                             throws ApiException

Delete a person linked to a customer

Parameters:

customerid -

id -

Throws:

ApiException

customersIdGet

public Customer customersIdGet(String id)
                        throws ApiException

Retrieve a customer Retrieve a customer by its id

Parameters:

id -

Returns:

Customer

Throws:

ApiException

customersIdPut

public void customersIdPut(Customer customer,
                           String id)
                    throws ApiException

Update an existing customer

Parameters:

customer -

id -

Throws:

ApiException

customersIdDelete

public void customersIdDelete(String id)
                       throws ApiException

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.

Parameters:

id -

Throws:

ApiException

customersIdAuthenticateGet

public void customersIdAuthenticateGet(String id,
                                       String password)
                                throws ApiException

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. due to duplicate importing or manual record creation.

Parameters:

id -

password - remember to use URL encoding

Throws:

ApiException

customersIdBookingsGet

public BookingsList customersIdBookingsGet(String id,
                                           Date beginDate,
                                           Date endDate,
                                           Boolean expandParticipants,
                                           Integer itemsPerPage,
                                           String pageNavigationToken,
                                           Integer pageNumber)
                                    throws ApiException

Retrieve a customer's bookings Get a customer's bookings.

Parameters:

id -

beginDate - if specified, only bookings on or after this date will be included

endDate - if specified, only bookings on or before this date will be included

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

itemsPerPage - .\nmaximum: 100

pageNavigationToken -

pageNumber -

Returns:

BookingsList

Throws:

ApiException

customersIdLinkedpeopleGet

public LinkedPersonList customersIdLinkedpeopleGet(String id,
                                                   Integer itemsPerPage,
                                                   String pageNavigationToken,
                                                   Integer pageNumber)
                                            throws ApiException

Get the people linked to a customer

Parameters:

id -

itemsPerPage - maximum: 100

pageNavigationToken -

pageNumber -

Returns:

LinkedPersonList

Throws:

ApiException