public class LabelsApi extends Object
| Constructor and Description |
|---|
LabelsApi() |
LabelsApi(ApiClient apiClient) |
| Modifier and Type | Method and Description |
|---|---|
Label |
createLabel(LabelParams body)
Create a new label
Create a new label for a specific user.
|
com.squareup.okhttp.Call |
createLabelAsync(LabelParams body,
ApiCallback<Label> callback)
Create a new label (asynchronously)
Create a new label for a specific user.
|
com.squareup.okhttp.Call |
createLabelCall(LabelParams body,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createLabel
|
ApiResponse<Label> |
createLabelWithHttpInfo(LabelParams body)
Create a new label
Create a new label for a specific user.
|
IdentifierList |
deleteAllLabels()
Delete all labels
Delete all labels of the user that is authorized by the access_token.
|
com.squareup.okhttp.Call |
deleteAllLabelsAsync(ApiCallback<IdentifierList> callback)
Delete all labels (asynchronously)
Delete all labels of the user that is authorized by the access_token.
|
com.squareup.okhttp.Call |
deleteAllLabelsCall(ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for deleteAllLabels
|
ApiResponse<IdentifierList> |
deleteAllLabelsWithHttpInfo()
Delete all labels
Delete all labels of the user that is authorized by the access_token.
|
void |
deleteLabel(Long id)
Delete a label
Delete a single label of the user that is authorized by the access_token.
|
com.squareup.okhttp.Call |
deleteLabelAsync(Long id,
ApiCallback<Void> callback)
Delete a label (asynchronously)
Delete a single label of the user that is authorized by the access_token.
|
com.squareup.okhttp.Call |
deleteLabelCall(Long id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for deleteLabel
|
ApiResponse<Void> |
deleteLabelWithHttpInfo(Long id)
Delete a label
Delete a single label of the user that is authorized by the access_token.
|
Label |
editLabel(Long id,
LabelParams body)
Edit a label
Change the name of a label of the user that is authorized by the access_token.
|
com.squareup.okhttp.Call |
editLabelAsync(Long id,
LabelParams body,
ApiCallback<Label> callback)
Edit a label (asynchronously)
Change the name of a label of the user that is authorized by the access_token.
|
com.squareup.okhttp.Call |
editLabelCall(Long id,
LabelParams body,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for editLabel
|
ApiResponse<Label> |
editLabelWithHttpInfo(Long id,
LabelParams body)
Edit a label
Change the name of a label of the user that is authorized by the access_token.
|
PageableLabelList |
getAndSearchAllLabels(List<Long> ids,
String search,
Integer page,
Integer perPage,
List<String> order)
Get and search all labels
Get labels of the user that is authorized by the access_token.
|
com.squareup.okhttp.Call |
getAndSearchAllLabelsAsync(List<Long> ids,
String search,
Integer page,
Integer perPage,
List<String> order,
ApiCallback<PageableLabelList> callback)
Get and search all labels (asynchronously)
Get labels of the user that is authorized by the access_token.
|
com.squareup.okhttp.Call |
getAndSearchAllLabelsCall(List<Long> ids,
String search,
Integer page,
Integer perPage,
List<String> order,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getAndSearchAllLabels
|
ApiResponse<PageableLabelList> |
getAndSearchAllLabelsWithHttpInfo(List<Long> ids,
String search,
Integer page,
Integer perPage,
List<String> order)
Get and search all labels
Get labels of the user that is authorized by the access_token.
|
ApiClient |
getApiClient() |
Label |
getLabel(Long id)
Get a label
Get a single label of the user that is authorized by the access_token.
|
com.squareup.okhttp.Call |
getLabelAsync(Long id,
ApiCallback<Label> callback)
Get a label (asynchronously)
Get a single label of the user that is authorized by the access_token.
|
com.squareup.okhttp.Call |
getLabelCall(Long id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getLabel
|
ApiResponse<Label> |
getLabelWithHttpInfo(Long id)
Get a label
Get a single label of the user that is authorized by the access_token.
|
LabelList |
getMultipleLabels(List<Long> ids)
Deprecated.
|
com.squareup.okhttp.Call |
getMultipleLabelsAsync(List<Long> ids,
ApiCallback<LabelList> callback)
Deprecated.
|
com.squareup.okhttp.Call |
getMultipleLabelsCall(List<Long> ids,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Deprecated.
|
ApiResponse<LabelList> |
getMultipleLabelsWithHttpInfo(List<Long> ids)
Deprecated.
|
void |
setApiClient(ApiClient apiClient) |
public LabelsApi()
public LabelsApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public com.squareup.okhttp.Call createLabelCall(LabelParams body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
body - Label's name (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic Label createLabel(LabelParams body) throws ApiException
body - Label's name (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<Label> createLabelWithHttpInfo(LabelParams body) throws ApiException
body - Label's name (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call createLabelAsync(LabelParams body, ApiCallback<Label> callback) throws ApiException
body - Label's name (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 objectpublic com.squareup.okhttp.Call deleteAllLabelsCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic IdentifierList deleteAllLabels() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<IdentifierList> deleteAllLabelsWithHttpInfo() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call deleteAllLabelsAsync(ApiCallback<IdentifierList> callback) throws ApiException
callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call deleteLabelCall(Long id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
id - Identifier of the label to delete (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic void deleteLabel(Long id) throws ApiException
id - Identifier of the label to delete (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<Void> deleteLabelWithHttpInfo(Long id) throws ApiException
id - Identifier of the label to delete (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call deleteLabelAsync(Long id, ApiCallback<Void> callback) throws ApiException
id - Identifier of the label to delete (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 objectpublic com.squareup.okhttp.Call editLabelCall(Long id, LabelParams body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
id - Label's identifier (required)body - Label's new name (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic Label editLabel(Long id, LabelParams body) throws ApiException
id - Label's identifier (required)body - Label's new name (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<Label> editLabelWithHttpInfo(Long id, LabelParams body) throws ApiException
id - Label's identifier (required)body - Label's new name (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call editLabelAsync(Long id, LabelParams body, ApiCallback<Label> callback) throws ApiException
id - Label's identifier (required)body - Label's new name (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 objectpublic com.squareup.okhttp.Call getAndSearchAllLabelsCall(List<Long> ids, String search, Integer page, Integer perPage, List<String> order, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
ids - A comma-separated list of label identifiers. If specified, then only labels whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (optional)search - If specified, then only those labels will be contained in the result whose 'name' contains the given search string (the matching works case-insensitive). If no labels contain the search string in their name, then the result will be an empty list. NOTE: If the given search string consists of several terms (separated by whitespace), then ALL of these terms must be contained in the name in order for a label to get included into the result. (optional)page - Result page that you want to retrieve (optional, default to 1)perPage - Maximum number of records per page. Can be at most 500. NOTE: Due to its validation and visualization, the swagger frontend might show very low performance, or even crashes, when a service responds with a lot of data. It is recommended to use a HTTP client like Postman or DHC instead of our swagger frontend for service calls with large page sizes. (optional, default to 20)order - Determines the order of the results. You can order the results by 'id' or 'name'. The default order for all services is 'id,asc'. Since both fields (id and name) are unique, ordering by multiple fields is pointless. The general format is: 'property[,asc|desc]', with 'asc' being the default value. (optional)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic PageableLabelList getAndSearchAllLabels(List<Long> ids, String search, Integer page, Integer perPage, List<String> order) throws ApiException
ids - A comma-separated list of label identifiers. If specified, then only labels whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (optional)search - If specified, then only those labels will be contained in the result whose 'name' contains the given search string (the matching works case-insensitive). If no labels contain the search string in their name, then the result will be an empty list. NOTE: If the given search string consists of several terms (separated by whitespace), then ALL of these terms must be contained in the name in order for a label to get included into the result. (optional)page - Result page that you want to retrieve (optional, default to 1)perPage - Maximum number of records per page. Can be at most 500. NOTE: Due to its validation and visualization, the swagger frontend might show very low performance, or even crashes, when a service responds with a lot of data. It is recommended to use a HTTP client like Postman or DHC instead of our swagger frontend for service calls with large page sizes. (optional, default to 20)order - Determines the order of the results. You can order the results by 'id' or 'name'. The default order for all services is 'id,asc'. Since both fields (id and name) are unique, ordering by multiple fields is pointless. The general format is: 'property[,asc|desc]', with 'asc' being the default value. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<PageableLabelList> getAndSearchAllLabelsWithHttpInfo(List<Long> ids, String search, Integer page, Integer perPage, List<String> order) throws ApiException
ids - A comma-separated list of label identifiers. If specified, then only labels whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (optional)search - If specified, then only those labels will be contained in the result whose 'name' contains the given search string (the matching works case-insensitive). If no labels contain the search string in their name, then the result will be an empty list. NOTE: If the given search string consists of several terms (separated by whitespace), then ALL of these terms must be contained in the name in order for a label to get included into the result. (optional)page - Result page that you want to retrieve (optional, default to 1)perPage - Maximum number of records per page. Can be at most 500. NOTE: Due to its validation and visualization, the swagger frontend might show very low performance, or even crashes, when a service responds with a lot of data. It is recommended to use a HTTP client like Postman or DHC instead of our swagger frontend for service calls with large page sizes. (optional, default to 20)order - Determines the order of the results. You can order the results by 'id' or 'name'. The default order for all services is 'id,asc'. Since both fields (id and name) are unique, ordering by multiple fields is pointless. The general format is: 'property[,asc|desc]', with 'asc' being the default value. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call getAndSearchAllLabelsAsync(List<Long> ids, String search, Integer page, Integer perPage, List<String> order, ApiCallback<PageableLabelList> callback) throws ApiException
ids - A comma-separated list of label identifiers. If specified, then only labels whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (optional)search - If specified, then only those labels will be contained in the result whose 'name' contains the given search string (the matching works case-insensitive). If no labels contain the search string in their name, then the result will be an empty list. NOTE: If the given search string consists of several terms (separated by whitespace), then ALL of these terms must be contained in the name in order for a label to get included into the result. (optional)page - Result page that you want to retrieve (optional, default to 1)perPage - Maximum number of records per page. Can be at most 500. NOTE: Due to its validation and visualization, the swagger frontend might show very low performance, or even crashes, when a service responds with a lot of data. It is recommended to use a HTTP client like Postman or DHC instead of our swagger frontend for service calls with large page sizes. (optional, default to 20)order - Determines the order of the results. You can order the results by 'id' or 'name'. The default order for all services is 'id,asc'. Since both fields (id and name) are unique, ordering by multiple fields is pointless. The general format is: 'property[,asc|desc]', with 'asc' being the default value. (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 objectpublic com.squareup.okhttp.Call getLabelCall(Long id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
id - Identifier of requested label (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic Label getLabel(Long id) throws ApiException
id - Identifier of requested label (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<Label> getLabelWithHttpInfo(Long id) throws ApiException
id - Identifier of requested label (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call getLabelAsync(Long id, ApiCallback<Label> callback) throws ApiException
id - Identifier of requested label (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@Deprecated public com.squareup.okhttp.Call getMultipleLabelsCall(List<Long> ids, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
ids - Comma-separated list of identifiers of requested labels (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body object@Deprecated public LabelList getMultipleLabels(List<Long> ids) throws ApiException
ids - Comma-separated list of identifiers of requested labels (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body@Deprecated public ApiResponse<LabelList> getMultipleLabelsWithHttpInfo(List<Long> ids) throws ApiException
ids - Comma-separated list of identifiers of requested labels (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body@Deprecated public com.squareup.okhttp.Call getMultipleLabelsAsync(List<Long> ids, ApiCallback<LabelList> callback) throws ApiException
ids - Comma-separated list of identifiers of requested labels (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 objectCopyright © 2018. All rights reserved.