Package com.commercetools.api.models.me

Interface MyBusinessUnitSetDefaultShippingAddressAction

All Superinterfaces:

MyBusinessUnitUpdateAction

All Known Implementing Classes:

MyBusinessUnitSetDefaultShippingAddressActionImpl

public interface MyBusinessUnitSetDefaultShippingAddressAction
extends MyBusinessUnitUpdateAction

Setting the default shipping address on a Business Unit generates a BusinessUnitDefaultShippingAddressSet Message.

Example to create an instance using the builder pattern

     MyBusinessUnitSetDefaultShippingAddressAction myBusinessUnitSetDefaultShippingAddressAction = MyBusinessUnitSetDefaultShippingAddressAction.builder()
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static MyBusinessUnitSetDefaultShippingAddressActionBuilder	builder()	builder factory method for MyBusinessUnitSetDefaultShippingAddressAction
static MyBusinessUnitSetDefaultShippingAddressActionBuilder	builder(MyBusinessUnitSetDefaultShippingAddressAction template)	create builder for MyBusinessUnitSetDefaultShippingAddressAction instance
static MyBusinessUnitSetDefaultShippingAddressAction	deepCopy(MyBusinessUnitSetDefaultShippingAddressAction template)	factory method to create a deep copy of MyBusinessUnitSetDefaultShippingAddressAction
String	getAddressId()	ID of the address to add as a shipping address.
String	getAddressKey()	Key of the address to add as a shipping address.
static MyBusinessUnitSetDefaultShippingAddressAction	of()	factory method
static MyBusinessUnitSetDefaultShippingAddressAction	of(MyBusinessUnitSetDefaultShippingAddressAction template)	factory method to create a shallow copy MyBusinessUnitSetDefaultShippingAddressAction
void	setAddressId(String addressId)	ID of the address to add as a shipping address.
void	setAddressKey(String addressKey)	Key of the address to add as a shipping address.
static com.fasterxml.jackson.core.type.TypeReference<MyBusinessUnitSetDefaultShippingAddressAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withMyBusinessUnitSetDefaultShippingAddressAction(Function<MyBusinessUnitSetDefaultShippingAddressAction,T> helper)	accessor map function

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

getAction, withMyBusinessUnitUpdateAction

Field Details

SET_DEFAULT_SHIPPING_ADDRESS

static final String SET_DEFAULT_SHIPPING_ADDRESS

discriminator value for MyBusinessUnitSetDefaultShippingAddressAction

See Also:

• Constant Field Values

Method Details

getAddressId

String getAddressId()

ID of the address to add as a shipping address. Either addressId or addressKey is required.

Returns:

addressId

getAddressKey

String getAddressKey()

Key of the address to add as a shipping address. Either addressId or addressKey is required.

Returns:

addressKey

setAddressId

void setAddressId(String addressId)

ID of the address to add as a shipping address. Either addressId or addressKey is required.

Parameters:

addressId - value to be set

setAddressKey

void setAddressKey(String addressKey)

Key of the address to add as a shipping address. Either addressId or addressKey is required.

Parameters:

addressKey - value to be set

of

static MyBusinessUnitSetDefaultShippingAddressAction of()

factory method

Returns:

instance of MyBusinessUnitSetDefaultShippingAddressAction

of

static MyBusinessUnitSetDefaultShippingAddressAction of(MyBusinessUnitSetDefaultShippingAddressAction template)

factory method to create a shallow copy MyBusinessUnitSetDefaultShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static MyBusinessUnitSetDefaultShippingAddressAction deepCopy(@Nullable
 MyBusinessUnitSetDefaultShippingAddressAction template)

factory method to create a deep copy of MyBusinessUnitSetDefaultShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MyBusinessUnitSetDefaultShippingAddressActionBuilder builder()

builder factory method for MyBusinessUnitSetDefaultShippingAddressAction

Returns:

builder

builder

static MyBusinessUnitSetDefaultShippingAddressActionBuilder builder(MyBusinessUnitSetDefaultShippingAddressAction template)

create builder for MyBusinessUnitSetDefaultShippingAddressAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMyBusinessUnitSetDefaultShippingAddressAction

default <T> T withMyBusinessUnitSetDefaultShippingAddressAction(Function<MyBusinessUnitSetDefaultShippingAddressAction,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<MyBusinessUnitSetDefaultShippingAddressAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference