io.sphere.sdk.payments

Class PaymentDraftDsl

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.payments.PaymentDraftDsl

All Implemented Interfaces:

WithKey, PaymentDraft, CustomDraft

@Generated(value="io.sphere.sdk.annotations.processors.generators.ResourceDraftValueGenerator",
           comments="Generated from: io.sphere.sdk.payments.PaymentDraft")
public final class PaymentDraftDsl
extends Base
implements PaymentDraft

Dsl class for PaymentDraft.

Method Summary

Modifier and Type	Method and Description
javax.money.MonetaryAmount	getAmountAuthorized() Deprecated. This method will be removed with the next major SDK update.
javax.money.MonetaryAmount	getAmountPaid() Deprecated. This method will be removed with the next major SDK update.
javax.money.MonetaryAmount	getAmountPlanned()
javax.money.MonetaryAmount	getAmountRefunded() Deprecated. This method will be removed with the next major SDK update.
String	getAnonymousId() Identifies payments belonging to an anonymous session (the customer has not signed up/in yet).
ZonedDateTime	getAuthorizedUntil() Deprecated. This method will be removed with the next major SDK update.
CustomFieldsDraft	getCustom()
Reference<Customer>	getCustomer()
String	getExternalId() Deprecated. This method will be removed with the next major SDK update.
String	getInterfaceId()
List<CustomFieldsDraft>	getInterfaceInteractions()
String	getKey() User-specific unique identifier for the payment.
PaymentMethodInfo	getPaymentMethodInfo()
PaymentStatus	getPaymentStatus()
List<TransactionDraft>	getTransactions()
PaymentDraftBuilder	newBuilder() Creates a new builder with the values of this object.
static PaymentDraftDsl	of(javax.money.MonetaryAmount amountPlanned) Creates a new object initialized with the given values.
static PaymentDraftDsl	of(PaymentDraft template) Creates a new object initialized with the fields of the template parameter.
PaymentDraftDsl	withAmountAuthorized(javax.money.MonetaryAmount amountAuthorized) Deprecated. This method will be removed with the next major SDK update.
PaymentDraftDsl	withAmountPaid(javax.money.MonetaryAmount amountPaid) Deprecated. This method will be removed with the next major SDK update.
PaymentDraftDsl	withAmountPlanned(javax.money.MonetaryAmount amountPlanned)
PaymentDraftDsl	withAmountRefunded(javax.money.MonetaryAmount amountRefunded) Deprecated. This method will be removed with the next major SDK update.
PaymentDraftDsl	withAnonymousId(String anonymousId)
PaymentDraftDsl	withAuthorizedUntil(ZonedDateTime authorizedUntil) Deprecated. This method will be removed with the next major SDK update.
PaymentDraftDsl	withCustom(CustomFieldsDraft custom)
PaymentDraftDsl	withCustomer(Referenceable<Customer> customer)
PaymentDraftDsl	withExternalId(String externalId) Deprecated. This method will be removed with the next major SDK update.
PaymentDraftDsl	withInterfaceId(String interfaceId)
PaymentDraftDsl	withInterfaceInteractions(List<CustomFieldsDraft> interfaceInteractions)
PaymentDraftDsl	withKey(String key)
PaymentDraftDsl	withPaymentMethodInfo(PaymentMethodInfo paymentMethodInfo)
PaymentDraftDsl	withPaymentStatus(PaymentStatus paymentStatus)
PaymentDraftDsl	withTransactions(List<TransactionDraft> transactions)

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getAmountAuthorized

@Nullable
 @Deprecated
public javax.money.MonetaryAmount getAmountAuthorized()

Deprecated. This method will be removed with the next major SDK update.

Specified by:

getAmountAuthorized in interface PaymentDraft

Returns:

the authorized amount

getAmountPaid

@Nullable
 @Deprecated
public javax.money.MonetaryAmount getAmountPaid()

Deprecated. This method will be removed with the next major SDK update.

Specified by:

getAmountPaid in interface PaymentDraft

getAmountPlanned

public javax.money.MonetaryAmount getAmountPlanned()

Specified by:

getAmountPlanned in interface PaymentDraft

getAmountRefunded

@Nullable
 @Deprecated
public javax.money.MonetaryAmount getAmountRefunded()

Deprecated. This method will be removed with the next major SDK update.

Specified by:

getAmountRefunded in interface PaymentDraft

getAnonymousId

@Nullable
public String getAnonymousId()

Description copied from interface: PaymentDraft

Identifies payments belonging to an anonymous session (the customer has not signed up/in yet).

Specified by:

getAnonymousId in interface PaymentDraft

