it.fattureincloud.sdk.api

Class ClientsApi

java.lang.Object

it.fattureincloud.sdk.api.ClientsApi

public class ClientsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ClientsApi()
ClientsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CreateClientResponse	createClient(java.lang.Integer companyId, CreateClientRequest createClientRequest) Create Client Creates a new client.
okhttp3.Call	createClientAsync(java.lang.Integer companyId, CreateClientRequest createClientRequest, ApiCallback<CreateClientResponse> _callback) Create Client (asynchronously) Creates a new client.
okhttp3.Call	createClientCall(java.lang.Integer companyId, CreateClientRequest createClientRequest, ApiCallback _callback) Build call for createClient
ApiResponse<CreateClientResponse>	createClientWithHttpInfo(java.lang.Integer companyId, CreateClientRequest createClientRequest) Create Client Creates a new client.
void	deleteClient(java.lang.Integer companyId, java.lang.Integer clientId) Delete Client Deletes the specified client.
okhttp3.Call	deleteClientAsync(java.lang.Integer companyId, java.lang.Integer clientId, ApiCallback<java.lang.Void> _callback) Delete Client (asynchronously) Deletes the specified client.
okhttp3.Call	deleteClientCall(java.lang.Integer companyId, java.lang.Integer clientId, ApiCallback _callback) Build call for deleteClient
ApiResponse<java.lang.Void>	deleteClientWithHttpInfo(java.lang.Integer companyId, java.lang.Integer clientId) Delete Client Deletes the specified client.
ApiClient	getApiClient()
GetClientResponse	getClient(java.lang.Integer companyId, java.lang.Integer clientId, java.lang.String fields, java.lang.String fieldset) Get Client Gets the specified client.
okhttp3.Call	getClientAsync(java.lang.Integer companyId, java.lang.Integer clientId, java.lang.String fields, java.lang.String fieldset, ApiCallback<GetClientResponse> _callback) Get Client (asynchronously) Gets the specified client.
okhttp3.Call	getClientCall(java.lang.Integer companyId, java.lang.Integer clientId, java.lang.String fields, java.lang.String fieldset, ApiCallback _callback) Build call for getClient
ApiResponse<GetClientResponse>	getClientWithHttpInfo(java.lang.Integer companyId, java.lang.Integer clientId, java.lang.String fields, java.lang.String fieldset) Get Client Gets the specified client.
java.lang.String	getCustomBaseUrl()
int	getHostIndex()
ListClientsResponse	listClients(java.lang.Integer companyId, java.lang.String fields, java.lang.String fieldset, java.lang.String sort, java.lang.Integer page, java.lang.Integer perPage, java.lang.String q) List Clients Lists the clients.
okhttp3.Call	listClientsAsync(java.lang.Integer companyId, java.lang.String fields, java.lang.String fieldset, java.lang.String sort, java.lang.Integer page, java.lang.Integer perPage, java.lang.String q, ApiCallback<ListClientsResponse> _callback) List Clients (asynchronously) Lists the clients.
okhttp3.Call	listClientsCall(java.lang.Integer companyId, java.lang.String fields, java.lang.String fieldset, java.lang.String sort, java.lang.Integer page, java.lang.Integer perPage, java.lang.String q, ApiCallback _callback) Build call for listClients
ApiResponse<ListClientsResponse>	listClientsWithHttpInfo(java.lang.Integer companyId, java.lang.String fields, java.lang.String fieldset, java.lang.String sort, java.lang.Integer page, java.lang.Integer perPage, java.lang.String q) List Clients Lists the clients.
ModifyClientResponse	modifyClient(java.lang.Integer companyId, java.lang.Integer clientId, ModifyClientRequest modifyClientRequest) Modify Client Modifies the specified client.
okhttp3.Call	modifyClientAsync(java.lang.Integer companyId, java.lang.Integer clientId, ModifyClientRequest modifyClientRequest, ApiCallback<ModifyClientResponse> _callback) Modify Client (asynchronously) Modifies the specified client.
okhttp3.Call	modifyClientCall(java.lang.Integer companyId, java.lang.Integer clientId, ModifyClientRequest modifyClientRequest, ApiCallback _callback) Build call for modifyClient
ApiResponse<ModifyClientResponse>	modifyClientWithHttpInfo(java.lang.Integer companyId, java.lang.Integer clientId, ModifyClientRequest modifyClientRequest) Modify Client Modifies the specified client.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(java.lang.String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientsApi

public ClientsApi()

ClientsApi

public ClientsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public java.lang.String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(java.lang.String customBaseUrl)

createClientCall

public okhttp3.Call createClientCall(java.lang.Integer companyId,
                                     CreateClientRequest createClientRequest,
                                     ApiCallback _callback)
                              throws ApiException

Build call for createClient

Parameters:

companyId - The ID of the company. (required)

createClientRequest - The client to create (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Example response	-

createClient

public CreateClientResponse createClient(java.lang.Integer companyId,
                                         CreateClientRequest createClientRequest)
                                  throws ApiException

Create Client Creates a new client.

Parameters:

companyId - The ID of the company. (required)

createClientRequest - The client to create (optional)

Returns:

CreateClientResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Example response	-

createClientWithHttpInfo

public ApiResponse<CreateClientResponse> createClientWithHttpInfo(java.lang.Integer companyId,
                                                                  CreateClientRequest createClientRequest)
                                                           throws ApiException

Create Client Creates a new client.

Parameters:

companyId - The ID of the company. (required)

createClientRequest - The client to create (optional)

Returns:

ApiResponse<CreateClientResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Example response	-

createClientAsync

public okhttp3.Call createClientAsync(java.lang.Integer companyId,
                                      CreateClientRequest createClientRequest,
                                      ApiCallback<CreateClientResponse> _callback)
                               throws ApiException

Create Client (asynchronously) Creates a new client.

Parameters:

companyId - The ID of the company. (required)

createClientRequest - The client to create (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Example response	-

deleteClientCall

public okhttp3.Call deleteClientCall(java.lang.Integer companyId,
                                     java.lang.Integer clientId,
                                     ApiCallback _callback)
                              throws ApiException

Build call for deleteClient

Parameters:

companyId - The ID of the company. (required)

clientId - The ID of the client. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Entity Removed	-
401	Unauthorized	-
404	Not Found	-

deleteClient

public void deleteClient(java.lang.Integer companyId,
                         java.lang.Integer clientId)
                  throws ApiException

Delete Client Deletes the specified client.

Parameters:

companyId - The ID of the company. (required)

clientId - The ID of the client. (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Entity Removed	-
401	Unauthorized	-
404	Not Found	-

deleteClientWithHttpInfo

public ApiResponse<java.lang.Void> deleteClientWithHttpInfo(java.lang.Integer companyId,
                                                            java.lang.Integer clientId)
                                                     throws ApiException

Delete Client Deletes the specified client.

Parameters:

companyId - The ID of the company. (required)

clientId - The ID of the client. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Entity Removed	-
401	Unauthorized	-
404	Not Found	-

deleteClientAsync

public okhttp3.Call deleteClientAsync(java.lang.Integer companyId,
                                      java.lang.Integer clientId,
                                      ApiCallback<java.lang.Void> _callback)
                               throws ApiException

Delete Client (asynchronously) Deletes the specified client.

Parameters:

companyId - The ID of the company. (required)

clientId - The ID of the client. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Entity Removed	-
401	Unauthorized	-
404	Not Found	-

getClientCall

public okhttp3.Call getClientCall(java.lang.Integer companyId,
                                  java.lang.Integer clientId,
                                  java.lang.String fields,
                                  java.lang.String fieldset,
                                  ApiCallback _callback)
                           throws ApiException

Build call for getClient

Parameters:

companyId - The ID of the company. (required)

clientId - The ID of the client. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Client Details.	-
401	Unauthorized	-
404	Not Found	-

getClient

public GetClientResponse getClient(java.lang.Integer companyId,
                                   java.lang.Integer clientId,
                                   java.lang.String fields,
                                   java.lang.String fieldset)
                            throws ApiException

Get Client Gets the specified client.

Parameters:

companyId - The ID of the company. (required)

clientId - The ID of the client. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

Returns:

GetClientResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Client Details.	-
401	Unauthorized	-
404	Not Found	-

getClientWithHttpInfo

public ApiResponse<GetClientResponse> getClientWithHttpInfo(java.lang.Integer companyId,
                                                            java.lang.Integer clientId,
                                                            java.lang.String fields,
                                                            java.lang.String fieldset)
                                                     throws ApiException

Get Client Gets the specified client.

Parameters:

companyId - The ID of the company. (required)

clientId - The ID of the client. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

Returns:

ApiResponse<GetClientResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Client Details.	-
401	Unauthorized	-
404	Not Found	-

getClientAsync

public okhttp3.Call getClientAsync(java.lang.Integer companyId,
                                   java.lang.Integer clientId,
                                   java.lang.String fields,
                                   java.lang.String fieldset,
                                   ApiCallback<GetClientResponse> _callback)
                            throws ApiException

Get Client (asynchronously) Gets the specified client.

Parameters:

companyId - The ID of the company. (required)

clientId - The ID of the client. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Client Details.	-
401	Unauthorized	-
404	Not Found	-

listClientsCall

public okhttp3.Call listClientsCall(java.lang.Integer companyId,
                                    java.lang.String fields,
                                    java.lang.String fieldset,
                                    java.lang.String sort,
                                    java.lang.Integer page,
                                    java.lang.Integer perPage,
                                    java.lang.String q,
                                    ApiCallback _callback)
                             throws ApiException

Build call for listClients

Parameters:

companyId - The ID of the company. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

sort - List of comma-separated fields for result sorting (minus for desc sorting). (optional)

page - The page to retrieve. (optional, default to 1)

perPage - The size of the page. (optional, default to 5)

q - Query for filtering the results. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Example response	-
401	Unauthorized	-

listClients

public ListClientsResponse listClients(java.lang.Integer companyId,
                                       java.lang.String fields,
                                       java.lang.String fieldset,
                                       java.lang.String sort,
                                       java.lang.Integer page,
                                       java.lang.Integer perPage,
                                       java.lang.String q)
                                throws ApiException

List Clients Lists the clients.

Parameters:

companyId - The ID of the company. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

sort - List of comma-separated fields for result sorting (minus for desc sorting). (optional)

page - The page to retrieve. (optional, default to 1)

perPage - The size of the page. (optional, default to 5)

q - Query for filtering the results. (optional)

Returns:

ListClientsResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Example response	-
401	Unauthorized	-

listClientsWithHttpInfo

public ApiResponse<ListClientsResponse> listClientsWithHttpInfo(java.lang.Integer companyId,
                                                                java.lang.String fields,
                                                                java.lang.String fieldset,
                                                                java.lang.String sort,
                                                                java.lang.Integer page,
                                                                java.lang.Integer perPage,
                                                                java.lang.String q)
                                                         throws ApiException

List Clients Lists the clients.

Parameters:

companyId - The ID of the company. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

sort - List of comma-separated fields for result sorting (minus for desc sorting). (optional)

page - The page to retrieve. (optional, default to 1)

perPage - The size of the page. (optional, default to 5)

q - Query for filtering the results. (optional)

Returns:

ApiResponse<ListClientsResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Example response	-
401	Unauthorized	-

listClientsAsync

public okhttp3.Call listClientsAsync(java.lang.Integer companyId,
                                     java.lang.String fields,
                                     java.lang.String fieldset,
                                     java.lang.String sort,
                                     java.lang.Integer page,
                                     java.lang.Integer perPage,
                                     java.lang.String q,
                                     ApiCallback<ListClientsResponse> _callback)
                              throws ApiException

List Clients (asynchronously) Lists the clients.

Parameters:

companyId - The ID of the company. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

sort - List of comma-separated fields for result sorting (minus for desc sorting). (optional)

page - The page to retrieve. (optional, default to 1)

perPage - The size of the page. (optional, default to 5)

q - Query for filtering the results. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Example response	-
401	Unauthorized	-

modifyClientCall

public okhttp3.Call modifyClientCall(java.lang.Integer companyId,
                                     java.lang.Integer clientId,
                                     ModifyClientRequest modifyClientRequest,
                                     ApiCallback _callback)
                              throws ApiException

Build call for modifyClient

Parameters:

companyId - The ID of the company. (required)

clientId - The ID of the client. (required)

modifyClientRequest - The modified Client. First level parameters are managed in delta mode. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Client modified.	-
401	Unauthorized	-
404	Not Found	-

modifyClient

public ModifyClientResponse modifyClient(java.lang.Integer companyId,
                                         java.lang.Integer clientId,
                                         ModifyClientRequest modifyClientRequest)
                                  throws ApiException

Modify Client Modifies the specified client.

Parameters:

companyId - The ID of the company. (required)

clientId - The ID of the client. (required)

modifyClientRequest - The modified Client. First level parameters are managed in delta mode. (optional)

Returns:

ModifyClientResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Client modified.	-
401	Unauthorized	-
404	Not Found	-

modifyClientWithHttpInfo

public ApiResponse<ModifyClientResponse> modifyClientWithHttpInfo(java.lang.Integer companyId,
                                                                  java.lang.Integer clientId,
                                                                  ModifyClientRequest modifyClientRequest)
                                                           throws ApiException

Modify Client Modifies the specified client.

Parameters:

companyId - The ID of the company. (required)

clientId - The ID of the client. (required)

modifyClientRequest - The modified Client. First level parameters are managed in delta mode. (optional)

Returns:

ApiResponse<ModifyClientResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Client modified.	-
401	Unauthorized	-
404	Not Found	-

modifyClientAsync

public okhttp3.Call modifyClientAsync(java.lang.Integer companyId,
                                      java.lang.Integer clientId,
                                      ModifyClientRequest modifyClientRequest,
                                      ApiCallback<ModifyClientResponse> _callback)
                               throws ApiException

Modify Client (asynchronously) Modifies the specified client.

Parameters:

companyId - The ID of the company. (required)

clientId - The ID of the client. (required)

modifyClientRequest - The modified Client. First level parameters are managed in delta mode. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Client modified.	-
401	Unauthorized	-
404	Not Found	-