com.bookeo.api.service

Class SettingsApi

java.lang.Object

com.bookeo.api.service.SettingsApi

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

Constructor Summary

Constructors

Constructor and Description
SettingsApi()
SettingsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
ApiKeyInfo	settingsApikeyinfoGet() Get information about your own API Key
Business	settingsBusinessGet() Get information, location and contact details about the business
LanguagesList	settingsLanguagesGet() Retrieve all supported languages
PeopleCategoryList	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	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	settingsResourcesGet(Integer itemsPerPage, String pageNavigationToken, Integer pageNumber) Retrieve all available resources

Methods inherited from class java.lang.Object

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

Constructor Detail

SettingsApi

public SettingsApi()

SettingsApi

public SettingsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

settingsApikeyinfoGet

public ApiKeyInfo settingsApikeyinfoGet()
                                 throws ApiException

Get information about your own API Key

Returns:

ApiKeyInfo

Throws:

ApiException

settingsBusinessGet

public Business settingsBusinessGet()
                             throws ApiException

Get information, location and contact details about the business

Returns:

Business

Throws:

ApiException

settingsLanguagesGet

public LanguagesList settingsLanguagesGet()
                                   throws ApiException

Retrieve all supported languages

Returns:

LanguagesList

Throws:

ApiException

settingsPeoplecategoriesGet

public PeopleCategoryList settingsPeoplecategoriesGet()
                                               throws ApiException

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\", ...)

Returns:

PeopleCategoryList

Throws:

ApiException

settingsProductsGet

public ProductList settingsProductsGet(String type,
                                       Integer itemsPerPage,
                                       String pageNavigationToken,
                                       Integer pageNumber)
                                throws ApiException

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. Ex a group tour, a class, a workshop\n - fixedCourse are fixed products that are defined as a course, i.e. comprise of a series of dates\n - flexibleTime are products that describe private appointments, i.e. when one booking uses one resource (teacher, consultant, etc)\n\n Although Bookeo applies a minimum amount of caching, it is recommended to cache these results for 10-15 minutes to improve the performance of your application, as product settings change rarely.

Parameters:

type - if not specified, get all products

itemsPerPage - .\nmaximum: 100

pageNavigationToken -

pageNumber -

Returns:

ProductList

Throws:

ApiException

settingsResourcesGet

public ResourceTypesList settingsResourcesGet(Integer itemsPerPage,
                                              String pageNavigationToken,
                                              Integer pageNumber)
                                       throws ApiException

Retrieve all available resources

Parameters:

itemsPerPage - maximum: 100

pageNavigationToken -

pageNumber -

Returns:

ResourceTypesList

Throws:

ApiException