Package io.voucherify.client.api
Class AsyncActionsApi
java.lang.Object
io.voucherify.client.api.AsyncActionsApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetAsyncAction(String asyncActionId) Get Async Action Check the result of a scheduled asynchronous operation.okhttp3.CallgetAsyncActionAsync(String asyncActionId, ApiCallback<AsyncActionGetResponseBody> _callback) Get Async Action (asynchronously) Check the result of a scheduled asynchronous operation.okhttp3.CallgetAsyncActionCall(String asyncActionId, ApiCallback _callback) Build call for getAsyncActiongetAsyncActionWithHttpInfo(String asyncActionId) Get Async Action Check the result of a scheduled asynchronous operation.intlistAsyncActions(Integer limit, OffsetDateTime endDate) List Async Actions Track asynchronous operations scheduled in your project.okhttp3.CalllistAsyncActionsAsync(Integer limit, OffsetDateTime endDate, ApiCallback<AsyncActionsListResponseBody> _callback) List Async Actions (asynchronously) Track asynchronous operations scheduled in your project.okhttp3.CalllistAsyncActionsCall(Integer limit, OffsetDateTime endDate, ApiCallback _callback) Build call for listAsyncActionslistAsyncActionsWithHttpInfo(Integer limit, OffsetDateTime endDate) List Async Actions Track asynchronous operations scheduled in your project.voidsetApiClient(ApiClient apiClient) voidsetCustomBaseUrl(String customBaseUrl) voidsetHostIndex(int hostIndex)
-
Constructor Details
-
AsyncActionsApi
public AsyncActionsApi() -
AsyncActionsApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
getHostIndex
public int getHostIndex() -
setHostIndex
public void setHostIndex(int hostIndex) -
getCustomBaseUrl
-
setCustomBaseUrl
-
getAsyncActionCall
public okhttp3.Call getAsyncActionCall(String asyncActionId, ApiCallback _callback) throws ApiException Build call for getAsyncAction- Parameters:
asyncActionId- Unique ID of the asynchronous operation. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getAsyncAction
Get Async Action Check the result of a scheduled asynchronous operation. The table below lists the possible types of async actions. The types are different for each endpoint generating the async action. If you would like to learn more about importing data into Voucherify, read more [here](https://support.voucherify.io/article/574-data-import).- Parameters:
asyncActionId- Unique ID of the asynchronous operation. (required)- Returns:
- AsyncActionGetResponseBody
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAsyncActionWithHttpInfo
public ApiResponse<AsyncActionGetResponseBody> getAsyncActionWithHttpInfo(String asyncActionId) throws ApiException Get Async Action Check the result of a scheduled asynchronous operation. The table below lists the possible types of async actions. The types are different for each endpoint generating the async action. If you would like to learn more about importing data into Voucherify, read more [here](https://support.voucherify.io/article/574-data-import).- Parameters:
asyncActionId- Unique ID of the asynchronous operation. (required)- Returns:
- ApiResponse<AsyncActionGetResponseBody>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAsyncActionAsync
public okhttp3.Call getAsyncActionAsync(String asyncActionId, ApiCallback<AsyncActionGetResponseBody> _callback) throws ApiException Get Async Action (asynchronously) Check the result of a scheduled asynchronous operation. The table below lists the possible types of async actions. The types are different for each endpoint generating the async action. If you would like to learn more about importing data into Voucherify, read more [here](https://support.voucherify.io/article/574-data-import).- Parameters:
asyncActionId- Unique ID of the asynchronous operation. (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
-
listAsyncActionsCall
public okhttp3.Call listAsyncActionsCall(Integer limit, OffsetDateTime endDate, ApiCallback _callback) throws ApiException Build call for listAsyncActions- Parameters:
limit- Limit the number of asynchronous actions that the API returns in the response. (optional)endDate- Limits results to actions scheduled before the end_date. The date format needs to be consistent with ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
listAsyncActions
public AsyncActionsListResponseBody listAsyncActions(Integer limit, OffsetDateTime endDate) throws ApiException List Async Actions Track asynchronous operations scheduled in your project. The table below lists the possible types of async actions. The types are different for each endpoint generating the async action. If you would like to learn more about importing data into Voucherify, read more [here](https://support.voucherify.io/article/574-data-import).- Parameters:
limit- Limit the number of asynchronous actions that the API returns in the response. (optional)endDate- Limits results to actions scheduled before the end_date. The date format needs to be consistent with ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). (optional)- Returns:
- AsyncActionsListResponseBody
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
listAsyncActionsWithHttpInfo
public ApiResponse<AsyncActionsListResponseBody> listAsyncActionsWithHttpInfo(Integer limit, OffsetDateTime endDate) throws ApiException List Async Actions Track asynchronous operations scheduled in your project. The table below lists the possible types of async actions. The types are different for each endpoint generating the async action. If you would like to learn more about importing data into Voucherify, read more [here](https://support.voucherify.io/article/574-data-import).- Parameters:
limit- Limit the number of asynchronous actions that the API returns in the response. (optional)endDate- Limits results to actions scheduled before the end_date. The date format needs to be consistent with ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). (optional)- Returns:
- ApiResponse<AsyncActionsListResponseBody>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
listAsyncActionsAsync
public okhttp3.Call listAsyncActionsAsync(Integer limit, OffsetDateTime endDate, ApiCallback<AsyncActionsListResponseBody> _callback) throws ApiException List Async Actions (asynchronously) Track asynchronous operations scheduled in your project. The table below lists the possible types of async actions. The types are different for each endpoint generating the async action. If you would like to learn more about importing data into Voucherify, read more [here](https://support.voucherify.io/article/574-data-import).- Parameters:
limit- Limit the number of asynchronous actions that the API returns in the response. (optional)endDate- Limits results to actions scheduled before the end_date. The date format needs to be consistent with ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). (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
-