public class ClientsApi
extends java.lang.Object
| Constructor and Description |
|---|
ClientsApi() |
ClientsApi(ApiClient apiClient) |
| 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) |
public ClientsApi()
public ClientsApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public int getHostIndex()
public void setHostIndex(int hostIndex)
public java.lang.String getCustomBaseUrl()
public void setCustomBaseUrl(java.lang.String customBaseUrl)
public okhttp3.Call createClientCall(java.lang.Integer companyId,
CreateClientRequest createClientRequest,
ApiCallback _callback)
throws ApiException
companyId - The ID of the company. (required)createClientRequest - The client to create (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | Example response | - |
public CreateClientResponse createClient(java.lang.Integer companyId, CreateClientRequest createClientRequest) throws ApiException
companyId - The ID of the company. (required)createClientRequest - The client to create (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the
response body| Status Code | Description | Response Headers |
| 200 | Example response | - |
public ApiResponse<CreateClientResponse> createClientWithHttpInfo(java.lang.Integer companyId, CreateClientRequest createClientRequest) throws ApiException
companyId - The ID of the company. (required)createClientRequest - The client to create (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the
response body| Status Code | Description | Response Headers |
| 200 | Example response | - |
public okhttp3.Call createClientAsync(java.lang.Integer companyId,
CreateClientRequest createClientRequest,
ApiCallback<CreateClientResponse> _callback)
throws ApiException
companyId - The ID of the company. (required)createClientRequest - The client to create (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | Example response | - |
public okhttp3.Call deleteClientCall(java.lang.Integer companyId,
java.lang.Integer clientId,
ApiCallback _callback)
throws ApiException
companyId - The ID of the company. (required)clientId - The ID of the client. (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | Entity Removed | - |
| 401 | Unauthorized | - |
| 404 | Not Found | - |
public void deleteClient(java.lang.Integer companyId,
java.lang.Integer clientId)
throws ApiException
companyId - The ID of the company. (required)clientId - The ID of the client. (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the
response body| Status Code | Description | Response Headers |
| 200 | Entity Removed | - |
| 401 | Unauthorized | - |
| 404 | Not Found | - |
public ApiResponse<java.lang.Void> deleteClientWithHttpInfo(java.lang.Integer companyId, java.lang.Integer clientId) throws ApiException
companyId - The ID of the company. (required)clientId - The ID of the client. (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the
response body| Status Code | Description | Response Headers |
| 200 | Entity Removed | - |
| 401 | Unauthorized | - |
| 404 | Not Found | - |
public okhttp3.Call deleteClientAsync(java.lang.Integer companyId,
java.lang.Integer clientId,
ApiCallback<java.lang.Void> _callback)
throws ApiException
companyId - The ID of the company. (required)clientId - The ID of the client. (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | Entity Removed | - |
| 401 | Unauthorized | - |
| 404 | Not Found | - |
public okhttp3.Call getClientCall(java.lang.Integer companyId,
java.lang.Integer clientId,
java.lang.String fields,
java.lang.String fieldset,
ApiCallback _callback)
throws ApiException
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 progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | Client Details. | - |
| 401 | Unauthorized | - |
| 404 | Not Found | - |
public GetClientResponse getClient(java.lang.Integer companyId, java.lang.Integer clientId, java.lang.String fields, java.lang.String fieldset) throws ApiException
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the
response body| Status Code | Description | Response Headers |
| 200 | Client Details. | - |
| 401 | Unauthorized | - |
| 404 | Not Found | - |
public ApiResponse<GetClientResponse> getClientWithHttpInfo(java.lang.Integer companyId, java.lang.Integer clientId, java.lang.String fields, java.lang.String fieldset) throws ApiException
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the
response body| Status Code | Description | Response Headers |
| 200 | Client Details. | - |
| 401 | Unauthorized | - |
| 404 | Not Found | - |
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
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 finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | Client Details. | - |
| 401 | Unauthorized | - |
| 404 | Not Found | - |
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
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 progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | Example response | - |
| 401 | Unauthorized | - |
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
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the
response body| Status Code | Description | Response Headers |
| 200 | Example response | - |
| 401 | Unauthorized | - |
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
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the
response body| Status Code | Description | Response Headers |
| 200 | Example response | - |
| 401 | Unauthorized | - |
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
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 finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | Example response | - |
| 401 | Unauthorized | - |
public okhttp3.Call modifyClientCall(java.lang.Integer companyId,
java.lang.Integer clientId,
ModifyClientRequest modifyClientRequest,
ApiCallback _callback)
throws ApiException
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 progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | Client modified. | - |
| 401 | Unauthorized | - |
| 404 | Not Found | - |
public ModifyClientResponse modifyClient(java.lang.Integer companyId, java.lang.Integer clientId, ModifyClientRequest modifyClientRequest) throws ApiException
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the
response body| Status Code | Description | Response Headers |
| 200 | Client modified. | - |
| 401 | Unauthorized | - |
| 404 | Not Found | - |
public ApiResponse<ModifyClientResponse> modifyClientWithHttpInfo(java.lang.Integer companyId, java.lang.Integer clientId, ModifyClientRequest modifyClientRequest) throws ApiException
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the
response body| Status Code | Description | Response Headers |
| 200 | Client modified. | - |
| 401 | Unauthorized | - |
| 404 | Not Found | - |
public okhttp3.Call modifyClientAsync(java.lang.Integer companyId,
java.lang.Integer clientId,
ModifyClientRequest modifyClientRequest,
ApiCallback<ModifyClientResponse> _callback)
throws ApiException
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 finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | Client modified. | - |
| 401 | Unauthorized | - |
| 404 | Not Found | - |