Package com.commercetools.api.models.me

Interface MyCustomerSetDefaultShippingAddressAction

All Superinterfaces:

MyCustomerUpdateAction, ResourceUpdateAction<MyCustomerUpdateAction>

public interface MyCustomerSetDefaultShippingAddressAction
extends MyCustomerUpdateAction

Sets the default shipping address from addresses. If the address is not currently a shipping address, it is added to shippingAddressIds. Either addressId or addressKey is required.

Example to create an instance using the builder pattern

     MyCustomerSetDefaultShippingAddressAction myCustomerSetDefaultShippingAddressAction = MyCustomerSetDefaultShippingAddressAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_DEFAULT_SHIPPING_ADDRESS	discriminator value for MyCustomerSetDefaultShippingAddressAction

Method Summary

Modifier and Type	Method	Description
static MyCustomerSetDefaultShippingAddressActionBuilder	builder()	builder factory method for MyCustomerSetDefaultShippingAddressAction
static MyCustomerSetDefaultShippingAddressActionBuilder	builder(MyCustomerSetDefaultShippingAddressAction template)	create builder for MyCustomerSetDefaultShippingAddressAction instance
MyCustomerSetDefaultShippingAddressAction	copyDeep()
static MyCustomerSetDefaultShippingAddressAction	deepCopy(MyCustomerSetDefaultShippingAddressAction template)	factory method to create a deep copy of MyCustomerSetDefaultShippingAddressAction
String	getAddressId()	id of the Address to become the default shipping address.
String	getAddressKey()	key of the Address to become the default shipping address.
static MyCustomerSetDefaultShippingAddressAction	of()	factory method
static MyCustomerSetDefaultShippingAddressAction	of(MyCustomerSetDefaultShippingAddressAction template)	factory method to create a shallow copy MyCustomerSetDefaultShippingAddressAction
void	setAddressId(String addressId)	id of the Address to become the default shipping address.
void	setAddressKey(String addressKey)	key of the Address to become the default shipping address.
static com.fasterxml.jackson.core.type.TypeReference<MyCustomerSetDefaultShippingAddressAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withMyCustomerSetDefaultShippingAddressAction(Function<MyCustomerSetDefaultShippingAddressAction,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

SET_DEFAULT_SHIPPING_ADDRESS

static final String SET_DEFAULT_SHIPPING_ADDRESS

discriminator value for MyCustomerSetDefaultShippingAddressAction

See Also:

• Constant Field Values

Method Details

getAddressId

String getAddressId()

id of the Address to become the default shipping address.

Returns:

addressId

getAddressKey

String getAddressKey()

key of the Address to become the default shipping address.

Returns:

addressKey

setAddressId

void setAddressId(String addressId)

id of the Address to become the default shipping address.

Parameters:

addressId - value to be set

setAddressKey

void setAddressKey(String addressKey)

key of the Address to become the default shipping address.

Parameters:

addressKey - value to be set

of

static MyCustomerSetDefaultShippingAddressAction of()

factory method

Returns:

instance of MyCustomerSetDefaultShippingAddressAction

of

static MyCustomerSetDefaultShippingAddressAction of(MyCustomerSetDefaultShippingAddressAction template)

factory method to create a shallow copy MyCustomerSetDefaultShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

MyCustomerSetDefaultShippingAddressAction copyDeep()

Specified by:

copyDeep in interface MyCustomerUpdateAction

deepCopy

@Nullable
static MyCustomerSetDefaultShippingAddressAction deepCopy(@Nullable
 MyCustomerSetDefaultShippingAddressAction template)

factory method to create a deep copy of MyCustomerSetDefaultShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MyCustomerSetDefaultShippingAddressActionBuilder builder()

builder factory method for MyCustomerSetDefaultShippingAddressAction

Returns:

builder

builder

static MyCustomerSetDefaultShippingAddressActionBuilder builder(MyCustomerSetDefaultShippingAddressAction template)

create builder for MyCustomerSetDefaultShippingAddressAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMyCustomerSetDefaultShippingAddressAction

default <T> T withMyCustomerSetDefaultShippingAddressAction(Function<MyCustomerSetDefaultShippingAddressAction,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<MyCustomerSetDefaultShippingAddressAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference