InstrumentIdentifierApi (cybersource-rest-client-java 0.0.13 API)

java.lang.Object
- Api.InstrumentIdentifierApi

public class InstrumentIdentifierApi
extends Object

Constructor Summary

Constructors
Constructor and Description

InstrumentIdentifierApi()

InstrumentIdentifierApi(ApiClient apiClient)

Constructors
Constructor and Description
`InstrumentIdentifierApi()`
`InstrumentIdentifierApi(ApiClient apiClient)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TmsV1InstrumentIdentifiersPost200Response`	`createInstrumentIdentifier(String profileId, CreateInstrumentIdentifierRequest createInstrumentIdentifierRequest)` Create an Instrument Identifier
`com.squareup.okhttp.Call`	`createInstrumentIdentifierAsync(String profileId, CreateInstrumentIdentifierRequest createInstrumentIdentifierRequest, ApiCallback<TmsV1InstrumentIdentifiersPost200Response> callback)` Create an Instrument Identifier (asynchronously)
`com.squareup.okhttp.Call`	`createInstrumentIdentifierCall(String profileId, CreateInstrumentIdentifierRequest createInstrumentIdentifierRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for createInstrumentIdentifier
`ApiResponse<TmsV1InstrumentIdentifiersPost200Response>`	`createInstrumentIdentifierWithHttpInfo(String profileId, CreateInstrumentIdentifierRequest createInstrumentIdentifierRequest)` Create an Instrument Identifier
`void`	`deleteInstrumentIdentifier(String profileId, String tokenId)` Delete an Instrument Identifier
`com.squareup.okhttp.Call`	`deleteInstrumentIdentifierAsync(String profileId, String tokenId, ApiCallback<Void> callback)` Delete an Instrument Identifier (asynchronously)
`com.squareup.okhttp.Call`	`deleteInstrumentIdentifierCall(String profileId, String tokenId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for deleteInstrumentIdentifier
`ApiResponse<Void>`	`deleteInstrumentIdentifierWithHttpInfo(String profileId, String tokenId)` Delete an Instrument Identifier
`TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response`	`getAllPaymentInstruments(String profileId, String tokenId, Long offset, Long limit)` Retrieve all Payment Instruments
`com.squareup.okhttp.Call`	`getAllPaymentInstrumentsAsync(String profileId, String tokenId, Long offset, Long limit, ApiCallback<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response> callback)` Retrieve all Payment Instruments (asynchronously)
`com.squareup.okhttp.Call`	`getAllPaymentInstrumentsCall(String profileId, String tokenId, Long offset, Long limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getAllPaymentInstruments
`ApiResponse<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response>`	`getAllPaymentInstrumentsWithHttpInfo(String profileId, String tokenId, Long offset, Long limit)` Retrieve all Payment Instruments
`ApiClient`	`getApiClient()`
`TmsV1InstrumentIdentifiersPost200Response`	`getInstrumentIdentifier(String profileId, String tokenId)` Retrieve an Instrument Identifier
`com.squareup.okhttp.Call`	`getInstrumentIdentifierAsync(String profileId, String tokenId, ApiCallback<TmsV1InstrumentIdentifiersPost200Response> callback)` Retrieve an Instrument Identifier (asynchronously)
`com.squareup.okhttp.Call`	`getInstrumentIdentifierCall(String profileId, String tokenId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getInstrumentIdentifier
`ApiResponse<TmsV1InstrumentIdentifiersPost200Response>`	`getInstrumentIdentifierWithHttpInfo(String profileId, String tokenId)` Retrieve an Instrument Identifier
`void`	`setApiClient(ApiClient apiClient)`
`TmsV1InstrumentIdentifiersPost200Response`	`updateInstrumentIdentifier(String profileId, String tokenId, UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest)` Update a Instrument Identifier
`com.squareup.okhttp.Call`	`updateInstrumentIdentifierAsync(String profileId, String tokenId, UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest, ApiCallback<TmsV1InstrumentIdentifiersPost200Response> callback)` Update a Instrument Identifier (asynchronously)
`com.squareup.okhttp.Call`	`updateInstrumentIdentifierCall(String profileId, String tokenId, UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for updateInstrumentIdentifier
`ApiResponse<TmsV1InstrumentIdentifiersPost200Response>`	`updateInstrumentIdentifierWithHttpInfo(String profileId, String tokenId, UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest)` Update a Instrument Identifier

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InstrumentIdentifierApi
```
public InstrumentIdentifierApi()
```

InstrumentIdentifierApi

public InstrumentIdentifierApi(ApiClient apiClient)

Method Detail

getApiClient
```
public ApiClient getApiClient()
```

setApiClient

public void setApiClient(ApiClient apiClient)

createInstrumentIdentifierCall

public com.squareup.okhttp.Call createInstrumentIdentifierCall(String profileId,
                                                               CreateInstrumentIdentifierRequest createInstrumentIdentifierRequest,
                                                               ProgressResponseBody.ProgressListener progressListener,
                                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                        throws ApiException

Build call for createInstrumentIdentifier

Parameters:: profileId - The id of a profile containing user specific TMS configuration. (required); createInstrumentIdentifierRequest - Please specify either a Card, Bank Account or Enrollable Card (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

createInstrumentIdentifier

public TmsV1InstrumentIdentifiersPost200Response createInstrumentIdentifier(String profileId,
                                                                            CreateInstrumentIdentifierRequest createInstrumentIdentifierRequest)
                                                                     throws ApiException

Create an Instrument Identifier

Parameters:: profileId - The id of a profile containing user specific TMS configuration. (required); createInstrumentIdentifierRequest - Please specify either a Card, Bank Account or Enrollable Card (required)
Returns:: TmsV1InstrumentIdentifiersPost200Response
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createInstrumentIdentifierWithHttpInfo

public ApiResponse<TmsV1InstrumentIdentifiersPost200Response> createInstrumentIdentifierWithHttpInfo(String profileId,
                                                                                                     CreateInstrumentIdentifierRequest createInstrumentIdentifierRequest)
                                                                                              throws ApiException

Create an Instrument Identifier

Parameters:: profileId - The id of a profile containing user specific TMS configuration. (required); createInstrumentIdentifierRequest - Please specify either a Card, Bank Account or Enrollable Card (required)
Returns:: ApiResponse<TmsV1InstrumentIdentifiersPost200Response>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createInstrumentIdentifierAsync

public com.squareup.okhttp.Call createInstrumentIdentifierAsync(String profileId,
                                                                CreateInstrumentIdentifierRequest createInstrumentIdentifierRequest,
                                                                ApiCallback<TmsV1InstrumentIdentifiersPost200Response> callback)
                                                         throws ApiException

Create an Instrument Identifier (asynchronously)

Parameters:: profileId - The id of a profile containing user specific TMS configuration. (required); createInstrumentIdentifierRequest - Please specify either a Card, Bank Account or Enrollable Card (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

deleteInstrumentIdentifierCall

public com.squareup.okhttp.Call deleteInstrumentIdentifierCall(String profileId,
                                                               String tokenId,
                                                               ProgressResponseBody.ProgressListener progressListener,
                                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                        throws ApiException

Build call for deleteInstrumentIdentifier

Parameters:: profileId - The id of a profile containing user specific TMS configuration. (required); tokenId - The TokenId of an Instrument Identifier. (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

deleteInstrumentIdentifier
```
public void deleteInstrumentIdentifier(String profileId,
                                       String tokenId)
                                throws ApiException
```
Delete an Instrument Identifier

Parameters:

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

tokenId - The TokenId of an Instrument Identifier. (required)

Throws:

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

deleteInstrumentIdentifierWithHttpInfo
```
public ApiResponse<Void> deleteInstrumentIdentifierWithHttpInfo(String profileId,
                                                                String tokenId)
                                                         throws ApiException
```
Delete an Instrument Identifier

Parameters:

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

tokenId - The TokenId of an Instrument Identifier. (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteInstrumentIdentifierAsync

public com.squareup.okhttp.Call deleteInstrumentIdentifierAsync(String profileId,
                                                                String tokenId,
                                                                ApiCallback<Void> callback)
                                                         throws ApiException

Delete an Instrument Identifier (asynchronously)

Parameters:: profileId - The id of a profile containing user specific TMS configuration. (required); tokenId - The TokenId of an Instrument Identifier. (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

getAllPaymentInstrumentsCall

public com.squareup.okhttp.Call getAllPaymentInstrumentsCall(String profileId,
                                                             String tokenId,
                                                             Long offset,
                                                             Long limit,
                                                             ProgressResponseBody.ProgressListener progressListener,
                                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                      throws ApiException

Build call for getAllPaymentInstruments

Parameters:: profileId - The id of a profile containing user specific TMS configuration. (required); tokenId - The TokenId of an Instrument Identifier. (required); offset - Starting Payment Instrument 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 of Payment Instruments 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

getAllPaymentInstruments

public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response getAllPaymentInstruments(String profileId,
                                                                                           String tokenId,
                                                                                           Long offset,
                                                                                           Long limit)
                                                                                    throws ApiException

Retrieve all Payment Instruments

Parameters:: profileId - The id of a profile containing user specific TMS configuration. (required); tokenId - The TokenId of an Instrument Identifier. (required); offset - Starting Payment Instrument 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 of Payment Instruments 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:: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAllPaymentInstrumentsWithHttpInfo

public ApiResponse<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response> getAllPaymentInstrumentsWithHttpInfo(String profileId,
                                                                                                                    String tokenId,
                                                                                                                    Long offset,
                                                                                                                    Long limit)
                                                                                                             throws ApiException

Retrieve all Payment Instruments

Parameters:: profileId - The id of a profile containing user specific TMS configuration. (required); tokenId - The TokenId of an Instrument Identifier. (required); offset - Starting Payment Instrument 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 of Payment Instruments 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<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAllPaymentInstrumentsAsync

public com.squareup.okhttp.Call getAllPaymentInstrumentsAsync(String profileId,
                                                              String tokenId,
                                                              Long offset,
                                                              Long limit,
                                                              ApiCallback<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response> callback)
                                                       throws ApiException

Retrieve all Payment Instruments (asynchronously)

Parameters:: profileId - The id of a profile containing user specific TMS configuration. (required); tokenId - The TokenId of an Instrument Identifier. (required); offset - Starting Payment Instrument 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 of Payment Instruments 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

getInstrumentIdentifierCall

public com.squareup.okhttp.Call getInstrumentIdentifierCall(String profileId,
                                                            String tokenId,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for getInstrumentIdentifier

Parameters:: profileId - The id of a profile containing user specific TMS configuration. (required); tokenId - The TokenId of an Instrument Identifier. (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

getInstrumentIdentifier
```
public TmsV1InstrumentIdentifiersPost200Response getInstrumentIdentifier(String profileId,
                                                                         String tokenId)
                                                                  throws ApiException
```
Retrieve an Instrument Identifier

Parameters:

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

tokenId - The TokenId of an Instrument Identifier. (required)

Returns:

TmsV1InstrumentIdentifiersPost200Response

Throws:

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

getInstrumentIdentifierWithHttpInfo

public ApiResponse<TmsV1InstrumentIdentifiersPost200Response> getInstrumentIdentifierWithHttpInfo(String profileId,
                                                                                                  String tokenId)
                                                                                           throws ApiException

Retrieve an Instrument Identifier

Parameters:: profileId - The id of a profile containing user specific TMS configuration. (required); tokenId - The TokenId of an Instrument Identifier. (required)
Returns:: ApiResponse<TmsV1InstrumentIdentifiersPost200Response>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getInstrumentIdentifierAsync

public com.squareup.okhttp.Call getInstrumentIdentifierAsync(String profileId,
                                                             String tokenId,
                                                             ApiCallback<TmsV1InstrumentIdentifiersPost200Response> callback)
                                                      throws ApiException

Retrieve an Instrument Identifier (asynchronously)

Parameters:: profileId - The id of a profile containing user specific TMS configuration. (required); tokenId - The TokenId of an Instrument Identifier. (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

updateInstrumentIdentifierCall

public com.squareup.okhttp.Call updateInstrumentIdentifierCall(String profileId,
                                                               String tokenId,
                                                               UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest,
                                                               ProgressResponseBody.ProgressListener progressListener,
                                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                        throws ApiException

Build call for updateInstrumentIdentifier

Parameters:: profileId - The id of a profile containing user specific TMS configuration. (required); tokenId - The TokenId of an Instrument Identifier. (required); updateInstrumentIdentifierRequest - Specify the previous transaction ID to update. (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

updateInstrumentIdentifier

public TmsV1InstrumentIdentifiersPost200Response updateInstrumentIdentifier(String profileId,
                                                                            String tokenId,
                                                                            UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest)
                                                                     throws ApiException

Update a Instrument Identifier

Parameters:: profileId - The id of a profile containing user specific TMS configuration. (required); tokenId - The TokenId of an Instrument Identifier. (required); updateInstrumentIdentifierRequest - Specify the previous transaction ID to update. (required)
Returns:: TmsV1InstrumentIdentifiersPost200Response
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

updateInstrumentIdentifierWithHttpInfo

public ApiResponse<TmsV1InstrumentIdentifiersPost200Response> updateInstrumentIdentifierWithHttpInfo(String profileId,
                                                                                                     String tokenId,
                                                                                                     UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest)
                                                                                              throws ApiException

Update a Instrument Identifier

Parameters:: profileId - The id of a profile containing user specific TMS configuration. (required); tokenId - The TokenId of an Instrument Identifier. (required); updateInstrumentIdentifierRequest - Specify the previous transaction ID to update. (required)
Returns:: ApiResponse<TmsV1InstrumentIdentifiersPost200Response>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

updateInstrumentIdentifierAsync

public com.squareup.okhttp.Call updateInstrumentIdentifierAsync(String profileId,
                                                                String tokenId,
                                                                UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest,
                                                                ApiCallback<TmsV1InstrumentIdentifiersPost200Response> callback)
                                                         throws ApiException

Update a Instrument Identifier (asynchronously)

Parameters:: profileId - The id of a profile containing user specific TMS configuration. (required); tokenId - The TokenId of an Instrument Identifier. (required); updateInstrumentIdentifierRequest - Specify the previous transaction ID to update. (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

Class InstrumentIdentifierApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InstrumentIdentifierApi

InstrumentIdentifierApi

Method Detail

getApiClient

setApiClient

createInstrumentIdentifierCall

createInstrumentIdentifier

createInstrumentIdentifierWithHttpInfo

createInstrumentIdentifierAsync

deleteInstrumentIdentifierCall

deleteInstrumentIdentifier

deleteInstrumentIdentifierWithHttpInfo

deleteInstrumentIdentifierAsync

getAllPaymentInstrumentsCall

getAllPaymentInstruments

getAllPaymentInstrumentsWithHttpInfo

getAllPaymentInstrumentsAsync

getInstrumentIdentifierCall

getInstrumentIdentifier

getInstrumentIdentifierWithHttpInfo

getInstrumentIdentifierAsync

updateInstrumentIdentifierCall

updateInstrumentIdentifier

updateInstrumentIdentifierWithHttpInfo

updateInstrumentIdentifierAsync