Package io.voucherify.client.api

Class ExportsApi

java.lang.Object

io.voucherify.client.api.ExportsApi

public class ExportsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ExportsApi()
ExportsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ExportsCreateResponseBody	createExport(ExportsCreateRequestBody exportsCreateRequestBody)	Create Export Create export object.
okhttp3.Call	createExportAsync(ExportsCreateRequestBody exportsCreateRequestBody, ApiCallback<ExportsCreateResponseBody> _callback)	Create Export (asynchronously) Create export object.
okhttp3.Call	createExportCall(ExportsCreateRequestBody exportsCreateRequestBody, ApiCallback _callback)	Build call for createExport
ApiResponse<ExportsCreateResponseBody>	createExportWithHttpInfo(ExportsCreateRequestBody exportsCreateRequestBody)	Create Export Create export object.
void	deleteExport(String exportId)	Delete Export This method deletes a previously created export object.
okhttp3.Call	deleteExportAsync(String exportId, ApiCallback<Void> _callback)	Delete Export (asynchronously) This method deletes a previously created export object.
okhttp3.Call	deleteExportCall(String exportId, ApiCallback _callback)	Build call for deleteExport
ApiResponse<Void>	deleteExportWithHttpInfo(String exportId)	Delete Export This method deletes a previously created export object.
String	downloadExport(String exportId, String token)	Download Export Download the contents of the exported CSV file.
okhttp3.Call	downloadExportAsync(String exportId, String token, ApiCallback<String> _callback)	Download Export (asynchronously) Download the contents of the exported CSV file.
okhttp3.Call	downloadExportCall(String exportId, String token, ApiCallback _callback)	Build call for downloadExport
ApiResponse<String>	downloadExportWithHttpInfo(String exportId, String token)	Download Export Download the contents of the exported CSV file.
ApiClient	getApiClient()
String	getCustomBaseUrl()
ExportsGetResponseBody	getExport(String exportId)	Get Export Retrieves the URL of the downloadable file, which was generated via the Create Export method.
okhttp3.Call	getExportAsync(String exportId, ApiCallback<ExportsGetResponseBody> _callback)	Get Export (asynchronously) Retrieves the URL of the downloadable file, which was generated via the Create Export method.
okhttp3.Call	getExportCall(String exportId, ApiCallback _callback)	Build call for getExport
ApiResponse<ExportsGetResponseBody>	getExportWithHttpInfo(String exportId)	Get Export Retrieves the URL of the downloadable file, which was generated via the Create Export method.
int	getHostIndex()
ExportsListResponseBody	listExports(Integer limit, Integer page, ParameterOrderListExports order)	List Exports List all exports.
okhttp3.Call	listExportsAsync(Integer limit, Integer page, ParameterOrderListExports order, ApiCallback<ExportsListResponseBody> _callback)	List Exports (asynchronously) List all exports.
okhttp3.Call	listExportsCall(Integer limit, Integer page, ParameterOrderListExports order, ApiCallback _callback)	Build call for listExports
ApiResponse<ExportsListResponseBody>	listExportsWithHttpInfo(Integer limit, Integer page, ParameterOrderListExports order)	List Exports List all exports.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(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 Details

ExportsApi

public ExportsApi()

ExportsApi

public ExportsApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createExportCall

public okhttp3.Call createExportCall(ExportsCreateRequestBody exportsCreateRequestBody,
 ApiCallback _callback)
                              throws ApiException

Build call for createExport

Parameters:

exportsCreateRequestBody - Specify the details of the export that you would like to create. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createExport

public ExportsCreateResponseBody createExport(ExportsCreateRequestBody exportsCreateRequestBody)
                                       throws ApiException

Create Export Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions

Parameters:

exportsCreateRequestBody - Specify the details of the export that you would like to create. (optional)

Returns:

ExportsCreateResponseBody

Throws:

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

createExportWithHttpInfo

public ApiResponse<ExportsCreateResponseBody> createExportWithHttpInfo(ExportsCreateRequestBody exportsCreateRequestBody)
                                                                throws ApiException

Create Export Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions

Parameters:

exportsCreateRequestBody - Specify the details of the export that you would like to create. (optional)

Returns:

ApiResponse<ExportsCreateResponseBody>

Throws:

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

createExportAsync

public okhttp3.Call createExportAsync(ExportsCreateRequestBody exportsCreateRequestBody,
 ApiCallback<ExportsCreateResponseBody> _callback)
                               throws ApiException

Create Export (asynchronously) Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions

Parameters:

exportsCreateRequestBody - Specify the details of the export that you would like 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

deleteExportCall

public okhttp3.Call deleteExportCall(String exportId,
 ApiCallback _callback)
                              throws ApiException

Build call for deleteExport

Parameters:

exportId - Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteExport

public void deleteExport(String exportId)
                  throws ApiException

Delete Export This method deletes a previously created export object.

Parameters:

exportId - Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions. (required)

Throws:

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

deleteExportWithHttpInfo

public ApiResponse<Void> deleteExportWithHttpInfo(String exportId)
                                           throws ApiException

Delete Export This method deletes a previously created export object.

Parameters:

exportId - Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions. (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteExportAsync

public okhttp3.Call deleteExportAsync(String exportId,
 ApiCallback<Void> _callback)
                               throws ApiException

Delete Export (asynchronously) This method deletes a previously created export object.

Parameters:

exportId - Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions. (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

downloadExportCall

public okhttp3.Call downloadExportCall(String exportId,
 String token,
 ApiCallback _callback)
                                throws ApiException

Build call for downloadExport

Parameters:

exportId - Unique export object ID. (required)

token - Token that was issued to the export, to get this token, get the export first (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

downloadExport

public String downloadExport(String exportId,
 String token)
                      throws ApiException

Download Export Download the contents of the exported CSV file. 📘 Important notes **Base URL:** - https://download.voucherify.io (Europe) - https://us1.download.voucherify.io (US) - https://as1.download.voucherify.io (Asia) **Token:** Can be found within the result parameter of the Get Export method response.

Parameters:

exportId - Unique export object ID. (required)

token - Token that was issued to the export, to get this token, get the export first (optional)

Returns:

String

Throws:

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

downloadExportWithHttpInfo

public ApiResponse<String> downloadExportWithHttpInfo(String exportId,
 String token)
                                               throws ApiException

Download Export Download the contents of the exported CSV file. 📘 Important notes **Base URL:** - https://download.voucherify.io (Europe) - https://us1.download.voucherify.io (US) - https://as1.download.voucherify.io (Asia) **Token:** Can be found within the result parameter of the Get Export method response.

Parameters:

exportId - Unique export object ID. (required)

token - Token that was issued to the export, to get this token, get the export first (optional)

Returns:

ApiResponse<String>

Throws:

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

downloadExportAsync

public okhttp3.Call downloadExportAsync(String exportId,
 String token,
 ApiCallback<String> _callback)
                                 throws ApiException

Download Export (asynchronously) Download the contents of the exported CSV file. 📘 Important notes **Base URL:** - https://download.voucherify.io (Europe) - https://us1.download.voucherify.io (US) - https://as1.download.voucherify.io (Asia) **Token:** Can be found within the result parameter of the Get Export method response.

Parameters:

exportId - Unique export object ID. (required)

token - Token that was issued to the export, to get this token, get the export first (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

getExportCall

public okhttp3.Call getExportCall(String exportId,
 ApiCallback _callback)
                           throws ApiException

Build call for getExport

Parameters:

exportId - Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getExport

public ExportsGetResponseBody getExport(String exportId)
                                 throws ApiException

Get Export Retrieves the URL of the downloadable file, which was generated via the Create Export method.

Parameters:

exportId - Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions. (required)

Returns:

ExportsGetResponseBody

Throws:

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

getExportWithHttpInfo

public ApiResponse<ExportsGetResponseBody> getExportWithHttpInfo(String exportId)
                                                          throws ApiException

Get Export Retrieves the URL of the downloadable file, which was generated via the Create Export method.

Parameters:

exportId - Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions. (required)

Returns:

ApiResponse<ExportsGetResponseBody>

Throws:

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

getExportAsync

public okhttp3.Call getExportAsync(String exportId,
 ApiCallback<ExportsGetResponseBody> _callback)
                            throws ApiException

Get Export (asynchronously) Retrieves the URL of the downloadable file, which was generated via the Create Export method.

Parameters:

exportId - Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions. (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

listExportsCall

public okhttp3.Call listExportsCall(Integer limit,
 Integer page,
 ParameterOrderListExports order,
 ApiCallback _callback)
                             throws ApiException

Build call for listExports

Parameters:

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listExports

public ExportsListResponseBody listExports(Integer limit,
 Integer page,
 ParameterOrderListExports order)
                                    throws ApiException

List Exports List all exports.

Parameters:

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

Returns:

ExportsListResponseBody

Throws:

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

listExportsWithHttpInfo

public ApiResponse<ExportsListResponseBody> listExportsWithHttpInfo(Integer limit,
 Integer page,
 ParameterOrderListExports order)
                                                             throws ApiException

List Exports List all exports.

Parameters:

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

Returns:

ApiResponse<ExportsListResponseBody>

Throws:

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

listExportsAsync

public okhttp3.Call listExportsAsync(Integer limit,
 Integer page,
 ParameterOrderListExports order,
 ApiCallback<ExportsListResponseBody> _callback)
                              throws ApiException

List Exports (asynchronously) List all exports.

Parameters:

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (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