Package com.commercetools.api.models.customer

Interface CustomerRemoveShippingAddressIdAction

All Superinterfaces:

CustomerUpdateAction, ResourceUpdateAction<CustomerUpdateAction>

public interface CustomerRemoveShippingAddressIdAction
extends CustomerUpdateAction

Removes a shipping address from shippingAddressesIds. If the shipping address is the default shipping address, the defaultShippingAddressId is unset. Either addressId or addressKey is required.

Example to create an instance using the builder pattern

     CustomerRemoveShippingAddressIdAction customerRemoveShippingAddressIdAction = CustomerRemoveShippingAddressIdAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOVE_SHIPPING_ADDRESS_ID	discriminator value for CustomerRemoveShippingAddressIdAction

Method Summary

Modifier and Type	Method	Description
static CustomerRemoveShippingAddressIdActionBuilder	builder()	builder factory method for CustomerRemoveShippingAddressIdAction
static CustomerRemoveShippingAddressIdActionBuilder	builder(CustomerRemoveShippingAddressIdAction template)	create builder for CustomerRemoveShippingAddressIdAction instance
CustomerRemoveShippingAddressIdAction	copyDeep()
static CustomerRemoveShippingAddressIdAction	deepCopy(CustomerRemoveShippingAddressIdAction template)	factory method to create a deep copy of CustomerRemoveShippingAddressIdAction
String	getAddressId()	id of the Address to remove from shippingAddressesIds.
String	getAddressKey()	key of the Address to remove from shippingAddressesIds.
static CustomerRemoveShippingAddressIdAction	of()	factory method
static CustomerRemoveShippingAddressIdAction	of(CustomerRemoveShippingAddressIdAction template)	factory method to create a shallow copy CustomerRemoveShippingAddressIdAction
void	setAddressId(String addressId)	id of the Address to remove from shippingAddressesIds.
void	setAddressKey(String addressKey)	key of the Address to remove from shippingAddressesIds.
static com.fasterxml.jackson.core.type.TypeReference<CustomerRemoveShippingAddressIdAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomerRemoveShippingAddressIdAction(Function<CustomerRemoveShippingAddressIdAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.customer.CustomerUpdateAction

getAction, withCustomerUpdateAction

Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction

get

Field Details

REMOVE_SHIPPING_ADDRESS_ID

static final String REMOVE_SHIPPING_ADDRESS_ID

discriminator value for CustomerRemoveShippingAddressIdAction

See Also:

• Constant Field Values

Method Details

getAddressId

String getAddressId()

id of the Address to remove from shippingAddressesIds.

Returns:

addressId

getAddressKey

String getAddressKey()

key of the Address to remove from shippingAddressesIds.

Returns:

addressKey

setAddressId

void setAddressId(String addressId)

id of the Address to remove from shippingAddressesIds.

Parameters:

addressId - value to be set

setAddressKey

void setAddressKey(String addressKey)

key of the Address to remove from shippingAddressesIds.

Parameters:

addressKey - value to be set

of

static CustomerRemoveShippingAddressIdAction of()

factory method

Returns:

instance of CustomerRemoveShippingAddressIdAction

of

static CustomerRemoveShippingAddressIdAction of(CustomerRemoveShippingAddressIdAction template)

factory method to create a shallow copy CustomerRemoveShippingAddressIdAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CustomerRemoveShippingAddressIdAction copyDeep()

Specified by:

copyDeep in interface CustomerUpdateAction

deepCopy

@Nullable
static CustomerRemoveShippingAddressIdAction deepCopy(@Nullable
 CustomerRemoveShippingAddressIdAction template)

factory method to create a deep copy of CustomerRemoveShippingAddressIdAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomerRemoveShippingAddressIdActionBuilder builder()

builder factory method for CustomerRemoveShippingAddressIdAction

Returns:

builder

builder

static CustomerRemoveShippingAddressIdActionBuilder builder(CustomerRemoveShippingAddressIdAction template)

create builder for CustomerRemoveShippingAddressIdAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomerRemoveShippingAddressIdAction

default <T> T withCustomerRemoveShippingAddressIdAction(Function<CustomerRemoveShippingAddressIdAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<CustomerRemoveShippingAddressIdAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference