Api

Class CustomerShippingAddressApi

java.lang.Object

Api.CustomerShippingAddressApi

public class CustomerShippingAddressApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CustomerShippingAddressApi()
CustomerShippingAddressApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	deleteCustomerShippingAddress(String customerTokenId, String shippingAddressTokenId, String profileId) Delete a Customer Shipping Address
okhttp3.Call	deleteCustomerShippingAddressAsync(String customerTokenId, String shippingAddressTokenId, String profileId, ApiCallback<Void> callback) Delete a Customer Shipping Address (asynchronously)
okhttp3.Call	deleteCustomerShippingAddressCall(String customerTokenId, String shippingAddressTokenId, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteCustomerShippingAddress
ApiResponse<Void>	deleteCustomerShippingAddressWithHttpInfo(String customerTokenId, String shippingAddressTokenId, String profileId) Delete a Customer Shipping Address
ApiClient	getApiClient()
Tmsv2customersEmbeddedDefaultShippingAddress	getCustomerShippingAddress(String customerTokenId, String shippingAddressTokenId, String profileId) Retrieve a Customer Shipping Address
okhttp3.Call	getCustomerShippingAddressAsync(String customerTokenId, String shippingAddressTokenId, String profileId, ApiCallback<Tmsv2customersEmbeddedDefaultShippingAddress> callback) Retrieve a Customer Shipping Address (asynchronously)
okhttp3.Call	getCustomerShippingAddressCall(String customerTokenId, String shippingAddressTokenId, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getCustomerShippingAddress
ShippingAddressListForCustomer	getCustomerShippingAddressesList(String customerTokenId, String profileId, Long offset, Long limit) List Shipping Addresses for a Customer
okhttp3.Call	getCustomerShippingAddressesListAsync(String customerTokenId, String profileId, Long offset, Long limit, ApiCallback<ShippingAddressListForCustomer> callback) List Shipping Addresses for a Customer (asynchronously)
okhttp3.Call	getCustomerShippingAddressesListCall(String customerTokenId, String profileId, Long offset, Long limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getCustomerShippingAddressesList
ApiResponse<ShippingAddressListForCustomer>	getCustomerShippingAddressesListWithHttpInfo(String customerTokenId, String profileId, Long offset, Long limit) List Shipping Addresses for a Customer
ApiResponse<Tmsv2customersEmbeddedDefaultShippingAddress>	getCustomerShippingAddressWithHttpInfo(String customerTokenId, String shippingAddressTokenId, String profileId) Retrieve a Customer Shipping Address
Tmsv2customersEmbeddedDefaultShippingAddress	patchCustomersShippingAddress(String customerTokenId, String shippingAddressTokenId, PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest, String profileId, String ifMatch) Update a Customer Shipping Address
okhttp3.Call	patchCustomersShippingAddressAsync(String customerTokenId, String shippingAddressTokenId, PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest, String profileId, String ifMatch, ApiCallback<Tmsv2customersEmbeddedDefaultShippingAddress> callback) Update a Customer Shipping Address (asynchronously)
okhttp3.Call	patchCustomersShippingAddressCall(String customerTokenId, String shippingAddressTokenId, PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest, String profileId, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for patchCustomersShippingAddress
ApiResponse<Tmsv2customersEmbeddedDefaultShippingAddress>	patchCustomersShippingAddressWithHttpInfo(String customerTokenId, String shippingAddressTokenId, PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest, String profileId, String ifMatch) Update a Customer Shipping Address
Tmsv2customersEmbeddedDefaultShippingAddress	postCustomerShippingAddress(String customerTokenId, PostCustomerShippingAddressRequest postCustomerShippingAddressRequest, String profileId) Create a Customer Shipping Address
okhttp3.Call	postCustomerShippingAddressAsync(String customerTokenId, PostCustomerShippingAddressRequest postCustomerShippingAddressRequest, String profileId, ApiCallback<Tmsv2customersEmbeddedDefaultShippingAddress> callback) Create a Customer Shipping Address (asynchronously)
okhttp3.Call	postCustomerShippingAddressCall(String customerTokenId, PostCustomerShippingAddressRequest postCustomerShippingAddressRequest, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for postCustomerShippingAddress
ApiResponse<Tmsv2customersEmbeddedDefaultShippingAddress>	postCustomerShippingAddressWithHttpInfo(String customerTokenId, PostCustomerShippingAddressRequest postCustomerShippingAddressRequest, String profileId) Create a Customer Shipping Address
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomerShippingAddressApi

public CustomerShippingAddressApi()

CustomerShippingAddressApi

public CustomerShippingAddressApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

deleteCustomerShippingAddressCall

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

Build call for deleteCustomerShippingAddress

Parameters:

customerTokenId - The TokenId of a customer. (required)

shippingAddressTokenId - The TokenId of an shipping address. (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

deleteCustomerShippingAddress

public void deleteCustomerShippingAddress(String customerTokenId,
                                          String shippingAddressTokenId,
                                          String profileId)
                                   throws ApiException

Delete a Customer Shipping Address

Parameters:

customerTokenId - The TokenId of a customer. (required)

shippingAddressTokenId - The TokenId of an shipping address. (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

deleteCustomerShippingAddressWithHttpInfo

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

Delete a Customer Shipping Address

Parameters:

customerTokenId - The TokenId of a customer. (required)

shippingAddressTokenId - The TokenId of an shipping address. (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

deleteCustomerShippingAddressAsync

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

Delete a Customer Shipping Address (asynchronously)

Parameters:

customerTokenId - The TokenId of a customer. (required)

shippingAddressTokenId - The TokenId of an shipping address. (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

getCustomerShippingAddressCall

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

Build call for getCustomerShippingAddress

Parameters:

customerTokenId - The TokenId of a customer. (required)

shippingAddressTokenId - The TokenId of an shipping address. (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

getCustomerShippingAddress

public Tmsv2customersEmbeddedDefaultShippingAddress getCustomerShippingAddress(String customerTokenId,
                                                                               String shippingAddressTokenId,
                                                                               String profileId)
                                                                        throws ApiException

Retrieve a Customer Shipping Address

Parameters:

customerTokenId - The TokenId of a customer. (required)

shippingAddressTokenId - The TokenId of an shipping address. (required)

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

Returns:

Tmsv2customersEmbeddedDefaultShippingAddress

Throws:

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

getCustomerShippingAddressWithHttpInfo

public ApiResponse<Tmsv2customersEmbeddedDefaultShippingAddress> getCustomerShippingAddressWithHttpInfo(String customerTokenId,
                                                                                                        String shippingAddressTokenId,
                                                                                                        String profileId)
                                                                                                 throws ApiException

Retrieve a Customer Shipping Address

Parameters:

customerTokenId - The TokenId of a customer. (required)

shippingAddressTokenId - The TokenId of an shipping address. (required)

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

Returns:

ApiResponse<Tmsv2customersEmbeddedDefaultShippingAddress>

Throws:

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

getCustomerShippingAddressAsync

public okhttp3.Call getCustomerShippingAddressAsync(String customerTokenId,
                                                    String shippingAddressTokenId,
                                                    String profileId,
                                                    ApiCallback<Tmsv2customersEmbeddedDefaultShippingAddress> callback)
                                             throws ApiException

Retrieve a Customer Shipping Address (asynchronously)

Parameters:

customerTokenId - The TokenId of a customer. (required)

shippingAddressTokenId - The TokenId of an shipping address. (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

getCustomerShippingAddressesListCall

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

Build call for getCustomerShippingAddressesList

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

getCustomerShippingAddressesList

public ShippingAddressListForCustomer getCustomerShippingAddressesList(String customerTokenId,
                                                                       String profileId,
                                                                       Long offset,
                                                                       Long limit)
                                                                throws ApiException

List Shipping Addresses 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:

ShippingAddressListForCustomer

Throws:

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

getCustomerShippingAddressesListWithHttpInfo

public ApiResponse<ShippingAddressListForCustomer> getCustomerShippingAddressesListWithHttpInfo(String customerTokenId,
                                                                                                String profileId,
                                                                                                Long offset,
                                                                                                Long limit)
                                                                                         throws ApiException

List Shipping Addresses 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<ShippingAddressListForCustomer>

Throws:

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

getCustomerShippingAddressesListAsync

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

List Shipping Addresses 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

patchCustomersShippingAddressCall

public okhttp3.Call patchCustomersShippingAddressCall(String customerTokenId,
                                                      String shippingAddressTokenId,
                                                      PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest,
                                                      String profileId,
                                                      String ifMatch,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException

Build call for patchCustomersShippingAddress

Parameters:

customerTokenId - The TokenId of a customer. (required)

shippingAddressTokenId - The TokenId of an shipping address. (required)

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

patchCustomersShippingAddress

public Tmsv2customersEmbeddedDefaultShippingAddress patchCustomersShippingAddress(String customerTokenId,
                                                                                  String shippingAddressTokenId,
                                                                                  PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest,
                                                                                  String profileId,
                                                                                  String ifMatch)
                                                                           throws ApiException

Update a Customer Shipping Address

Parameters:

customerTokenId - The TokenId of a customer. (required)

shippingAddressTokenId - The TokenId of an shipping address. (required)

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

Tmsv2customersEmbeddedDefaultShippingAddress

Throws:

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

patchCustomersShippingAddressWithHttpInfo

public ApiResponse<Tmsv2customersEmbeddedDefaultShippingAddress> patchCustomersShippingAddressWithHttpInfo(String customerTokenId,
                                                                                                           String shippingAddressTokenId,
                                                                                                           PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest,
                                                                                                           String profileId,
                                                                                                           String ifMatch)
                                                                                                    throws ApiException

Update a Customer Shipping Address

Parameters:

customerTokenId - The TokenId of a customer. (required)

shippingAddressTokenId - The TokenId of an shipping address. (required)

patchCustomerShippingAddressRequest - (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<Tmsv2customersEmbeddedDefaultShippingAddress>

Throws:

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

patchCustomersShippingAddressAsync

public okhttp3.Call patchCustomersShippingAddressAsync(String customerTokenId,
                                                       String shippingAddressTokenId,
                                                       PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest,
                                                       String profileId,
                                                       String ifMatch,
                                                       ApiCallback<Tmsv2customersEmbeddedDefaultShippingAddress> callback)
                                                throws ApiException

Update a Customer Shipping Address (asynchronously)

Parameters:

customerTokenId - The TokenId of a customer. (required)

shippingAddressTokenId - The TokenId of an shipping address. (required)

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

postCustomerShippingAddressCall

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

Build call for postCustomerShippingAddress

Parameters:

customerTokenId - The TokenId of a customer. (required)

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

postCustomerShippingAddress

public Tmsv2customersEmbeddedDefaultShippingAddress postCustomerShippingAddress(String customerTokenId,
                                                                                PostCustomerShippingAddressRequest postCustomerShippingAddressRequest,
                                                                                String profileId)
                                                                         throws ApiException

Create a Customer Shipping Address

Parameters:

customerTokenId - The TokenId of a customer. (required)

postCustomerShippingAddressRequest - (required)

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

Returns:

Tmsv2customersEmbeddedDefaultShippingAddress

Throws:

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

postCustomerShippingAddressWithHttpInfo

public ApiResponse<Tmsv2customersEmbeddedDefaultShippingAddress> postCustomerShippingAddressWithHttpInfo(String customerTokenId,
                                                                                                         PostCustomerShippingAddressRequest postCustomerShippingAddressRequest,
                                                                                                         String profileId)
                                                                                                  throws ApiException

Create a Customer Shipping Address

Parameters:

customerTokenId - The TokenId of a customer. (required)

postCustomerShippingAddressRequest - (required)

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

Returns:

ApiResponse<Tmsv2customersEmbeddedDefaultShippingAddress>

Throws:

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

postCustomerShippingAddressAsync

public okhttp3.Call postCustomerShippingAddressAsync(String customerTokenId,
                                                     PostCustomerShippingAddressRequest postCustomerShippingAddressRequest,
                                                     String profileId,
                                                     ApiCallback<Tmsv2customersEmbeddedDefaultShippingAddress> callback)
                                              throws ApiException

Create a Customer Shipping Address (asynchronously)

Parameters:

customerTokenId - The TokenId of a customer. (required)

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