Api

Class InstrumentIdentifierApi

java.lang.Object

Api.InstrumentIdentifierApi

public class InstrumentIdentifierApi
extends Object

Constructor Summary

Constructors

Constructor and Description
InstrumentIdentifierApi()
InstrumentIdentifierApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
InlineResponse2007	instrumentidentifiersPost(String profileId, Body body) Create an Instrument Identifier
com.squareup.okhttp.Call	instrumentidentifiersPostAsync(String profileId, Body body, ApiCallback<InlineResponse2007> callback) Create an Instrument Identifier (asynchronously)
com.squareup.okhttp.Call	instrumentidentifiersPostCall(String profileId, Body body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for instrumentidentifiersPost
ApiResponse<InlineResponse2007>	instrumentidentifiersPostWithHttpInfo(String profileId, Body body) Create an Instrument Identifier
void	instrumentidentifiersTokenIdDelete(String profileId, String tokenId) Delete an Instrument Identifier
com.squareup.okhttp.Call	instrumentidentifiersTokenIdDeleteAsync(String profileId, String tokenId, ApiCallback<Void> callback) Delete an Instrument Identifier (asynchronously)
com.squareup.okhttp.Call	instrumentidentifiersTokenIdDeleteCall(String profileId, String tokenId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for instrumentidentifiersTokenIdDelete
ApiResponse<Void>	instrumentidentifiersTokenIdDeleteWithHttpInfo(String profileId, String tokenId) Delete an Instrument Identifier
InlineResponse2007	instrumentidentifiersTokenIdGet(String profileId, String tokenId) Retrieve an Instrument Identifier
com.squareup.okhttp.Call	instrumentidentifiersTokenIdGetAsync(String profileId, String tokenId, ApiCallback<InlineResponse2007> callback) Retrieve an Instrument Identifier (asynchronously)
com.squareup.okhttp.Call	instrumentidentifiersTokenIdGetCall(String profileId, String tokenId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for instrumentidentifiersTokenIdGet
ApiResponse<InlineResponse2007>	instrumentidentifiersTokenIdGetWithHttpInfo(String profileId, String tokenId) Retrieve an Instrument Identifier
InlineResponse2007	instrumentidentifiersTokenIdPatch(String profileId, String tokenId, Body1 body) Update a Instrument Identifier
com.squareup.okhttp.Call	instrumentidentifiersTokenIdPatchAsync(String profileId, String tokenId, Body1 body, ApiCallback<InlineResponse2007> callback) Update a Instrument Identifier (asynchronously)
com.squareup.okhttp.Call	instrumentidentifiersTokenIdPatchCall(String profileId, String tokenId, Body1 body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for instrumentidentifiersTokenIdPatch
ApiResponse<InlineResponse2007>	instrumentidentifiersTokenIdPatchWithHttpInfo(String profileId, String tokenId, Body1 body) Update a Instrument Identifier
InlineResponse2008	instrumentidentifiersTokenIdPaymentinstrumentsGet(String profileId, String tokenId, String offset, String limit) Retrieve all Payment Instruments associated with an Instrument Identifier
com.squareup.okhttp.Call	instrumentidentifiersTokenIdPaymentinstrumentsGetAsync(String profileId, String tokenId, String offset, String limit, ApiCallback<InlineResponse2008> callback) Retrieve all Payment Instruments associated with an Instrument Identifier (asynchronously)
com.squareup.okhttp.Call	instrumentidentifiersTokenIdPaymentinstrumentsGetCall(String profileId, String tokenId, String offset, String limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for instrumentidentifiersTokenIdPaymentinstrumentsGet
ApiResponse<InlineResponse2008>	instrumentidentifiersTokenIdPaymentinstrumentsGetWithHttpInfo(String profileId, String tokenId, String offset, String limit) Retrieve all Payment Instruments associated with an Instrument 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

InstrumentIdentifierApi

public InstrumentIdentifierApi()

InstrumentIdentifierApi

public InstrumentIdentifierApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

instrumentidentifiersPostCall

public com.squareup.okhttp.Call instrumentidentifiersPostCall(String profileId,
                                                              Body body,
                                                              ProgressResponseBody.ProgressListener progressListener,
                                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                       throws ApiException

Build call for instrumentidentifiersPost

Parameters:

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

body - Please specify either a Card or Bank Account. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

instrumentidentifiersPost

public InlineResponse2007 instrumentidentifiersPost(String profileId,
                                                    Body body)
                                             throws ApiException

Create an Instrument Identifier

Parameters:

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

body - Please specify either a Card or Bank Account. (optional)

Returns:

InlineResponse2007 generated.

Throws:

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

instrumentidentifiersPostWithHttpInfo

public ApiResponse<InlineResponse2007> instrumentidentifiersPostWithHttpInfo(String profileId,
                                                                             Body body)
                                                                      throws ApiException

Create an Instrument Identifier

Parameters:

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

body - Please specify either a Card or Bank Account. (optional)

Returns:

ApiResponse - InlineResponse2007.

Throws:

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

instrumentidentifiersPostAsync

public com.squareup.okhttp.Call instrumentidentifiersPostAsync(String profileId,
                                                               Body body,
                                                               ApiCallback<InlineResponse2007> callback)
                                                        throws ApiException

Create an Instrument Identifier (asynchronously)

Parameters:

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

body - Please specify either a Card or Bank Account. (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

instrumentidentifiersTokenIdDeleteCall

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

Build call for instrumentidentifiersTokenIdDelete

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

instrumentidentifiersTokenIdDelete

public void instrumentidentifiersTokenIdDelete(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

instrumentidentifiersTokenIdDeleteWithHttpInfo

public ApiResponse<Void> instrumentidentifiersTokenIdDeleteWithHttpInfo(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

instrumentidentifiersTokenIdDeleteAsync

public com.squareup.okhttp.Call instrumentidentifiersTokenIdDeleteAsync(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

instrumentidentifiersTokenIdGetCall

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

Build call for instrumentidentifiersTokenIdGet

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

instrumentidentifiersTokenIdGet

public InlineResponse2007 instrumentidentifiersTokenIdGet(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:

InlineResponse2007 generated.

Throws:

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

instrumentidentifiersTokenIdGetWithHttpInfo

public ApiResponse<InlineResponse2007> instrumentidentifiersTokenIdGetWithHttpInfo(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 - InlineResponse2007.

Throws:

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

instrumentidentifiersTokenIdGetAsync

public com.squareup.okhttp.Call instrumentidentifiersTokenIdGetAsync(String profileId,
                                                                     String tokenId,
                                                                     ApiCallback<InlineResponse2007> 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

instrumentidentifiersTokenIdPatchCall

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

Build call for instrumentidentifiersTokenIdPatch

Parameters:

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

tokenId - The TokenId of an Instrument Identifier (required)

body - Please 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

instrumentidentifiersTokenIdPatch

public InlineResponse2007 instrumentidentifiersTokenIdPatch(String profileId,
                                                            String tokenId,
                                                            Body1 body)
                                                     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)

body - Please specify the previous transaction Id to update. (required)

Returns:

InlineResponse2007 generated.

Throws:

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

instrumentidentifiersTokenIdPatchWithHttpInfo

public ApiResponse<InlineResponse2007> instrumentidentifiersTokenIdPatchWithHttpInfo(String profileId,
                                                                                     String tokenId,
                                                                                     Body1 body)
                                                                              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)

body - Please specify the previous transaction Id to update. (required)

Returns:

ApiResponse - InlineResponse2007.

Throws:

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

instrumentidentifiersTokenIdPatchAsync

public com.squareup.okhttp.Call instrumentidentifiersTokenIdPatchAsync(String profileId,
                                                                       String tokenId,
                                                                       Body1 body,
                                                                       ApiCallback<InlineResponse2007> 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)

body - Please 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

instrumentidentifiersTokenIdPaymentinstrumentsGetCall

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

Build call for instrumentidentifiersTokenIdPaymentinstrumentsGet

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)

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

instrumentidentifiersTokenIdPaymentinstrumentsGet

public InlineResponse2008 instrumentidentifiersTokenIdPaymentinstrumentsGet(String profileId,
                                                                            String tokenId,
                                                                            String offset,
                                                                            String limit)
                                                                     throws ApiException

Retrieve all Payment Instruments associated with an Instrument Identifier

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)

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:

InlineResponse2008 generated.

Throws:

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

instrumentidentifiersTokenIdPaymentinstrumentsGetWithHttpInfo

public ApiResponse<InlineResponse2008> instrumentidentifiersTokenIdPaymentinstrumentsGetWithHttpInfo(String profileId,
                                                                                                     String tokenId,
                                                                                                     String offset,
                                                                                                     String limit)
                                                                                              throws ApiException

Retrieve all Payment Instruments associated with an Instrument Identifier

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)

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 - InlineResponse2008.

Throws:

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

instrumentidentifiersTokenIdPaymentinstrumentsGetAsync

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

Retrieve all Payment Instruments associated with 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)

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

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