com.bookeo.api.service

Class SubaccountsApi

java.lang.Object

com.bookeo.api.service.SubaccountsApi

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

Constructor Summary

Constructors

Constructor and Description
SubaccountsApi()
SubaccountsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
PortalSubaccountsList	subaccountsGet(Integer itemsPerPage, String pageNavigationToken, Integer pageNumber) List all subaccounts in the portal Retrieve all the webhooks for this api key
void	subaccountsSubaccountIdApikeysApiKeyDelete(String subaccountId, String apiKey) Delete the API Key for this application from a subaccount Uninstall this application from a subaccount.
void	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubaccountsApi

public SubaccountsApi()

SubaccountsApi

public SubaccountsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

subaccountsGet

public PortalSubaccountsList subaccountsGet(Integer itemsPerPage,
                                            String pageNavigationToken,
                                            Integer pageNumber)
                                     throws ApiException

List all subaccounts in the portal Retrieve all the webhooks for this api key

Parameters:

itemsPerPage - maximum: 300

pageNavigationToken -

pageNumber -

Returns:

PortalSubaccountsList

Throws:

ApiException

subaccountsSubaccountIdApikeysPost

public void subaccountsSubaccountIdApikeysPost(String subaccountId)
                                        throws ApiException

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. The application installed in the subaccount will be the same as this one, with the same permissions.\n If this application was already installed in the subaccount, its API key will be replaced by the one created in this call.

Parameters:

subaccountId - the id of the subaccount where to install this application

Throws:

ApiException

subaccountsSubaccountIdApikeysApiKeyDelete

public void subaccountsSubaccountIdApikeysApiKeyDelete(String subaccountId,
                                                       String apiKey)
                                                throws ApiException

Delete the API Key for this application from a subaccount Uninstall this application from a subaccount.

Parameters:

subaccountId -

apiKey -

Throws:

ApiException