Api

Class MerchantDefinedFieldsApi

java.lang.Object

Api.MerchantDefinedFieldsApi

public class MerchantDefinedFieldsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
MerchantDefinedFieldsApi()
MerchantDefinedFieldsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
List<InlineResponse2004>	createMerchantDefinedFieldDefinition(String referenceType, MerchantDefinedFieldDefinitionRequest merchantDefinedFieldDefinitionRequest)	Create merchant defined field for a given reference type
okhttp3.Call	createMerchantDefinedFieldDefinitionAsync(String referenceType, MerchantDefinedFieldDefinitionRequest merchantDefinedFieldDefinitionRequest, ApiCallback<List<InlineResponse2004>> callback)	Create merchant defined field for a given reference type (asynchronously)
okhttp3.Call	createMerchantDefinedFieldDefinitionCall(String referenceType, MerchantDefinedFieldDefinitionRequest merchantDefinedFieldDefinitionRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for createMerchantDefinedFieldDefinition
ApiResponse<List<InlineResponse2004>>	createMerchantDefinedFieldDefinitionWithHttpInfo(String referenceType, MerchantDefinedFieldDefinitionRequest merchantDefinedFieldDefinitionRequest)	Create merchant defined field for a given reference type
void	deleteMerchantDefinedFieldsDefinitions(String referenceType, Long id)	Delete a MerchantDefinedField by ID
okhttp3.Call	deleteMerchantDefinedFieldsDefinitionsAsync(String referenceType, Long id, ApiCallback<Void> callback)	Delete a MerchantDefinedField by ID (asynchronously)
okhttp3.Call	deleteMerchantDefinedFieldsDefinitionsCall(String referenceType, Long id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for deleteMerchantDefinedFieldsDefinitions
ApiResponse<Void>	deleteMerchantDefinedFieldsDefinitionsWithHttpInfo(String referenceType, Long id)	Delete a MerchantDefinedField by ID
ApiClient	getApiClient()
List<InlineResponse2004>	getMerchantDefinedFieldsDefinitions(String referenceType)	Get all merchant defined fields for a given reference type
okhttp3.Call	getMerchantDefinedFieldsDefinitionsAsync(String referenceType, ApiCallback<List<InlineResponse2004>> callback)	Get all merchant defined fields for a given reference type (asynchronously)
okhttp3.Call	getMerchantDefinedFieldsDefinitionsCall(String referenceType, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getMerchantDefinedFieldsDefinitions
ApiResponse<List<InlineResponse2004>>	getMerchantDefinedFieldsDefinitionsWithHttpInfo(String referenceType)	Get all merchant defined fields for a given reference type
List<InlineResponse2004>	putMerchantDefinedFieldsDefinitions(String referenceType, Long id, MerchantDefinedFieldCore merchantDefinedFieldCore)	Update a MerchantDefinedField by ID
okhttp3.Call	putMerchantDefinedFieldsDefinitionsAsync(String referenceType, Long id, MerchantDefinedFieldCore merchantDefinedFieldCore, ApiCallback<List<InlineResponse2004>> callback)	Update a MerchantDefinedField by ID (asynchronously)
okhttp3.Call	putMerchantDefinedFieldsDefinitionsCall(String referenceType, Long id, MerchantDefinedFieldCore merchantDefinedFieldCore, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for putMerchantDefinedFieldsDefinitions
ApiResponse<List<InlineResponse2004>>	putMerchantDefinedFieldsDefinitionsWithHttpInfo(String referenceType, Long id, MerchantDefinedFieldCore merchantDefinedFieldCore)	Update a MerchantDefinedField by ID
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

MerchantDefinedFieldsApi

public MerchantDefinedFieldsApi()

MerchantDefinedFieldsApi

public MerchantDefinedFieldsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createMerchantDefinedFieldDefinitionCall

public okhttp3.Call createMerchantDefinedFieldDefinitionCall(String referenceType,
                                                             MerchantDefinedFieldDefinitionRequest merchantDefinedFieldDefinitionRequest,
                                                             ProgressResponseBody.ProgressListener progressListener,
                                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                      throws ApiException,
                                                             com.cybersource.authsdk.core.ConfigException

Build call for createMerchantDefinedFieldDefinition

Parameters:

referenceType - The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation (required)

merchantDefinedFieldDefinitionRequest - (required)

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

createMerchantDefinedFieldDefinition

public List<InlineResponse2004> createMerchantDefinedFieldDefinition(String referenceType,
                                                                     MerchantDefinedFieldDefinitionRequest merchantDefinedFieldDefinitionRequest)
                                                              throws ApiException,
                                                                     com.cybersource.authsdk.core.ConfigException

Create merchant defined field for a given reference type

Parameters:

referenceType - The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation (required)

merchantDefinedFieldDefinitionRequest - (required)

Returns:

List<InlineResponse2004>

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

createMerchantDefinedFieldDefinitionWithHttpInfo

public ApiResponse<List<InlineResponse2004>> createMerchantDefinedFieldDefinitionWithHttpInfo(String referenceType,
                                                                                              MerchantDefinedFieldDefinitionRequest merchantDefinedFieldDefinitionRequest)
                                                                                       throws ApiException,
                                                                                              com.cybersource.authsdk.core.ConfigException

Create merchant defined field for a given reference type

Parameters:

referenceType - The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation (required)

merchantDefinedFieldDefinitionRequest - (required)

Returns:

ApiResponse<List<InlineResponse2004>>

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

createMerchantDefinedFieldDefinitionAsync

public okhttp3.Call createMerchantDefinedFieldDefinitionAsync(String referenceType,
                                                              MerchantDefinedFieldDefinitionRequest merchantDefinedFieldDefinitionRequest,
                                                              ApiCallback<List<InlineResponse2004>> callback)
                                                       throws ApiException,
                                                              com.cybersource.authsdk.core.ConfigException

Create merchant defined field for a given reference type (asynchronously)

Parameters:

referenceType - The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation (required)

merchantDefinedFieldDefinitionRequest - (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

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

deleteMerchantDefinedFieldsDefinitionsCall

public okhttp3.Call deleteMerchantDefinedFieldsDefinitionsCall(String referenceType,
                                                               Long id,
                                                               ProgressResponseBody.ProgressListener progressListener,
                                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                        throws ApiException,
                                                               com.cybersource.authsdk.core.ConfigException

Build call for deleteMerchantDefinedFieldsDefinitions

Parameters:

referenceType - (required)

id - (required)

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

deleteMerchantDefinedFieldsDefinitions

public void deleteMerchantDefinedFieldsDefinitions(String referenceType,
                                                   Long id)
                                            throws ApiException,
                                                   com.cybersource.authsdk.core.ConfigException

Delete a MerchantDefinedField by ID

Parameters:

referenceType - (required)

id - (required)

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

deleteMerchantDefinedFieldsDefinitionsWithHttpInfo

public ApiResponse<Void> deleteMerchantDefinedFieldsDefinitionsWithHttpInfo(String referenceType,
                                                                            Long id)
                                                                     throws ApiException,
                                                                            com.cybersource.authsdk.core.ConfigException

Delete a MerchantDefinedField by ID

Parameters:

referenceType - (required)

id - (required)

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

deleteMerchantDefinedFieldsDefinitionsAsync

public okhttp3.Call deleteMerchantDefinedFieldsDefinitionsAsync(String referenceType,
                                                                Long id,
                                                                ApiCallback<Void> callback)
                                                         throws ApiException,
                                                                com.cybersource.authsdk.core.ConfigException

Delete a MerchantDefinedField by ID (asynchronously)

Parameters:

referenceType - (required)

id - (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

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

getMerchantDefinedFieldsDefinitionsCall

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

Build call for getMerchantDefinedFieldsDefinitions

Parameters:

referenceType - The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation (required)

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

getMerchantDefinedFieldsDefinitions

public List<InlineResponse2004> getMerchantDefinedFieldsDefinitions(String referenceType)
                                                             throws ApiException,
                                                                    com.cybersource.authsdk.core.ConfigException

Get all merchant defined fields for a given reference type

Parameters:

referenceType - The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation (required)

Returns:

List<InlineResponse2004>

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

getMerchantDefinedFieldsDefinitionsWithHttpInfo

public ApiResponse<List<InlineResponse2004>> getMerchantDefinedFieldsDefinitionsWithHttpInfo(String referenceType)
                                                                                      throws ApiException,
                                                                                             com.cybersource.authsdk.core.ConfigException

Get all merchant defined fields for a given reference type

Parameters:

referenceType - The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation (required)

Returns:

ApiResponse<List<InlineResponse2004>>

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

getMerchantDefinedFieldsDefinitionsAsync

public okhttp3.Call getMerchantDefinedFieldsDefinitionsAsync(String referenceType,
                                                             ApiCallback<List<InlineResponse2004>> callback)
                                                      throws ApiException,
                                                             com.cybersource.authsdk.core.ConfigException

Get all merchant defined fields for a given reference type (asynchronously)

Parameters:

referenceType - The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation (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

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

putMerchantDefinedFieldsDefinitionsCall

public okhttp3.Call putMerchantDefinedFieldsDefinitionsCall(String referenceType,
                                                            Long id,
                                                            MerchantDefinedFieldCore merchantDefinedFieldCore,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException,
                                                            com.cybersource.authsdk.core.ConfigException

Build call for putMerchantDefinedFieldsDefinitions

Parameters:

referenceType - (required)

id - (required)

merchantDefinedFieldCore - (required)

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

putMerchantDefinedFieldsDefinitions

public List<InlineResponse2004> putMerchantDefinedFieldsDefinitions(String referenceType,
                                                                    Long id,
                                                                    MerchantDefinedFieldCore merchantDefinedFieldCore)
                                                             throws ApiException,
                                                                    com.cybersource.authsdk.core.ConfigException

Update a MerchantDefinedField by ID

Parameters:

referenceType - (required)

id - (required)

merchantDefinedFieldCore - (required)

Returns:

List<InlineResponse2004>

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

putMerchantDefinedFieldsDefinitionsWithHttpInfo

public ApiResponse<List<InlineResponse2004>> putMerchantDefinedFieldsDefinitionsWithHttpInfo(String referenceType,
                                                                                             Long id,
                                                                                             MerchantDefinedFieldCore merchantDefinedFieldCore)
                                                                                      throws ApiException,
                                                                                             com.cybersource.authsdk.core.ConfigException

Update a MerchantDefinedField by ID

Parameters:

referenceType - (required)

id - (required)

merchantDefinedFieldCore - (required)

Returns:

ApiResponse<List<InlineResponse2004>>

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

putMerchantDefinedFieldsDefinitionsAsync

public okhttp3.Call putMerchantDefinedFieldsDefinitionsAsync(String referenceType,
                                                             Long id,
                                                             MerchantDefinedFieldCore merchantDefinedFieldCore,
                                                             ApiCallback<List<InlineResponse2004>> callback)
                                                      throws ApiException,
                                                             com.cybersource.authsdk.core.ConfigException

Update a MerchantDefinedField by ID (asynchronously)

Parameters:

referenceType - (required)

id - (required)

merchantDefinedFieldCore - (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

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