Package com.commercetools.api.models.cart

Interface CartAddRecurringPaymentAllocationAction

All Superinterfaces:

CartUpdateAction, ResourceUpdateAction<CartUpdateAction>

public interface CartAddRecurringPaymentAllocationAction
extends CartUpdateAction

Adds a RecurringPaymentAllocation to the paymentAllocations of the RecurringPaymentConfiguration.

Example to create an instance using the builder pattern

     CartAddRecurringPaymentAllocationAction cartAddRecurringPaymentAllocationAction = CartAddRecurringPaymentAllocationAction.builder()
             .id("{id}")
             .paymentMethod(paymentMethodBuilder -> paymentMethodBuilder)
             .allocation(allocationBuilder -> allocationBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_RECURRING_PAYMENT_ALLOCATION	discriminator value for CartAddRecurringPaymentAllocationAction

Method Summary

Modifier and Type	Method	Description
static CartAddRecurringPaymentAllocationActionBuilder	builder()	builder factory method for CartAddRecurringPaymentAllocationAction
static CartAddRecurringPaymentAllocationActionBuilder	builder(CartAddRecurringPaymentAllocationAction template)	create builder for CartAddRecurringPaymentAllocationAction instance
CartAddRecurringPaymentAllocationAction	copyDeep()
static CartAddRecurringPaymentAllocationAction	deepCopy(CartAddRecurringPaymentAllocationAction template)	factory method to create a deep copy of CartAddRecurringPaymentAllocationAction
@NotNull @Valid AllocationDraft	getAllocation()	Share of the Order total charged to the paymentMethod.
@NotNull String	getId()	Unique identifier of the new RecurringPaymentAllocation within the RecurringPaymentConfiguration.
@NotNull @Valid PaymentMethodReference	getPaymentMethod()	Payment Method charged for this share of the Order total.
static CartAddRecurringPaymentAllocationAction	of()	factory method
static CartAddRecurringPaymentAllocationAction	of(CartAddRecurringPaymentAllocationAction template)	factory method to create a shallow copy CartAddRecurringPaymentAllocationAction
void	setAllocation(AllocationDraft allocation)	Share of the Order total charged to the paymentMethod.
void	setId(String id)	Unique identifier of the new RecurringPaymentAllocation within the RecurringPaymentConfiguration.
void	setPaymentMethod(PaymentMethodReference paymentMethod)	Payment Method charged for this share of the Order total.
static tools.jackson.core.type.TypeReference<CartAddRecurringPaymentAllocationAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartAddRecurringPaymentAllocationAction(Function<CartAddRecurringPaymentAllocationAction,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

ADD_RECURRING_PAYMENT_ALLOCATION

static final String ADD_RECURRING_PAYMENT_ALLOCATION

discriminator value for CartAddRecurringPaymentAllocationAction

See Also:

• Constant Field Values

Method Details

getId

@NotNull
@NotNull String getId()

Unique identifier of the new RecurringPaymentAllocation within the RecurringPaymentConfiguration.

Returns:

id

getPaymentMethod

@NotNull
@Valid
@NotNull @Valid PaymentMethodReference getPaymentMethod()

Payment Method charged for this share of the Order total.

Returns:

paymentMethod

getAllocation

@NotNull
@Valid
@NotNull @Valid AllocationDraft getAllocation()

Share of the Order total charged to the paymentMethod.

Returns:

allocation

setId

void setId(String id)

Unique identifier of the new RecurringPaymentAllocation within the RecurringPaymentConfiguration.

Parameters:

id - value to be set

setPaymentMethod

void setPaymentMethod(PaymentMethodReference paymentMethod)

Payment Method charged for this share of the Order total.

Parameters:

paymentMethod - value to be set

setAllocation

void setAllocation(AllocationDraft allocation)

Share of the Order total charged to the paymentMethod.

Parameters:

allocation - value to be set

of

static CartAddRecurringPaymentAllocationAction of()

factory method

Returns:

instance of CartAddRecurringPaymentAllocationAction

of

static CartAddRecurringPaymentAllocationAction of(CartAddRecurringPaymentAllocationAction template)

factory method to create a shallow copy CartAddRecurringPaymentAllocationAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CartAddRecurringPaymentAllocationAction copyDeep()

Specified by:

copyDeep in interface CartUpdateAction

deepCopy

@Nullable
static CartAddRecurringPaymentAllocationAction deepCopy(@Nullable
 CartAddRecurringPaymentAllocationAction template)

factory method to create a deep copy of CartAddRecurringPaymentAllocationAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartAddRecurringPaymentAllocationActionBuilder builder()

builder factory method for CartAddRecurringPaymentAllocationAction

Returns:

builder

builder

static CartAddRecurringPaymentAllocationActionBuilder builder(CartAddRecurringPaymentAllocationAction template)

create builder for CartAddRecurringPaymentAllocationAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartAddRecurringPaymentAllocationAction

default <T> T withCartAddRecurringPaymentAllocationAction(Function<CartAddRecurringPaymentAllocationAction,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<CartAddRecurringPaymentAllocationAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference