Api

Class CustomerApi

java.lang.Object

Api.CustomerApi

public class CustomerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CustomerApi()
CustomerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	deleteCustomer(String customerTokenId, String profileId) Delete a Customer
okhttp3.Call	deleteCustomerAsync(String customerTokenId, String profileId, ApiCallback<Void> callback) Delete a Customer (asynchronously)
okhttp3.Call	deleteCustomerCall(String customerTokenId, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteCustomer
ApiResponse<Void>	deleteCustomerWithHttpInfo(String customerTokenId, String profileId) Delete a Customer
ApiClient	getApiClient()
TmsV2CustomersResponse	getCustomer(String customerTokenId, String profileId) Retrieve a Customer
okhttp3.Call	getCustomerAsync(String customerTokenId, String profileId, ApiCallback<TmsV2CustomersResponse> callback) Retrieve a Customer (asynchronously)
okhttp3.Call	getCustomerCall(String customerTokenId, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getCustomer
ApiResponse<TmsV2CustomersResponse>	getCustomerWithHttpInfo(String customerTokenId, String profileId) Retrieve a Customer
TmsV2CustomersResponse	patchCustomer(String customerTokenId, PatchCustomerRequest patchCustomerRequest, String profileId, String ifMatch) Update a Customer
okhttp3.Call	patchCustomerAsync(String customerTokenId, PatchCustomerRequest patchCustomerRequest, String profileId, String ifMatch, ApiCallback<TmsV2CustomersResponse> callback) Update a Customer (asynchronously)
okhttp3.Call	patchCustomerCall(String customerTokenId, PatchCustomerRequest patchCustomerRequest, String profileId, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for patchCustomer
ApiResponse<TmsV2CustomersResponse>	patchCustomerWithHttpInfo(String customerTokenId, PatchCustomerRequest patchCustomerRequest, String profileId, String ifMatch) Update a Customer
TmsV2CustomersResponse	postCustomer(PostCustomerRequest postCustomerRequest, String profileId) Create a Customer
okhttp3.Call	postCustomerAsync(PostCustomerRequest postCustomerRequest, String profileId, ApiCallback<TmsV2CustomersResponse> callback) Create a Customer (asynchronously)
okhttp3.Call	postCustomerCall(PostCustomerRequest postCustomerRequest, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for postCustomer
ApiResponse<TmsV2CustomersResponse>	postCustomerWithHttpInfo(PostCustomerRequest postCustomerRequest, String profileId) Create a Customer
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomerApi

public CustomerApi()

CustomerApi

public CustomerApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

deleteCustomerCall

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

Build call for deleteCustomer

Parameters:

customerTokenId - The TokenId of a customer. (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

deleteCustomer

public void deleteCustomer(String customerTokenId,
                           String profileId)
                    throws ApiException

Delete a Customer

Parameters:

customerTokenId - The TokenId of a customer. (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

deleteCustomerWithHttpInfo

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

Delete a Customer

Parameters:

customerTokenId - The TokenId of a customer. (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

deleteCustomerAsync

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

Delete a Customer (asynchronously)

Parameters:

customerTokenId - The TokenId of a customer. (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

getCustomerCall

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

Build call for getCustomer

Parameters:

customerTokenId - The TokenId of a customer. (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

getCustomer

public TmsV2CustomersResponse getCustomer(String customerTokenId,
                                          String profileId)
                                   throws ApiException

Retrieve a Customer

Parameters:

customerTokenId - The TokenId of a customer. (required)

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

Returns:

TmsV2CustomersResponse

Throws:

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

getCustomerWithHttpInfo

public ApiResponse<TmsV2CustomersResponse> getCustomerWithHttpInfo(String customerTokenId,
                                                                   String profileId)
                                                            throws ApiException

Retrieve a Customer

Parameters:

customerTokenId - The TokenId of a customer. (required)

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

Returns:

ApiResponse<TmsV2CustomersResponse>

Throws:

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

getCustomerAsync

public okhttp3.Call getCustomerAsync(String customerTokenId,
                                     String profileId,
                                     ApiCallback<TmsV2CustomersResponse> callback)
                              throws ApiException

Retrieve a Customer (asynchronously)

Parameters:

customerTokenId - The TokenId of a customer. (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

patchCustomerCall

public okhttp3.Call patchCustomerCall(String customerTokenId,
                                      PatchCustomerRequest patchCustomerRequest,
                                      String profileId,
                                      String ifMatch,
                                      ProgressResponseBody.ProgressListener progressListener,
                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                               throws ApiException

Build call for patchCustomer

Parameters:

customerTokenId - The TokenId of a customer. (required)

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

patchCustomer

public TmsV2CustomersResponse patchCustomer(String customerTokenId,
                                            PatchCustomerRequest patchCustomerRequest,
                                            String profileId,
                                            String ifMatch)
                                     throws ApiException

Update a Customer

Parameters:

customerTokenId - The TokenId of a customer. (required)

patchCustomerRequest - (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:

TmsV2CustomersResponse

Throws:

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

patchCustomerWithHttpInfo

public ApiResponse<TmsV2CustomersResponse> patchCustomerWithHttpInfo(String customerTokenId,
                                                                     PatchCustomerRequest patchCustomerRequest,
                                                                     String profileId,
                                                                     String ifMatch)
                                                              throws ApiException

Update a Customer

Parameters:

customerTokenId - The TokenId of a customer. (required)

patchCustomerRequest - (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<TmsV2CustomersResponse>

Throws:

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

patchCustomerAsync

public okhttp3.Call patchCustomerAsync(String customerTokenId,
                                       PatchCustomerRequest patchCustomerRequest,
                                       String profileId,
                                       String ifMatch,
                                       ApiCallback<TmsV2CustomersResponse> callback)
                                throws ApiException

Update a Customer (asynchronously)

Parameters:

customerTokenId - The TokenId of a customer. (required)

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

postCustomerCall

public okhttp3.Call postCustomerCall(PostCustomerRequest postCustomerRequest,
                                     String profileId,
                                     ProgressResponseBody.ProgressListener progressListener,
                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                              throws ApiException

Build call for postCustomer

Parameters:

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

postCustomer

public TmsV2CustomersResponse postCustomer(PostCustomerRequest postCustomerRequest,
                                           String profileId)
                                    throws ApiException

Create a Customer

Parameters:

postCustomerRequest - (required)

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

Returns:

TmsV2CustomersResponse

Throws:

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

postCustomerWithHttpInfo

public ApiResponse<TmsV2CustomersResponse> postCustomerWithHttpInfo(PostCustomerRequest postCustomerRequest,
                                                                    String profileId)
                                                             throws ApiException

Create a Customer

Parameters:

postCustomerRequest - (required)

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

Returns:

ApiResponse<TmsV2CustomersResponse>

Throws:

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

postCustomerAsync

public okhttp3.Call postCustomerAsync(PostCustomerRequest postCustomerRequest,
                                      String profileId,
                                      ApiCallback<TmsV2CustomersResponse> callback)
                               throws ApiException

Create a Customer (asynchronously)

Parameters:

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