Package com.commercetools.api.models.cart

Interface CartSetRecurringPaymentConfigurationAction

All Superinterfaces:

CartUpdateAction, ResourceUpdateAction<CartUpdateAction>

public interface CartSetRecurringPaymentConfigurationAction
extends CartUpdateAction

Sets the paymentStrategy and the paymentAllocations of the RecurringPaymentConfiguration together, replacing any existing configuration.

Example to create an instance using the builder pattern

     CartSetRecurringPaymentConfigurationAction cartSetRecurringPaymentConfigurationAction = CartSetRecurringPaymentConfigurationAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_RECURRING_PAYMENT_CONFIGURATION	discriminator value for CartSetRecurringPaymentConfigurationAction

Method Summary

Modifier and Type	Method	Description
static CartSetRecurringPaymentConfigurationActionBuilder	builder()	builder factory method for CartSetRecurringPaymentConfigurationAction
static CartSetRecurringPaymentConfigurationActionBuilder	builder(CartSetRecurringPaymentConfigurationAction template)	create builder for CartSetRecurringPaymentConfigurationAction instance
CartSetRecurringPaymentConfigurationAction	copyDeep()
static CartSetRecurringPaymentConfigurationAction	deepCopy(CartSetRecurringPaymentConfigurationAction template)	factory method to create a deep copy of CartSetRecurringPaymentConfigurationAction
@Valid RecurringPaymentConfigurationDraft	getRecurringPaymentConfiguration()	Value to set.
static CartSetRecurringPaymentConfigurationAction	of()	factory method
static CartSetRecurringPaymentConfigurationAction	of(CartSetRecurringPaymentConfigurationAction template)	factory method to create a shallow copy CartSetRecurringPaymentConfigurationAction
void	setRecurringPaymentConfiguration(RecurringPaymentConfigurationDraft recurringPaymentConfiguration)	Value to set.
static tools.jackson.core.type.TypeReference<CartSetRecurringPaymentConfigurationAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartSetRecurringPaymentConfigurationAction(Function<CartSetRecurringPaymentConfigurationAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.cart.CartUpdateAction

getAction, withCartUpdateAction

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

get

Field Details

SET_RECURRING_PAYMENT_CONFIGURATION

static final String SET_RECURRING_PAYMENT_CONFIGURATION

discriminator value for CartSetRecurringPaymentConfigurationAction

See Also:

• Constant Field Values

Method Details

getRecurringPaymentConfiguration

@Valid
@Valid RecurringPaymentConfigurationDraft getRecurringPaymentConfiguration()

Value to set. If omitted, any existing value is removed and the Orders generated by the RecurringOrder are created without collecting payment first.

Returns:

recurringPaymentConfiguration

setRecurringPaymentConfiguration

void setRecurringPaymentConfiguration(RecurringPaymentConfigurationDraft recurringPaymentConfiguration)

Value to set. If omitted, any existing value is removed and the Orders generated by the RecurringOrder are created without collecting payment first.

Parameters:

recurringPaymentConfiguration - value to be set

of

static CartSetRecurringPaymentConfigurationAction of()

factory method

Returns:

instance of CartSetRecurringPaymentConfigurationAction

of

static CartSetRecurringPaymentConfigurationAction of(CartSetRecurringPaymentConfigurationAction template)

factory method to create a shallow copy CartSetRecurringPaymentConfigurationAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CartSetRecurringPaymentConfigurationAction copyDeep()

Specified by:

copyDeep in interface CartUpdateAction

deepCopy

@Nullable
static CartSetRecurringPaymentConfigurationAction deepCopy(@Nullable
 CartSetRecurringPaymentConfigurationAction template)

factory method to create a deep copy of CartSetRecurringPaymentConfigurationAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartSetRecurringPaymentConfigurationActionBuilder builder()

builder factory method for CartSetRecurringPaymentConfigurationAction

Returns:

builder

builder

static CartSetRecurringPaymentConfigurationActionBuilder builder(CartSetRecurringPaymentConfigurationAction template)

create builder for CartSetRecurringPaymentConfigurationAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartSetRecurringPaymentConfigurationAction

default <T> T withCartSetRecurringPaymentConfigurationAction(Function<CartSetRecurringPaymentConfigurationAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static tools.jackson.core.type.TypeReference<CartSetRecurringPaymentConfigurationAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference