Api

Class CustomerPaymentInstrumentApi

java.lang.Object

Api.CustomerPaymentInstrumentApi

public class CustomerPaymentInstrumentApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CustomerPaymentInstrumentApi()
CustomerPaymentInstrumentApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	deleteCustomerPaymentInstrument(String customerTokenId, String paymentInstrumentTokenId, String profileId) Delete a Customer Payment Instrument
okhttp3.Call	deleteCustomerPaymentInstrumentAsync(String customerTokenId, String paymentInstrumentTokenId, String profileId, ApiCallback<Void> callback) Delete a Customer Payment Instrument (asynchronously)
okhttp3.Call	deleteCustomerPaymentInstrumentCall(String customerTokenId, String paymentInstrumentTokenId, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteCustomerPaymentInstrument
ApiResponse<Void>	deleteCustomerPaymentInstrumentWithHttpInfo(String customerTokenId, String paymentInstrumentTokenId, String profileId) Delete a Customer Payment Instrument
ApiClient	getApiClient()
Tmsv2customersEmbeddedDefaultPaymentInstrument	getCustomerPaymentInstrument(String customerTokenId, String paymentInstrumentTokenId, String profileId) Retrieve a Customer Payment Instrument
okhttp3.Call	getCustomerPaymentInstrumentAsync(String customerTokenId, String paymentInstrumentTokenId, String profileId, ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrument> callback) Retrieve a Customer Payment Instrument (asynchronously)
okhttp3.Call	getCustomerPaymentInstrumentCall(String customerTokenId, String paymentInstrumentTokenId, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getCustomerPaymentInstrument
PaymentInstrumentListForCustomer	getCustomerPaymentInstrumentsList(String customerTokenId, String profileId, Long offset, Long limit) List Payment Instruments for a Customer
okhttp3.Call	getCustomerPaymentInstrumentsListAsync(String customerTokenId, String profileId, Long offset, Long limit, ApiCallback<PaymentInstrumentListForCustomer> callback) List Payment Instruments for a Customer (asynchronously)
okhttp3.Call	getCustomerPaymentInstrumentsListCall(String customerTokenId, String profileId, Long offset, Long limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getCustomerPaymentInstrumentsList
ApiResponse<PaymentInstrumentListForCustomer>	getCustomerPaymentInstrumentsListWithHttpInfo(String customerTokenId, String profileId, Long offset, Long limit) List Payment Instruments for a Customer
ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument>	getCustomerPaymentInstrumentWithHttpInfo(String customerTokenId, String paymentInstrumentTokenId, String profileId) Retrieve a Customer Payment Instrument
Tmsv2customersEmbeddedDefaultPaymentInstrument	patchCustomersPaymentInstrument(String customerTokenId, String paymentInstrumentTokenId, PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest, String profileId, String ifMatch) Update a Customer Payment Instrument
okhttp3.Call	patchCustomersPaymentInstrumentAsync(String customerTokenId, String paymentInstrumentTokenId, PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest, String profileId, String ifMatch, ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrument> callback) Update a Customer Payment Instrument (asynchronously)
okhttp3.Call	patchCustomersPaymentInstrumentCall(String customerTokenId, String paymentInstrumentTokenId, PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest, String profileId, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for patchCustomersPaymentInstrument
ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument>	patchCustomersPaymentInstrumentWithHttpInfo(String customerTokenId, String paymentInstrumentTokenId, PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest, String profileId, String ifMatch) Update a Customer Payment Instrument
Tmsv2customersEmbeddedDefaultPaymentInstrument	postCustomerPaymentInstrument(String customerTokenId, PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest, String profileId) Create a Customer Payment Instrument
okhttp3.Call	postCustomerPaymentInstrumentAsync(String customerTokenId, PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest, String profileId, ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrument> callback) Create a Customer Payment Instrument (asynchronously)
okhttp3.Call	postCustomerPaymentInstrumentCall(String customerTokenId, PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for postCustomerPaymentInstrument
ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument>	postCustomerPaymentInstrumentWithHttpInfo(String customerTokenId, PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest, String profileId) Create a Customer Payment Instrument
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomerPaymentInstrumentApi

public CustomerPaymentInstrumentApi()

CustomerPaymentInstrumentApi

public CustomerPaymentInstrumentApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

deleteCustomerPaymentInstrumentCall

public okhttp3.Call deleteCustomerPaymentInstrumentCall(String customerTokenId,
                                                        String paymentInstrumentTokenId,
                                                        String profileId,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for deleteCustomerPaymentInstrument

Parameters:

customerTokenId - The TokenId of a customer. (required)

paymentInstrumentTokenId - The TokenId of a payment instrument. (required)

profileId - The id of a profile containing user specific TMS configuration. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteCustomerPaymentInstrument

public void deleteCustomerPaymentInstrument(String customerTokenId,
                                            String paymentInstrumentTokenId,
                                            String profileId)
                                     throws ApiException

Delete a Customer Payment Instrument

Parameters:

customerTokenId - The TokenId of a customer. (required)

paymentInstrumentTokenId - The TokenId of a payment instrument. (required)

profileId - The id of a profile containing user specific TMS configuration. (optional)

Throws:

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

deleteCustomerPaymentInstrumentWithHttpInfo

public ApiResponse<Void> deleteCustomerPaymentInstrumentWithHttpInfo(String customerTokenId,
                                                                     String paymentInstrumentTokenId,
                                                                     String profileId)
                                                              throws ApiException

Delete a Customer Payment Instrument

Parameters:

customerTokenId - The TokenId of a customer. (required)

paymentInstrumentTokenId - The TokenId of a payment instrument. (required)

profileId - The id of a profile containing user specific TMS configuration. (optional)

Returns:

ApiResponse<Void>

Throws:

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

deleteCustomerPaymentInstrumentAsync

public okhttp3.Call deleteCustomerPaymentInstrumentAsync(String customerTokenId,
                                                         String paymentInstrumentTokenId,
                                                         String profileId,
                                                         ApiCallback<Void> callback)
                                                  throws ApiException

Delete a Customer Payment Instrument (asynchronously)

Parameters:

customerTokenId - The TokenId of a customer. (required)

paymentInstrumentTokenId - The TokenId of a payment instrument. (required)

profileId - The id of a profile containing user specific TMS configuration. (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

getCustomerPaymentInstrumentCall

public okhttp3.Call getCustomerPaymentInstrumentCall(String customerTokenId,
                                                     String paymentInstrumentTokenId,
                                                     String profileId,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for getCustomerPaymentInstrument

Parameters:

customerTokenId - The TokenId of a customer. (required)

paymentInstrumentTokenId - The TokenId of a payment instrument. (required)

profileId - The id of a profile containing user specific TMS configuration. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getCustomerPaymentInstrument

public Tmsv2customersEmbeddedDefaultPaymentInstrument getCustomerPaymentInstrument(String customerTokenId,
                                                                                   String paymentInstrumentTokenId,
                                                                                   String profileId)
                                                                            throws ApiException

Retrieve a Customer Payment Instrument

Parameters:

customerTokenId - The TokenId of a customer. (required)

paymentInstrumentTokenId - The TokenId of a payment instrument. (required)

profileId - The id of a profile containing user specific TMS configuration. (optional)

Returns:

Tmsv2customersEmbeddedDefaultPaymentInstrument

Throws:

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

getCustomerPaymentInstrumentWithHttpInfo

public ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument> getCustomerPaymentInstrumentWithHttpInfo(String customerTokenId,
                                                                                                            String paymentInstrumentTokenId,
                                                                                                            String profileId)
                                                                                                     throws ApiException

Retrieve a Customer Payment Instrument

Parameters:

customerTokenId - The TokenId of a customer. (required)

paymentInstrumentTokenId - The TokenId of a payment instrument. (required)

profileId - The id of a profile containing user specific TMS configuration. (optional)

Returns:

ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument>

Throws:

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

getCustomerPaymentInstrumentAsync

public okhttp3.Call getCustomerPaymentInstrumentAsync(String customerTokenId,
                                                      String paymentInstrumentTokenId,
                                                      String profileId,
                                                      ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrument> callback)
                                               throws ApiException

Retrieve a Customer Payment Instrument (asynchronously)

Parameters:

customerTokenId - The TokenId of a customer. (required)

paymentInstrumentTokenId - The TokenId of a payment instrument. (required)

profileId - The id of a profile containing user specific TMS configuration. (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

getCustomerPaymentInstrumentsListCall

public okhttp3.Call getCustomerPaymentInstrumentsListCall(String customerTokenId,
                                                          String profileId,
                                                          Long offset,
                                                          Long limit,
                                                          ProgressResponseBody.ProgressListener progressListener,
                                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                   throws ApiException

Build call for getCustomerPaymentInstrumentsList

Parameters:

customerTokenId - The TokenId of a customer. (required)

profileId - The id of a profile containing user specific TMS configuration. (optional)

offset - Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0)

limit - The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getCustomerPaymentInstrumentsList

public PaymentInstrumentListForCustomer getCustomerPaymentInstrumentsList(String customerTokenId,
                                                                          String profileId,
                                                                          Long offset,
                                                                          Long limit)
                                                                   throws ApiException

List Payment Instruments for a Customer

Parameters:

customerTokenId - The TokenId of a customer. (required)

profileId - The id of a profile containing user specific TMS configuration. (optional)

offset - Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0)

limit - The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20)

Returns:

PaymentInstrumentListForCustomer

Throws:

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

getCustomerPaymentInstrumentsListWithHttpInfo

public ApiResponse<PaymentInstrumentListForCustomer> getCustomerPaymentInstrumentsListWithHttpInfo(String customerTokenId,
                                                                                                   String profileId,
                                                                                                   Long offset,
                                                                                                   Long limit)
                                                                                            throws ApiException

List Payment Instruments for a Customer

Parameters:

customerTokenId - The TokenId of a customer. (required)

profileId - The id of a profile containing user specific TMS configuration. (optional)

offset - Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0)

limit - The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20)

Returns:

ApiResponse<PaymentInstrumentListForCustomer>

Throws:

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

getCustomerPaymentInstrumentsListAsync

public okhttp3.Call getCustomerPaymentInstrumentsListAsync(String customerTokenId,
                                                           String profileId,
                                                           Long offset,
                                                           Long limit,
                                                           ApiCallback<PaymentInstrumentListForCustomer> callback)
                                                    throws ApiException

List Payment Instruments for a Customer (asynchronously)

Parameters:

customerTokenId - The TokenId of a customer. (required)

profileId - The id of a profile containing user specific TMS configuration. (optional)

offset - Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0)

limit - The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20)

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

patchCustomersPaymentInstrumentCall

public okhttp3.Call patchCustomersPaymentInstrumentCall(String customerTokenId,
                                                        String paymentInstrumentTokenId,
                                                        PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest,
                                                        String profileId,
                                                        String ifMatch,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for patchCustomersPaymentInstrument

Parameters:

customerTokenId - The TokenId of a customer. (required)

paymentInstrumentTokenId - The TokenId of a payment instrument. (required)

patchCustomerPaymentInstrumentRequest - (required)

profileId - The id of a profile containing user specific TMS configuration. (optional)

ifMatch - Contains an ETag value from a GET request to make the request conditional. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

patchCustomersPaymentInstrument

public Tmsv2customersEmbeddedDefaultPaymentInstrument patchCustomersPaymentInstrument(String customerTokenId,
                                                                                      String paymentInstrumentTokenId,
                                                                                      PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest,
                                                                                      String profileId,
                                                                                      String ifMatch)
                                                                               throws ApiException

Update a Customer Payment Instrument

Parameters:

customerTokenId - The TokenId of a customer. (required)

paymentInstrumentTokenId - The TokenId of a payment instrument. (required)

patchCustomerPaymentInstrumentRequest - (required)

profileId - The id of a profile containing user specific TMS configuration. (optional)

ifMatch - Contains an ETag value from a GET request to make the request conditional. (optional)

Returns:

Tmsv2customersEmbeddedDefaultPaymentInstrument

Throws:

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

patchCustomersPaymentInstrumentWithHttpInfo

public ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument> patchCustomersPaymentInstrumentWithHttpInfo(String customerTokenId,
                                                                                                               String paymentInstrumentTokenId,
                                                                                                               PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest,
                                                                                                               String profileId,
                                                                                                               String ifMatch)
                                                                                                        throws ApiException

Update a Customer Payment Instrument

Parameters:

customerTokenId - The TokenId of a customer. (required)

paymentInstrumentTokenId - The TokenId of a payment instrument. (required)

patchCustomerPaymentInstrumentRequest - (required)

profileId - The id of a profile containing user specific TMS configuration. (optional)

ifMatch - Contains an ETag value from a GET request to make the request conditional. (optional)

Returns:

ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument>

Throws:

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

patchCustomersPaymentInstrumentAsync

public okhttp3.Call patchCustomersPaymentInstrumentAsync(String customerTokenId,
                                                         String paymentInstrumentTokenId,
                                                         PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest,
                                                         String profileId,
                                                         String ifMatch,
                                                         ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrument> callback)
                                                  throws ApiException

Update a Customer Payment Instrument (asynchronously)

Parameters:

customerTokenId - The TokenId of a customer. (required)

paymentInstrumentTokenId - The TokenId of a payment instrument. (required)

patchCustomerPaymentInstrumentRequest - (required)

profileId - The id of a profile containing user specific TMS configuration. (optional)

ifMatch - Contains an ETag value from a GET request to make the request conditional. (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

postCustomerPaymentInstrumentCall

public okhttp3.Call postCustomerPaymentInstrumentCall(String customerTokenId,
                                                      PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest,
                                                      String profileId,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException

Build call for postCustomerPaymentInstrument

Parameters:

customerTokenId - The TokenId of a customer. (required)

postCustomerPaymentInstrumentRequest - (required)

profileId - The id of a profile containing user specific TMS configuration. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

postCustomerPaymentInstrument

public Tmsv2customersEmbeddedDefaultPaymentInstrument postCustomerPaymentInstrument(String customerTokenId,
                                                                                    PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest,
                                                                                    String profileId)
                                                                             throws ApiException

Create a Customer Payment Instrument

Parameters:

customerTokenId - The TokenId of a customer. (required)

postCustomerPaymentInstrumentRequest - (required)

profileId - The id of a profile containing user specific TMS configuration. (optional)

Returns:

Tmsv2customersEmbeddedDefaultPaymentInstrument

Throws:

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

postCustomerPaymentInstrumentWithHttpInfo

public ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument> postCustomerPaymentInstrumentWithHttpInfo(String customerTokenId,
                                                                                                             PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest,
                                                                                                             String profileId)
                                                                                                      throws ApiException

Create a Customer Payment Instrument

Parameters:

customerTokenId - The TokenId of a customer. (required)

postCustomerPaymentInstrumentRequest - (required)

profileId - The id of a profile containing user specific TMS configuration. (optional)

Returns:

ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument>

Throws:

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

postCustomerPaymentInstrumentAsync

public okhttp3.Call postCustomerPaymentInstrumentAsync(String customerTokenId,
                                                       PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest,
                                                       String profileId,
                                                       ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrument> callback)
                                                throws ApiException

Create a Customer Payment Instrument (asynchronously)

Parameters:

customerTokenId - The TokenId of a customer. (required)

postCustomerPaymentInstrumentRequest - (required)

profileId - The id of a profile containing user specific TMS configuration. (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