Returns:

the anonymous id of this payment

getAuthorizedUntil

@Nullable
 @Deprecated
public ZonedDateTime getAuthorizedUntil()

Deprecated. This method will be removed with the next major SDK update.

Specified by:

getAuthorizedUntil in interface PaymentDraft

Returns:

the

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Specified by:

getCustom in interface PaymentDraft

Specified by:

getCustom in interface CustomDraft

getCustomer

@Nullable
public Reference<Customer> getCustomer()

Specified by:

getCustomer in interface PaymentDraft

getExternalId

@Nullable
 @Deprecated
public String getExternalId()

Deprecated. This method will be removed with the next major SDK update.

Specified by:

getExternalId in interface PaymentDraft

Returns:

the external id

getInterfaceId

@Nullable
public String getInterfaceId()

Specified by:

getInterfaceId in interface PaymentDraft

getInterfaceInteractions

@Nullable
public List<CustomFieldsDraft> getInterfaceInteractions()

Specified by:

getInterfaceInteractions in interface PaymentDraft

getKey

@Nullable
public String getKey()

Description copied from interface: PaymentDraft

User-specific unique identifier for the payment.

Specified by:

getKey in interface WithKey

Specified by:

getKey in interface PaymentDraft

Returns:

the user defined key

getPaymentMethodInfo

@Nullable
public PaymentMethodInfo getPaymentMethodInfo()

Specified by:

getPaymentMethodInfo in interface PaymentDraft

getPaymentStatus

@Nullable
public PaymentStatus getPaymentStatus()

Specified by:

getPaymentStatus in interface PaymentDraft

getTransactions

@Nullable
public List<TransactionDraft> getTransactions()

Specified by:

getTransactions in interface PaymentDraft

newBuilder

public PaymentDraftBuilder newBuilder()

Creates a new builder with the values of this object.

Returns:

new builder

withAmountAuthorized

@Deprecated
public PaymentDraftDsl withAmountAuthorized(@Nullable
                                                        javax.money.MonetaryAmount amountAuthorized)

Deprecated. This method will be removed with the next major SDK update.

withAmountPaid

@Deprecated
public PaymentDraftDsl withAmountPaid(@Nullable
                                                  javax.money.MonetaryAmount amountPaid)

Deprecated. This method will be removed with the next major SDK update.

withAmountPlanned

public PaymentDraftDsl withAmountPlanned(javax.money.MonetaryAmount amountPlanned)

withAmountRefunded

@Deprecated
public PaymentDraftDsl withAmountRefunded(@Nullable
                                                      javax.money.MonetaryAmount amountRefunded)

Deprecated. This method will be removed with the next major SDK update.

withAnonymousId

public PaymentDraftDsl withAnonymousId(@Nullable
                                       String anonymousId)

withAuthorizedUntil

@Deprecated
public PaymentDraftDsl withAuthorizedUntil(@Nullable
                                                       ZonedDateTime authorizedUntil)

Deprecated. This method will be removed with the next major SDK update.

withCustom

public PaymentDraftDsl withCustom(@Nullable
                                  CustomFieldsDraft custom)

withCustomer

public PaymentDraftDsl withCustomer(@Nullable
                                    Referenceable<Customer> customer)

withExternalId

@Deprecated
public PaymentDraftDsl withExternalId(@Nullable
                                                  String externalId)

Deprecated. This method will be removed with the next major SDK update.

withInterfaceId

public PaymentDraftDsl withInterfaceId(@Nullable
                                       String interfaceId)

withInterfaceInteractions

public PaymentDraftDsl withInterfaceInteractions(@Nullable
                                                 List<CustomFieldsDraft> interfaceInteractions)

withKey

public PaymentDraftDsl withKey(@Nullable
                               String key)

withPaymentMethodInfo

public PaymentDraftDsl withPaymentMethodInfo(@Nullable
                                             PaymentMethodInfo paymentMethodInfo)

withPaymentStatus

public PaymentDraftDsl withPaymentStatus(@Nullable
                                         PaymentStatus paymentStatus)

withTransactions

public PaymentDraftDsl withTransactions(@Nullable
                                        List<TransactionDraft> transactions)

of

public static PaymentDraftDsl of(javax.money.MonetaryAmount amountPlanned)

Creates a new object initialized with the given values.

Parameters:

amountPlanned - initial value for the PaymentDraft.getAmountPlanned() property

Returns:

new object initialized with the given values

of

public static PaymentDraftDsl of(PaymentDraft template)

Creates a new object initialized with the fields of the template parameter.

Parameters:

template - the template

Returns:

a new object initialized from the template