Api

Class ReportDefinitionsApi

java.lang.Object

Api.ReportDefinitionsApi

public class ReportDefinitionsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ReportDefinitionsApi()
ReportDefinitionsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
ReportingV3ReportDefinitionsNameGet200Response	getResourceInfoByReportDefinition(String reportDefinitionName, String subscriptionType, String reportMimeType, String organizationId) Get Report Definition View the attributes of an individual report type.
okhttp3.Call	getResourceInfoByReportDefinitionAsync(String reportDefinitionName, String subscriptionType, String reportMimeType, String organizationId, ApiCallback<ReportingV3ReportDefinitionsNameGet200Response> callback) Get Report Definition (asynchronously) View the attributes of an individual report type.
okhttp3.Call	getResourceInfoByReportDefinitionCall(String reportDefinitionName, String subscriptionType, String reportMimeType, String organizationId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getResourceInfoByReportDefinition
ApiResponse<ReportingV3ReportDefinitionsNameGet200Response>	getResourceInfoByReportDefinitionWithHttpInfo(String reportDefinitionName, String subscriptionType, String reportMimeType, String organizationId) Get Report Definition View the attributes of an individual report type.
ReportingV3ReportDefinitionsGet200Response	getResourceV2Info(String subscriptionType, String organizationId) Get Reporting Resource Information View a list of supported reports and their attributes before subscribing to them.
okhttp3.Call	getResourceV2InfoAsync(String subscriptionType, String organizationId, ApiCallback<ReportingV3ReportDefinitionsGet200Response> callback) Get Reporting Resource Information (asynchronously) View a list of supported reports and their attributes before subscribing to them.
okhttp3.Call	getResourceV2InfoCall(String subscriptionType, String organizationId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getResourceV2Info
ApiResponse<ReportingV3ReportDefinitionsGet200Response>	getResourceV2InfoWithHttpInfo(String subscriptionType, String organizationId) Get Reporting Resource Information View a list of supported reports and their attributes before subscribing to them.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportDefinitionsApi

public ReportDefinitionsApi()

ReportDefinitionsApi

public ReportDefinitionsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getResourceInfoByReportDefinitionCall

public okhttp3.Call getResourceInfoByReportDefinitionCall(String reportDefinitionName,
                                                          String subscriptionType,
                                                          String reportMimeType,
                                                          String organizationId,
                                                          ProgressResponseBody.ProgressListener progressListener,
                                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                   throws ApiException

Build call for getResourceInfoByReportDefinition

Parameters:

reportDefinitionName - Name of the Report definition to retrieve (required)

subscriptionType - The subscription type for which report definition is required. By default the type will be CUSTOM. Valid Values: - CLASSIC - CUSTOM - STANDARD (optional)

reportMimeType - The format for which the report definition is required. By default the value will be CSV. Valid Values: - application/xml - text/csv (optional)

organizationId - Valid Cybersource Organization Id (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getResourceInfoByReportDefinition

public ReportingV3ReportDefinitionsNameGet200Response getResourceInfoByReportDefinition(String reportDefinitionName,
                                                                                        String subscriptionType,
                                                                                        String reportMimeType,
                                                                                        String organizationId)
                                                                                 throws ApiException

Get Report Definition View the attributes of an individual report type. For a list of values for reportDefinitionName, see the [Reporting Developer Guide](https://www.cybersource.com/developers/documentation/reporting_and_reconciliation/)

Parameters:

reportDefinitionName - Name of the Report definition to retrieve (required)

subscriptionType - The subscription type for which report definition is required. By default the type will be CUSTOM. Valid Values: - CLASSIC - CUSTOM - STANDARD (optional)

reportMimeType - The format for which the report definition is required. By default the value will be CSV. Valid Values: - application/xml - text/csv (optional)

organizationId - Valid Cybersource Organization Id (optional)

Returns:

ReportingV3ReportDefinitionsNameGet200Response

Throws:

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

getResourceInfoByReportDefinitionWithHttpInfo

public ApiResponse<ReportingV3ReportDefinitionsNameGet200Response> getResourceInfoByReportDefinitionWithHttpInfo(String reportDefinitionName,
                                                                                                                 String subscriptionType,
                                                                                                                 String reportMimeType,
                                                                                                                 String organizationId)
                                                                                                          throws ApiException

Get Report Definition View the attributes of an individual report type. For a list of values for reportDefinitionName, see the [Reporting Developer Guide](https://www.cybersource.com/developers/documentation/reporting_and_reconciliation/)

Parameters:

reportDefinitionName - Name of the Report definition to retrieve (required)

subscriptionType - The subscription type for which report definition is required. By default the type will be CUSTOM. Valid Values: - CLASSIC - CUSTOM - STANDARD (optional)

reportMimeType - The format for which the report definition is required. By default the value will be CSV. Valid Values: - application/xml - text/csv (optional)

organizationId - Valid Cybersource Organization Id (optional)

Returns:

ApiResponse<ReportingV3ReportDefinitionsNameGet200Response>

Throws:

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

getResourceInfoByReportDefinitionAsync

public okhttp3.Call getResourceInfoByReportDefinitionAsync(String reportDefinitionName,
                                                           String subscriptionType,
                                                           String reportMimeType,
                                                           String organizationId,
                                                           ApiCallback<ReportingV3ReportDefinitionsNameGet200Response> callback)
                                                    throws ApiException

Get Report Definition (asynchronously) View the attributes of an individual report type. For a list of values for reportDefinitionName, see the [Reporting Developer Guide](https://www.cybersource.com/developers/documentation/reporting_and_reconciliation/)

Parameters:

reportDefinitionName - Name of the Report definition to retrieve (required)

subscriptionType - The subscription type for which report definition is required. By default the type will be CUSTOM. Valid Values: - CLASSIC - CUSTOM - STANDARD (optional)

reportMimeType - The format for which the report definition is required. By default the value will be CSV. Valid Values: - application/xml - text/csv (optional)

organizationId - Valid Cybersource 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

getResourceV2InfoCall

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

Build call for getResourceV2Info

Parameters:

subscriptionType - Valid Values: - CLASSIC - CUSTOM - STANDARD (optional)

organizationId - Valid Cybersource Organization Id (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getResourceV2Info

public ReportingV3ReportDefinitionsGet200Response getResourceV2Info(String subscriptionType,
                                                                    String organizationId)
                                                             throws ApiException

Get Reporting Resource Information View a list of supported reports and their attributes before subscribing to them.

Parameters:

subscriptionType - Valid Values: - CLASSIC - CUSTOM - STANDARD (optional)

organizationId - Valid Cybersource Organization Id (optional)

Returns:

ReportingV3ReportDefinitionsGet200Response

Throws:

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

getResourceV2InfoWithHttpInfo

public ApiResponse<ReportingV3ReportDefinitionsGet200Response> getResourceV2InfoWithHttpInfo(String subscriptionType,
                                                                                             String organizationId)
                                                                                      throws ApiException

Get Reporting Resource Information View a list of supported reports and their attributes before subscribing to them.

Parameters:

subscriptionType - Valid Values: - CLASSIC - CUSTOM - STANDARD (optional)

organizationId - Valid Cybersource Organization Id (optional)

Returns:

ApiResponse<ReportingV3ReportDefinitionsGet200Response>

Throws:

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

getResourceV2InfoAsync

public okhttp3.Call getResourceV2InfoAsync(String subscriptionType,
                                           String organizationId,
                                           ApiCallback<ReportingV3ReportDefinitionsGet200Response> callback)
                                    throws ApiException

Get Reporting Resource Information (asynchronously) View a list of supported reports and their attributes before subscribing to them.

Parameters:

subscriptionType - Valid Values: - CLASSIC - CUSTOM - STANDARD (optional)

organizationId - Valid Cybersource 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