Package com.commercetools.api.models.customer

Interface CustomerSetDefaultBillingAddressAction

All Superinterfaces:

CustomerUpdateAction, ResourceUpdateAction<CustomerUpdateAction>

public interface CustomerSetDefaultBillingAddressAction
extends CustomerUpdateAction

Sets the default billing address from addresses. The action adds the id of the specified Address to the billingAddressIds if not contained already. Either addressId or addressKey is required.

This action generates the CustomerDefaultBillingAddressSet Message.

Example to create an instance using the builder pattern

     CustomerSetDefaultBillingAddressAction customerSetDefaultBillingAddressAction = CustomerSetDefaultBillingAddressAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_DEFAULT_BILLING_ADDRESS	discriminator value for CustomerSetDefaultBillingAddressAction

Method Summary

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

SET_DEFAULT_BILLING_ADDRESS

static final String SET_DEFAULT_BILLING_ADDRESS

discriminator value for CustomerSetDefaultBillingAddressAction

See Also:

• Constant Field Values

Method Details

getAddressId

String getAddressId()

id of the Address to become the default billing address.

Returns:

addressId

getAddressKey

String getAddressKey()

key of the Address to become the default billing address.

Returns:

addressKey

setAddressId

void setAddressId(String addressId)

id of the Address to become the default billing address.

Parameters:

addressId - value to be set

setAddressKey

void setAddressKey(String addressKey)

key of the Address to become the default billing address.

Parameters:

addressKey - value to be set

of

static CustomerSetDefaultBillingAddressAction of()

factory method

Returns:

instance of CustomerSetDefaultBillingAddressAction

of

static CustomerSetDefaultBillingAddressAction of(CustomerSetDefaultBillingAddressAction template)

factory method to create a shallow copy CustomerSetDefaultBillingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CustomerSetDefaultBillingAddressAction copyDeep()

Specified by:

copyDeep in interface CustomerUpdateAction

deepCopy

@Nullable
static CustomerSetDefaultBillingAddressAction deepCopy(@Nullable
 CustomerSetDefaultBillingAddressAction template)

factory method to create a deep copy of CustomerSetDefaultBillingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomerSetDefaultBillingAddressActionBuilder builder()

builder factory method for CustomerSetDefaultBillingAddressAction

Returns:

builder

builder

static CustomerSetDefaultBillingAddressActionBuilder builder(CustomerSetDefaultBillingAddressAction template)

create builder for CustomerSetDefaultBillingAddressAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomerSetDefaultBillingAddressAction

default <T> T withCustomerSetDefaultBillingAddressAction(Function<CustomerSetDefaultBillingAddressAction,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<CustomerSetDefaultBillingAddressAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference