Api

Class ReportsApi

java.lang.Object

Api.ReportsApi

public class ReportsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ReportsApi()
ReportsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	createReport(CreateAdhocReportRequest createAdhocReportRequest, String organizationId) Create Adhoc Report Create a one-time report.
okhttp3.Call	createReportAsync(CreateAdhocReportRequest createAdhocReportRequest, String organizationId, ApiCallback<Void> callback) Create Adhoc Report (asynchronously) Create a one-time report.
okhttp3.Call	createReportCall(CreateAdhocReportRequest createAdhocReportRequest, String organizationId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createReport
ApiResponse<Void>	createReportWithHttpInfo(CreateAdhocReportRequest createAdhocReportRequest, String organizationId) Create Adhoc Report Create a one-time report.
ApiClient	getApiClient()
ReportingV3ReportsIdGet200Response	getReportByReportId(String reportId, String organizationId) Get Report Based on Report Id Download a report using the reportId value.
okhttp3.Call	getReportByReportIdAsync(String reportId, String organizationId, ApiCallback<ReportingV3ReportsIdGet200Response> callback) Get Report Based on Report Id (asynchronously) Download a report using the reportId value.
okhttp3.Call	getReportByReportIdCall(String reportId, String organizationId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getReportByReportId
ApiResponse<ReportingV3ReportsIdGet200Response>	getReportByReportIdWithHttpInfo(String reportId, String organizationId) Get Report Based on Report Id Download a report using the reportId value.
ReportingV3ReportsGet200Response	searchReports(org.joda.time.DateTime startTime, org.joda.time.DateTime endTime, String timeQueryType, String organizationId, String reportMimeType, String reportFrequency, String reportName, Integer reportDefinitionId, String reportStatus) Retrieve Available Reports Retrieve a list of the available reports to which you are subscribed.
okhttp3.Call	searchReportsAsync(org.joda.time.DateTime startTime, org.joda.time.DateTime endTime, String timeQueryType, String organizationId, String reportMimeType, String reportFrequency, String reportName, Integer reportDefinitionId, String reportStatus, ApiCallback<ReportingV3ReportsGet200Response> callback) Retrieve Available Reports (asynchronously) Retrieve a list of the available reports to which you are subscribed.
okhttp3.Call	searchReportsCall(org.joda.time.DateTime startTime, org.joda.time.DateTime endTime, String timeQueryType, String organizationId, String reportMimeType, String reportFrequency, String reportName, Integer reportDefinitionId, String reportStatus, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for searchReports
ApiResponse<ReportingV3ReportsGet200Response>	searchReportsWithHttpInfo(org.joda.time.DateTime startTime, org.joda.time.DateTime endTime, String timeQueryType, String organizationId, String reportMimeType, String reportFrequency, String reportName, Integer reportDefinitionId, String reportStatus) Retrieve Available Reports Retrieve a list of the available reports to which you are subscribed.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportsApi

public ReportsApi()

ReportsApi

public ReportsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createReportCall

public okhttp3.Call createReportCall(CreateAdhocReportRequest createAdhocReportRequest,
                                     String organizationId,
                                     ProgressResponseBody.ProgressListener progressListener,
                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                              throws ApiException

Build call for createReport

Parameters:

createAdhocReportRequest - Report subscription request payload (required)

organizationId - Valid Organization Id (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createReport

public void createReport(CreateAdhocReportRequest createAdhocReportRequest,
                         String organizationId)
                  throws ApiException

Create Adhoc Report Create a one-time report. You must specify the type of report in reportDefinitionName. For a list of values for reportDefinitionName, see the [Reporting Developer Guide](https://www.cybersource.com/developers/documentation/reporting_and_reconciliation)

Parameters:

createAdhocReportRequest - Report subscription request payload (required)

organizationId - Valid Organization Id (optional)

Throws:

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

createReportWithHttpInfo

public ApiResponse<Void> createReportWithHttpInfo(CreateAdhocReportRequest createAdhocReportRequest,
                                                  String organizationId)
                                           throws ApiException

Create Adhoc Report Create a one-time report. You must specify the type of report in reportDefinitionName. For a list of values for reportDefinitionName, see the [Reporting Developer Guide](https://www.cybersource.com/developers/documentation/reporting_and_reconciliation)

Parameters:

createAdhocReportRequest - Report subscription request payload (required)

organizationId - Valid Organization Id (optional)

Returns:

ApiResponse<Void>

Throws:

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

createReportAsync

public okhttp3.Call createReportAsync(CreateAdhocReportRequest createAdhocReportRequest,
                                      String organizationId,
                                      ApiCallback<Void> callback)
                               throws ApiException

Create Adhoc Report (asynchronously) Create a one-time report. You must specify the type of report in reportDefinitionName. For a list of values for reportDefinitionName, see the [Reporting Developer Guide](https://www.cybersource.com/developers/documentation/reporting_and_reconciliation)

Parameters:

createAdhocReportRequest - Report subscription request payload (required)

organizationId - Valid Organization Id (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

getReportByReportIdCall

public okhttp3.Call getReportByReportIdCall(String reportId,
                                            String organizationId,
                                            ProgressResponseBody.ProgressListener progressListener,
                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                     throws ApiException

Build call for getReportByReportId

Parameters:

reportId - Valid Report Id (required)

organizationId - Valid Organization Id (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getReportByReportId

public ReportingV3ReportsIdGet200Response getReportByReportId(String reportId,
                                                              String organizationId)
                                                       throws ApiException

Get Report Based on Report Id Download a report using the reportId value. If you don't already know this value, you can obtain it using the Retrieve available reports call.

Parameters:

reportId - Valid Report Id (required)

organizationId - Valid Organization Id (optional)

Returns:

ReportingV3ReportsIdGet200Response

Throws:

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

getReportByReportIdWithHttpInfo

public ApiResponse<ReportingV3ReportsIdGet200Response> getReportByReportIdWithHttpInfo(String reportId,
                                                                                       String organizationId)
                                                                                throws ApiException

Get Report Based on Report Id Download a report using the reportId value. If you don't already know this value, you can obtain it using the Retrieve available reports call.

Parameters:

reportId - Valid Report Id (required)

organizationId - Valid Organization Id (optional)

Returns:

ApiResponse<ReportingV3ReportsIdGet200Response>

Throws:

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

getReportByReportIdAsync

public okhttp3.Call getReportByReportIdAsync(String reportId,
                                             String organizationId,
                                             ApiCallback<ReportingV3ReportsIdGet200Response> callback)
                                      throws ApiException

Get Report Based on Report Id (asynchronously) Download a report using the reportId value. If you don't already know this value, you can obtain it using the Retrieve available reports call.

Parameters:

reportId - Valid Report Id (required)

organizationId - Valid Organization Id (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

searchReportsCall

public okhttp3.Call searchReportsCall(org.joda.time.DateTime startTime,
                                      org.joda.time.DateTime endTime,
                                      String timeQueryType,
                                      String organizationId,
                                      String reportMimeType,
                                      String reportFrequency,
                                      String reportName,
                                      Integer reportDefinitionId,
                                      String reportStatus,
                                      ProgressResponseBody.ProgressListener progressListener,
                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                               throws ApiException

Build call for searchReports

Parameters:

startTime - Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

endTime - Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

timeQueryType - Specify time you would like to search Valid values: - reportTimeFrame - executedTime (required)

organizationId - Valid Organization Id (optional)

reportMimeType - Valid Report Format Valid values: - application/xml - text/csv (optional)

reportFrequency - Valid Report Frequency Valid values: - DAILY - WEEKLY - MONTHLY - USER_DEFINED - ADHOC (optional)

reportName - Valid Report Name (optional)

reportDefinitionId - Valid Report Definition Id (optional)

reportStatus - Valid Report Status Valid values: - COMPLETED - PENDING - QUEUED - RUNNING - ERROR - NO_DATA (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

searchReports

public ReportingV3ReportsGet200Response searchReports(org.joda.time.DateTime startTime,
                                                      org.joda.time.DateTime endTime,
                                                      String timeQueryType,
                                                      String organizationId,
                                                      String reportMimeType,
                                                      String reportFrequency,
                                                      String reportName,
                                                      Integer reportDefinitionId,
                                                      String reportStatus)
                                               throws ApiException

Retrieve Available Reports Retrieve a list of the available reports to which you are subscribed. This will also give you the reportId value, which you can also use to download a report.

Parameters:

startTime - Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

endTime - Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

timeQueryType - Specify time you would like to search Valid values: - reportTimeFrame - executedTime (required)

organizationId - Valid Organization Id (optional)

reportMimeType - Valid Report Format Valid values: - application/xml - text/csv (optional)

reportFrequency - Valid Report Frequency Valid values: - DAILY - WEEKLY - MONTHLY - USER_DEFINED - ADHOC (optional)

reportName - Valid Report Name (optional)

reportDefinitionId - Valid Report Definition Id (optional)

reportStatus - Valid Report Status Valid values: - COMPLETED - PENDING - QUEUED - RUNNING - ERROR - NO_DATA (optional)

Returns:

ReportingV3ReportsGet200Response

Throws:

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

searchReportsWithHttpInfo

public ApiResponse<ReportingV3ReportsGet200Response> searchReportsWithHttpInfo(org.joda.time.DateTime startTime,
                                                                               org.joda.time.DateTime endTime,
                                                                               String timeQueryType,
                                                                               String organizationId,
                                                                               String reportMimeType,
                                                                               String reportFrequency,
                                                                               String reportName,
                                                                               Integer reportDefinitionId,
                                                                               String reportStatus)
                                                                        throws ApiException

Retrieve Available Reports Retrieve a list of the available reports to which you are subscribed. This will also give you the reportId value, which you can also use to download a report.

Parameters:

startTime - Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

endTime - Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

timeQueryType - Specify time you would like to search Valid values: - reportTimeFrame - executedTime (required)

organizationId - Valid Organization Id (optional)

reportMimeType - Valid Report Format Valid values: - application/xml - text/csv (optional)

reportFrequency - Valid Report Frequency Valid values: - DAILY - WEEKLY - MONTHLY - USER_DEFINED - ADHOC (optional)

reportName - Valid Report Name (optional)

reportDefinitionId - Valid Report Definition Id (optional)

reportStatus - Valid Report Status Valid values: - COMPLETED - PENDING - QUEUED - RUNNING - ERROR - NO_DATA (optional)

Returns:

ApiResponse<ReportingV3ReportsGet200Response>

Throws:

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

searchReportsAsync

public okhttp3.Call searchReportsAsync(org.joda.time.DateTime startTime,
                                       org.joda.time.DateTime endTime,
                                       String timeQueryType,
                                       String organizationId,
                                       String reportMimeType,
                                       String reportFrequency,
                                       String reportName,
                                       Integer reportDefinitionId,
                                       String reportStatus,
                                       ApiCallback<ReportingV3ReportsGet200Response> callback)
                                throws ApiException

Retrieve Available Reports (asynchronously) Retrieve a list of the available reports to which you are subscribed. This will also give you the reportId value, which you can also use to download a report.

Parameters:

startTime - Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

endTime - Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)

timeQueryType - Specify time you would like to search Valid values: - reportTimeFrame - executedTime (required)

organizationId - Valid Organization Id (optional)

reportMimeType - Valid Report Format Valid values: - application/xml - text/csv (optional)

reportFrequency - Valid Report Frequency Valid values: - DAILY - WEEKLY - MONTHLY - USER_DEFINED - ADHOC (optional)

reportName - Valid Report Name (optional)

reportDefinitionId - Valid Report Definition Id (optional)

reportStatus - Valid Report Status Valid values: - COMPLETED - PENDING - QUEUED - RUNNING - ERROR - NO_DATA (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