Package com.commercetools.api.models.me

Interface MyCustomerRemoveShippingAddressIdAction

All Superinterfaces:

MyCustomerUpdateAction, ResourceUpdateAction<MyCustomerUpdateAction>

public interface MyCustomerRemoveShippingAddressIdAction
extends MyCustomerUpdateAction

Removes an existing 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

     MyCustomerRemoveShippingAddressIdAction myCustomerRemoveShippingAddressIdAction = MyCustomerRemoveShippingAddressIdAction.builder()
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static MyCustomerRemoveShippingAddressIdActionBuilder	builder()	builder factory method for MyCustomerRemoveShippingAddressIdAction
static MyCustomerRemoveShippingAddressIdActionBuilder	builder(MyCustomerRemoveShippingAddressIdAction template)	create builder for MyCustomerRemoveShippingAddressIdAction instance
MyCustomerRemoveShippingAddressIdAction	copyDeep()
static MyCustomerRemoveShippingAddressIdAction	deepCopy(MyCustomerRemoveShippingAddressIdAction template)	factory method to create a deep copy of MyCustomerRemoveShippingAddressIdAction
String	getAddressId()	id of the Address to remove from shippingAddressesIds.
String	getAddressKey()	key of the Address to remove from shippingAddressesIds.
static MyCustomerRemoveShippingAddressIdAction	of()	factory method
static MyCustomerRemoveShippingAddressIdAction	of(MyCustomerRemoveShippingAddressIdAction template)	factory method to create a shallow copy MyCustomerRemoveShippingAddressIdAction
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<MyCustomerRemoveShippingAddressIdAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withMyCustomerRemoveShippingAddressIdAction(Function<MyCustomerRemoveShippingAddressIdAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.me.MyCustomerUpdateAction

getAction, withMyCustomerUpdateAction

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 MyCustomerRemoveShippingAddressIdAction

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 MyCustomerRemoveShippingAddressIdAction of()

factory method

Returns:

instance of MyCustomerRemoveShippingAddressIdAction

of

static MyCustomerRemoveShippingAddressIdAction of(MyCustomerRemoveShippingAddressIdAction template)

factory method to create a shallow copy MyCustomerRemoveShippingAddressIdAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

MyCustomerRemoveShippingAddressIdAction copyDeep()

Specified by:

copyDeep in interface MyCustomerUpdateAction

deepCopy

@Nullable
static MyCustomerRemoveShippingAddressIdAction deepCopy(@Nullable
 MyCustomerRemoveShippingAddressIdAction template)

factory method to create a deep copy of MyCustomerRemoveShippingAddressIdAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MyCustomerRemoveShippingAddressIdActionBuilder builder()

builder factory method for MyCustomerRemoveShippingAddressIdAction

Returns:

builder

builder

static MyCustomerRemoveShippingAddressIdActionBuilder builder(MyCustomerRemoveShippingAddressIdAction template)

create builder for MyCustomerRemoveShippingAddressIdAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMyCustomerRemoveShippingAddressIdAction

default <T> T withMyCustomerRemoveShippingAddressIdAction(Function<MyCustomerRemoveShippingAddressIdAction,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<MyCustomerRemoveShippingAddressIdAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference