Api

Class SecureFileShareApi

java.lang.Object

Api.SecureFileShareApi

public class SecureFileShareApi
extends Object

Constructor Summary

Constructors

Constructor	Description
SecureFileShareApi()
SecureFileShareApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
void	getFile(String fileId, String organizationId)	Download a File with File Identifier Download a file for the given file identifier
okhttp3.Call	getFileAsync(String fileId, String organizationId, ApiCallback<Void> callback)	Download a File with File Identifier (asynchronously) Download a file for the given file identifier
okhttp3.Call	getFileCall(String fileId, String organizationId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getFile
V1FileDetailsGet200Response	getFileDetail(org.joda.time.LocalDate startDate, org.joda.time.LocalDate endDate, String organizationId, String name)	Get List of Files Get list of files and it's information of them available inside the report directory
okhttp3.Call	getFileDetailAsync(org.joda.time.LocalDate startDate, org.joda.time.LocalDate endDate, String organizationId, String name, ApiCallback<V1FileDetailsGet200Response> callback)	Get List of Files (asynchronously) Get list of files and it's information of them available inside the report directory
okhttp3.Call	getFileDetailCall(org.joda.time.LocalDate startDate, org.joda.time.LocalDate endDate, String organizationId, String name, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getFileDetail
ApiResponse<V1FileDetailsGet200Response>	getFileDetailWithHttpInfo(org.joda.time.LocalDate startDate, org.joda.time.LocalDate endDate, String organizationId, String name)	Get List of Files Get list of files and it's information of them available inside the report directory
ApiResponse<InputStream>	getFileWithHttpInfo(String fileId, String organizationId)	Download a File with File Identifier Download a file for the given file identifier
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

SecureFileShareApi

public SecureFileShareApi()

SecureFileShareApi

public SecureFileShareApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getFileCall

public okhttp3.Call getFileCall(String fileId,
                                String organizationId,
                                ProgressResponseBody.ProgressListener progressListener,
                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                         throws ApiException,
                                com.cybersource.authsdk.core.ConfigException

Build call for getFile

Parameters:

fileId - Unique identifier for each file (required)

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getFile

public void getFile(String fileId,
                    String organizationId)
             throws ApiException,
                    com.cybersource.authsdk.core.ConfigException

Download a File with File Identifier Download a file for the given file identifier

Parameters:

fileId - Unique identifier for each file (required)

organizationId - Valid Cybersource Organization Id (optional)

Throws:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getFileWithHttpInfo

public ApiResponse<InputStream> getFileWithHttpInfo(String fileId,
                                                    String organizationId)
                                             throws ApiException,
                                                    com.cybersource.authsdk.core.ConfigException

Download a File with File Identifier Download a file for the given file identifier

Parameters:

fileId - Unique identifier for each file (required)

organizationId - Valid Cybersource Organization Id (optional)

Returns:

ApiResponse<Void>

Throws:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getFileAsync

public okhttp3.Call getFileAsync(String fileId,
                                 String organizationId,
                                 ApiCallback<Void> callback)
                          throws ApiException,
                                 com.cybersource.authsdk.core.ConfigException

Download a File with File Identifier (asynchronously) Download a file for the given file identifier

Parameters:

fileId - Unique identifier for each file (required)

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getFileDetailCall

public okhttp3.Call getFileDetailCall(org.joda.time.LocalDate startDate,
                                      org.joda.time.LocalDate endDate,
                                      String organizationId,
                                      String name,
                                      ProgressResponseBody.ProgressListener progressListener,
                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                               throws ApiException,
                                      com.cybersource.authsdk.core.ConfigException

Build call for getFileDetail

Parameters:

startDate - Valid start date 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 (required)

endDate - Valid end date 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 (required)

organizationId - Valid Cybersource Organization Id (optional)

name - **Tailored to searches for specific files with in given Date range** example : MyTransactionDetailreport.xml (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getFileDetail

public V1FileDetailsGet200Response getFileDetail(org.joda.time.LocalDate startDate,
                                                 org.joda.time.LocalDate endDate,
                                                 String organizationId,
                                                 String name)
                                          throws ApiException,
                                                 com.cybersource.authsdk.core.ConfigException

Get List of Files Get list of files and it's information of them available inside the report directory

Parameters:

startDate - Valid start date 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 (required)

endDate - Valid end date 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 (required)

organizationId - Valid Cybersource Organization Id (optional)

name - **Tailored to searches for specific files with in given Date range** example : MyTransactionDetailreport.xml (optional)

Returns:

V1FileDetailsGet200Response

Throws:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getFileDetailWithHttpInfo

public ApiResponse<V1FileDetailsGet200Response> getFileDetailWithHttpInfo(org.joda.time.LocalDate startDate,
                                                                          org.joda.time.LocalDate endDate,
                                                                          String organizationId,
                                                                          String name)
                                                                   throws ApiException,
                                                                          com.cybersource.authsdk.core.ConfigException

Get List of Files Get list of files and it's information of them available inside the report directory

Parameters:

startDate - Valid start date 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 (required)

endDate - Valid end date 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 (required)

organizationId - Valid Cybersource Organization Id (optional)

name - **Tailored to searches for specific files with in given Date range** example : MyTransactionDetailreport.xml (optional)

Returns:

ApiResponse<V1FileDetailsGet200Response>

Throws:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getFileDetailAsync

public okhttp3.Call getFileDetailAsync(org.joda.time.LocalDate startDate,
                                       org.joda.time.LocalDate endDate,
                                       String organizationId,
                                       String name,
                                       ApiCallback<V1FileDetailsGet200Response> callback)
                                throws ApiException,
                                       com.cybersource.authsdk.core.ConfigException

Get List of Files (asynchronously) Get list of files and it's information of them available inside the report directory

Parameters:

startDate - Valid start date 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 (required)

endDate - Valid end date 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 (required)

organizationId - Valid Cybersource Organization Id (optional)

name - **Tailored to searches for specific files with in given Date range** example : MyTransactionDetailreport.xml (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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient