com.lithic.api.models.AuthenticationRetrieveResponse.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lithic-java-core Show documentation
Show all versions of lithic-java-core Show documentation
The Lithic Developer API is designed to provide a predictable programmatic
interface for accessing your Lithic account through an API and transaction
webhooks. Note that your API key is a secret and should be treated as such.
Don't share it with anyone, including us. We will never ask you for it.
// File generated from our OpenAPI spec by Stainless.
package com.lithic.api.models
import com.fasterxml.jackson.annotation.JsonAnyGetter
import com.fasterxml.jackson.annotation.JsonAnySetter
import com.fasterxml.jackson.annotation.JsonCreator
import com.fasterxml.jackson.annotation.JsonProperty
import com.fasterxml.jackson.databind.annotation.JsonDeserialize
import com.lithic.api.core.Enum
import com.lithic.api.core.ExcludeMissing
import com.lithic.api.core.JsonField
import com.lithic.api.core.JsonMissing
import com.lithic.api.core.JsonValue
import com.lithic.api.core.NoAutoDetect
import com.lithic.api.core.toUnmodifiable
import com.lithic.api.errors.LithicInvalidDataException
import java.time.OffsetDateTime
import java.util.Objects
import java.util.Optional
@JsonDeserialize(builder = AuthenticationRetrieveResponse.Builder::class)
@NoAutoDetect
class AuthenticationRetrieveResponse
private constructor(
private val accountType: JsonField,
private val additionalData: JsonField,
private val app: JsonField,
private val authenticationRequestType: JsonField,
private val authenticationResult: JsonField,
private val browser: JsonField,
private val cardExpiryCheck: JsonField,
private val cardToken: JsonField,
private val cardholder: JsonField,
private val channel: JsonField,
private val created: JsonField,
private val decisionMadeBy: JsonField,
private val merchant: JsonField,
private val messageCategory: JsonField,
private val threeRiRequestType: JsonField,
private val token: JsonField,
private val transaction: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/**
* Type of account/card that is being used for the transaction. Maps to EMV 3DS field acctType.
*/
fun accountType(): Optional =
Optional.ofNullable(accountType.getNullable("account_type"))
/**
* Object containing additional data about the 3DS request that is beyond the EMV 3DS standard
* spec (e.g., specific fields that only certain card networks send but are not required across
* all 3DS requests).
*/
fun additionalData(): Optional =
Optional.ofNullable(additionalData.getNullable("additional_data"))
/**
* Object containing data about the app used in the e-commerce transaction. Present if the
* channel is 'APP_BASED'.
*/
fun app(): Optional = Optional.ofNullable(app.getNullable("app"))
/**
* Type of authentication request - i.e., the type of transaction or interaction is causing the
* merchant to request an authentication. Maps to EMV 3DS field
* threeDSRequestorAuthenticationInd.
*/
fun authenticationRequestType(): Optional =
Optional.ofNullable(authenticationRequestType.getNullable("authentication_request_type"))
/** Indicates the outcome of the 3DS authentication process. */
fun authenticationResult(): Optional =
Optional.ofNullable(authenticationResult.getNullable("authentication_result"))
/**
* Object containing data about the browser used in the e-commerce transaction. Present if the
* channel is 'BROWSER'.
*/
fun browser(): Optional = Optional.ofNullable(browser.getNullable("browser"))
/**
* Indicates whether the expiration date provided by the cardholder during checkout matches
* Lithic's record of the card's expiration date.
*/
fun cardExpiryCheck(): CardExpiryCheck = cardExpiryCheck.getRequired("card_expiry_check")
/** Globally unique identifier for the card on which the 3DS authentication has occurred. */
fun cardToken(): String = cardToken.getRequired("card_token")
/** Object containing data about the cardholder provided during the transaction. */
fun cardholder(): Cardholder = cardholder.getRequired("cardholder")
/** Channel in which the authentication occurs. Maps to EMV 3DS field deviceChannel. */
fun channel(): Channel = channel.getRequired("channel")
/** Date and time when the authentication was created in Lithic's system. */
fun created(): OffsetDateTime = created.getRequired("created")
/** Entity that made the authentication decision. */
fun decisionMadeBy(): Optional =
Optional.ofNullable(decisionMadeBy.getNullable("decision_made_by"))
/** Object containing data about the merchant involved in the e-commerce transaction. */
fun merchant(): Merchant = merchant.getRequired("merchant")
/**
* Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For NON_PAYMENT_AUTHENTICATION,
* additional_data and transaction fields are not populated.
*/
fun messageCategory(): MessageCategory = messageCategory.getRequired("message_category")
/**
* Type of 3DS Requestor Initiated (3RI) request i.e., a 3DS authentication that takes place at
* the initiation of the merchant rather than the cardholder. The most common example of this is
* where a merchant is authenticating before billing for a recurring transaction such as a pay
* TV subscription or a utility bill. Maps to EMV 3DS field threeRIInd.
*/
fun threeRiRequestType(): Optional =
Optional.ofNullable(threeRiRequestType.getNullable("three_ri_request_type"))
/** Globally unique identifier for the 3DS authentication. */
fun token(): String = token.getRequired("token")
/**
* Object containing data about the e-commerce transaction for which the merchant is requesting
* authentication.
*/
fun transaction(): Optional =
Optional.ofNullable(transaction.getNullable("transaction"))
/**
* Type of account/card that is being used for the transaction. Maps to EMV 3DS field acctType.
*/
@JsonProperty("account_type") @ExcludeMissing fun _accountType() = accountType
/**
* Object containing additional data about the 3DS request that is beyond the EMV 3DS standard
* spec (e.g., specific fields that only certain card networks send but are not required across
* all 3DS requests).
*/
@JsonProperty("additional_data") @ExcludeMissing fun _additionalData() = additionalData
/**
* Object containing data about the app used in the e-commerce transaction. Present if the
* channel is 'APP_BASED'.
*/
@JsonProperty("app") @ExcludeMissing fun _app() = app
/**
* Type of authentication request - i.e., the type of transaction or interaction is causing the
* merchant to request an authentication. Maps to EMV 3DS field
* threeDSRequestorAuthenticationInd.
*/
@JsonProperty("authentication_request_type")
@ExcludeMissing
fun _authenticationRequestType() = authenticationRequestType
/** Indicates the outcome of the 3DS authentication process. */
@JsonProperty("authentication_result")
@ExcludeMissing
fun _authenticationResult() = authenticationResult
/**
* Object containing data about the browser used in the e-commerce transaction. Present if the
* channel is 'BROWSER'.
*/
@JsonProperty("browser") @ExcludeMissing fun _browser() = browser
/**
* Indicates whether the expiration date provided by the cardholder during checkout matches
* Lithic's record of the card's expiration date.
*/
@JsonProperty("card_expiry_check") @ExcludeMissing fun _cardExpiryCheck() = cardExpiryCheck
/** Globally unique identifier for the card on which the 3DS authentication has occurred. */
@JsonProperty("card_token") @ExcludeMissing fun _cardToken() = cardToken
/** Object containing data about the cardholder provided during the transaction. */
@JsonProperty("cardholder") @ExcludeMissing fun _cardholder() = cardholder
/** Channel in which the authentication occurs. Maps to EMV 3DS field deviceChannel. */
@JsonProperty("channel") @ExcludeMissing fun _channel() = channel
/** Date and time when the authentication was created in Lithic's system. */
@JsonProperty("created") @ExcludeMissing fun _created() = created
/** Entity that made the authentication decision. */
@JsonProperty("decision_made_by") @ExcludeMissing fun _decisionMadeBy() = decisionMadeBy
/** Object containing data about the merchant involved in the e-commerce transaction. */
@JsonProperty("merchant") @ExcludeMissing fun _merchant() = merchant
/**
* Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For NON_PAYMENT_AUTHENTICATION,
* additional_data and transaction fields are not populated.
*/
@JsonProperty("message_category") @ExcludeMissing fun _messageCategory() = messageCategory
/**
* Type of 3DS Requestor Initiated (3RI) request i.e., a 3DS authentication that takes place at
* the initiation of the merchant rather than the cardholder. The most common example of this is
* where a merchant is authenticating before billing for a recurring transaction such as a pay
* TV subscription or a utility bill. Maps to EMV 3DS field threeRIInd.
*/
@JsonProperty("three_ri_request_type")
@ExcludeMissing
fun _threeRiRequestType() = threeRiRequestType
/** Globally unique identifier for the 3DS authentication. */
@JsonProperty("token") @ExcludeMissing fun _token() = token
/**
* Object containing data about the e-commerce transaction for which the merchant is requesting
* authentication.
*/
@JsonProperty("transaction") @ExcludeMissing fun _transaction() = transaction
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): AuthenticationRetrieveResponse = apply {
if (!validated) {
accountType()
additionalData().map { it.validate() }
app().map { it.validate() }
authenticationRequestType()
authenticationResult()
browser().map { it.validate() }
cardExpiryCheck()
cardToken()
cardholder().validate()
channel()
created()
decisionMadeBy()
merchant().validate()
messageCategory()
threeRiRequestType()
token()
transaction().map { it.validate() }
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is AuthenticationRetrieveResponse &&
this.accountType == other.accountType &&
this.additionalData == other.additionalData &&
this.app == other.app &&
this.authenticationRequestType == other.authenticationRequestType &&
this.authenticationResult == other.authenticationResult &&
this.browser == other.browser &&
this.cardExpiryCheck == other.cardExpiryCheck &&
this.cardToken == other.cardToken &&
this.cardholder == other.cardholder &&
this.channel == other.channel &&
this.created == other.created &&
this.decisionMadeBy == other.decisionMadeBy &&
this.merchant == other.merchant &&
this.messageCategory == other.messageCategory &&
this.threeRiRequestType == other.threeRiRequestType &&
this.token == other.token &&
this.transaction == other.transaction &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
accountType,
additionalData,
app,
authenticationRequestType,
authenticationResult,
browser,
cardExpiryCheck,
cardToken,
cardholder,
channel,
created,
decisionMadeBy,
merchant,
messageCategory,
threeRiRequestType,
token,
transaction,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"AuthenticationRetrieveResponse{accountType=$accountType, additionalData=$additionalData, app=$app, authenticationRequestType=$authenticationRequestType, authenticationResult=$authenticationResult, browser=$browser, cardExpiryCheck=$cardExpiryCheck, cardToken=$cardToken, cardholder=$cardholder, channel=$channel, created=$created, decisionMadeBy=$decisionMadeBy, merchant=$merchant, messageCategory=$messageCategory, threeRiRequestType=$threeRiRequestType, token=$token, transaction=$transaction, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var accountType: JsonField = JsonMissing.of()
private var additionalData: JsonField = JsonMissing.of()
private var app: JsonField = JsonMissing.of()
private var authenticationRequestType: JsonField =
JsonMissing.of()
private var authenticationResult: JsonField = JsonMissing.of()
private var browser: JsonField = JsonMissing.of()
private var cardExpiryCheck: JsonField = JsonMissing.of()
private var cardToken: JsonField = JsonMissing.of()
private var cardholder: JsonField = JsonMissing.of()
private var channel: JsonField = JsonMissing.of()
private var created: JsonField = JsonMissing.of()
private var decisionMadeBy: JsonField = JsonMissing.of()
private var merchant: JsonField = JsonMissing.of()
private var messageCategory: JsonField = JsonMissing.of()
private var threeRiRequestType: JsonField = JsonMissing.of()
private var token: JsonField = JsonMissing.of()
private var transaction: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(authenticationRetrieveResponse: AuthenticationRetrieveResponse) = apply {
this.accountType = authenticationRetrieveResponse.accountType
this.additionalData = authenticationRetrieveResponse.additionalData
this.app = authenticationRetrieveResponse.app
this.authenticationRequestType =
authenticationRetrieveResponse.authenticationRequestType
this.authenticationResult = authenticationRetrieveResponse.authenticationResult
this.browser = authenticationRetrieveResponse.browser
this.cardExpiryCheck = authenticationRetrieveResponse.cardExpiryCheck
this.cardToken = authenticationRetrieveResponse.cardToken
this.cardholder = authenticationRetrieveResponse.cardholder
this.channel = authenticationRetrieveResponse.channel
this.created = authenticationRetrieveResponse.created
this.decisionMadeBy = authenticationRetrieveResponse.decisionMadeBy
this.merchant = authenticationRetrieveResponse.merchant
this.messageCategory = authenticationRetrieveResponse.messageCategory
this.threeRiRequestType = authenticationRetrieveResponse.threeRiRequestType
this.token = authenticationRetrieveResponse.token
this.transaction = authenticationRetrieveResponse.transaction
additionalProperties(authenticationRetrieveResponse.additionalProperties)
}
/**
* Type of account/card that is being used for the transaction. Maps to EMV 3DS field
* acctType.
*/
fun accountType(accountType: AccountType) = accountType(JsonField.of(accountType))
/**
* Type of account/card that is being used for the transaction. Maps to EMV 3DS field
* acctType.
*/
@JsonProperty("account_type")
@ExcludeMissing
fun accountType(accountType: JsonField) = apply {
this.accountType = accountType
}
/**
* Object containing additional data about the 3DS request that is beyond the EMV 3DS
* standard spec (e.g., specific fields that only certain card networks send but are not
* required across all 3DS requests).
*/
fun additionalData(additionalData: AdditionalData) =
additionalData(JsonField.of(additionalData))
/**
* Object containing additional data about the 3DS request that is beyond the EMV 3DS
* standard spec (e.g., specific fields that only certain card networks send but are not
* required across all 3DS requests).
*/
@JsonProperty("additional_data")
@ExcludeMissing
fun additionalData(additionalData: JsonField) = apply {
this.additionalData = additionalData
}
/**
* Object containing data about the app used in the e-commerce transaction. Present if the
* channel is 'APP_BASED'.
*/
fun app(app: App) = app(JsonField.of(app))
/**
* Object containing data about the app used in the e-commerce transaction. Present if the
* channel is 'APP_BASED'.
*/
@JsonProperty("app") @ExcludeMissing fun app(app: JsonField) = apply { this.app = app }
/**
* Type of authentication request - i.e., the type of transaction or interaction is causing
* the merchant to request an authentication. Maps to EMV 3DS field
* threeDSRequestorAuthenticationInd.
*/
fun authenticationRequestType(authenticationRequestType: AuthenticationRequestType) =
authenticationRequestType(JsonField.of(authenticationRequestType))
/**
* Type of authentication request - i.e., the type of transaction or interaction is causing
* the merchant to request an authentication. Maps to EMV 3DS field
* threeDSRequestorAuthenticationInd.
*/
@JsonProperty("authentication_request_type")
@ExcludeMissing
fun authenticationRequestType(
authenticationRequestType: JsonField
) = apply { this.authenticationRequestType = authenticationRequestType }
/** Indicates the outcome of the 3DS authentication process. */
fun authenticationResult(authenticationResult: AuthenticationResult) =
authenticationResult(JsonField.of(authenticationResult))
/** Indicates the outcome of the 3DS authentication process. */
@JsonProperty("authentication_result")
@ExcludeMissing
fun authenticationResult(authenticationResult: JsonField) = apply {
this.authenticationResult = authenticationResult
}
/**
* Object containing data about the browser used in the e-commerce transaction. Present if
* the channel is 'BROWSER'.
*/
fun browser(browser: Browser) = browser(JsonField.of(browser))
/**
* Object containing data about the browser used in the e-commerce transaction. Present if
* the channel is 'BROWSER'.
*/
@JsonProperty("browser")
@ExcludeMissing
fun browser(browser: JsonField) = apply { this.browser = browser }
/**
* Indicates whether the expiration date provided by the cardholder during checkout matches
* Lithic's record of the card's expiration date.
*/
fun cardExpiryCheck(cardExpiryCheck: CardExpiryCheck) =
cardExpiryCheck(JsonField.of(cardExpiryCheck))
/**
* Indicates whether the expiration date provided by the cardholder during checkout matches
* Lithic's record of the card's expiration date.
*/
@JsonProperty("card_expiry_check")
@ExcludeMissing
fun cardExpiryCheck(cardExpiryCheck: JsonField) = apply {
this.cardExpiryCheck = cardExpiryCheck
}
/** Globally unique identifier for the card on which the 3DS authentication has occurred. */
fun cardToken(cardToken: String) = cardToken(JsonField.of(cardToken))
/** Globally unique identifier for the card on which the 3DS authentication has occurred. */
@JsonProperty("card_token")
@ExcludeMissing
fun cardToken(cardToken: JsonField) = apply { this.cardToken = cardToken }
/** Object containing data about the cardholder provided during the transaction. */
fun cardholder(cardholder: Cardholder) = cardholder(JsonField.of(cardholder))
/** Object containing data about the cardholder provided during the transaction. */
@JsonProperty("cardholder")
@ExcludeMissing
fun cardholder(cardholder: JsonField) = apply { this.cardholder = cardholder }
/** Channel in which the authentication occurs. Maps to EMV 3DS field deviceChannel. */
fun channel(channel: Channel) = channel(JsonField.of(channel))
/** Channel in which the authentication occurs. Maps to EMV 3DS field deviceChannel. */
@JsonProperty("channel")
@ExcludeMissing
fun channel(channel: JsonField) = apply { this.channel = channel }
/** Date and time when the authentication was created in Lithic's system. */
fun created(created: OffsetDateTime) = created(JsonField.of(created))
/** Date and time when the authentication was created in Lithic's system. */
@JsonProperty("created")
@ExcludeMissing
fun created(created: JsonField) = apply { this.created = created }
/** Entity that made the authentication decision. */
fun decisionMadeBy(decisionMadeBy: DecisionMadeBy) =
decisionMadeBy(JsonField.of(decisionMadeBy))
/** Entity that made the authentication decision. */
@JsonProperty("decision_made_by")
@ExcludeMissing
fun decisionMadeBy(decisionMadeBy: JsonField) = apply {
this.decisionMadeBy = decisionMadeBy
}
/** Object containing data about the merchant involved in the e-commerce transaction. */
fun merchant(merchant: Merchant) = merchant(JsonField.of(merchant))
/** Object containing data about the merchant involved in the e-commerce transaction. */
@JsonProperty("merchant")
@ExcludeMissing
fun merchant(merchant: JsonField) = apply { this.merchant = merchant }
/**
* Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For
* NON_PAYMENT_AUTHENTICATION, additional_data and transaction fields are not populated.
*/
fun messageCategory(messageCategory: MessageCategory) =
messageCategory(JsonField.of(messageCategory))
/**
* Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For
* NON_PAYMENT_AUTHENTICATION, additional_data and transaction fields are not populated.
*/
@JsonProperty("message_category")
@ExcludeMissing
fun messageCategory(messageCategory: JsonField) = apply {
this.messageCategory = messageCategory
}
/**
* Type of 3DS Requestor Initiated (3RI) request i.e., a 3DS authentication that takes place
* at the initiation of the merchant rather than the cardholder. The most common example of
* this is where a merchant is authenticating before billing for a recurring transaction
* such as a pay TV subscription or a utility bill. Maps to EMV 3DS field threeRIInd.
*/
fun threeRiRequestType(threeRiRequestType: ThreeRiRequestType) =
threeRiRequestType(JsonField.of(threeRiRequestType))
/**
* Type of 3DS Requestor Initiated (3RI) request i.e., a 3DS authentication that takes place
* at the initiation of the merchant rather than the cardholder. The most common example of
* this is where a merchant is authenticating before billing for a recurring transaction
* such as a pay TV subscription or a utility bill. Maps to EMV 3DS field threeRIInd.
*/
@JsonProperty("three_ri_request_type")
@ExcludeMissing
fun threeRiRequestType(threeRiRequestType: JsonField) = apply {
this.threeRiRequestType = threeRiRequestType
}
/** Globally unique identifier for the 3DS authentication. */
fun token(token: String) = token(JsonField.of(token))
/** Globally unique identifier for the 3DS authentication. */
@JsonProperty("token")
@ExcludeMissing
fun token(token: JsonField) = apply { this.token = token }
/**
* Object containing data about the e-commerce transaction for which the merchant is
* requesting authentication.
*/
fun transaction(transaction: Transaction) = transaction(JsonField.of(transaction))
/**
* Object containing data about the e-commerce transaction for which the merchant is
* requesting authentication.
*/
@JsonProperty("transaction")
@ExcludeMissing
fun transaction(transaction: JsonField) = apply {
this.transaction = transaction
}
fun additionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.clear()
this.additionalProperties.putAll(additionalProperties)
}
@JsonAnySetter
fun putAdditionalProperty(key: String, value: JsonValue) = apply {
this.additionalProperties.put(key, value)
}
fun putAllAdditionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.putAll(additionalProperties)
}
fun build(): AuthenticationRetrieveResponse =
AuthenticationRetrieveResponse(
accountType,
additionalData,
app,
authenticationRequestType,
authenticationResult,
browser,
cardExpiryCheck,
cardToken,
cardholder,
channel,
created,
decisionMadeBy,
merchant,
messageCategory,
threeRiRequestType,
token,
transaction,
additionalProperties.toUnmodifiable(),
)
}
class AccountType
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is AccountType && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val CREDIT = AccountType(JsonField.of("CREDIT"))
@JvmField val DEBIT = AccountType(JsonField.of("DEBIT"))
@JvmField val NOT_APPLICABLE = AccountType(JsonField.of("NOT_APPLICABLE"))
@JvmStatic fun of(value: String) = AccountType(JsonField.of(value))
}
enum class Known {
CREDIT,
DEBIT,
NOT_APPLICABLE,
}
enum class Value {
CREDIT,
DEBIT,
NOT_APPLICABLE,
_UNKNOWN,
}
fun value(): Value =
when (this) {
CREDIT -> Value.CREDIT
DEBIT -> Value.DEBIT
NOT_APPLICABLE -> Value.NOT_APPLICABLE
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
CREDIT -> Known.CREDIT
DEBIT -> Known.DEBIT
NOT_APPLICABLE -> Known.NOT_APPLICABLE
else -> throw LithicInvalidDataException("Unknown AccountType: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
class AuthenticationResult
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is AuthenticationResult && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val DECLINE = AuthenticationResult(JsonField.of("DECLINE"))
@JvmField val SUCCESS = AuthenticationResult(JsonField.of("SUCCESS"))
@JvmStatic fun of(value: String) = AuthenticationResult(JsonField.of(value))
}
enum class Known {
DECLINE,
SUCCESS,
}
enum class Value {
DECLINE,
SUCCESS,
_UNKNOWN,
}
fun value(): Value =
when (this) {
DECLINE -> Value.DECLINE
SUCCESS -> Value.SUCCESS
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
DECLINE -> Known.DECLINE
SUCCESS -> Known.SUCCESS
else -> throw LithicInvalidDataException("Unknown AuthenticationResult: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
class CardExpiryCheck
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is CardExpiryCheck && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val MATCH = CardExpiryCheck(JsonField.of("MATCH"))
@JvmField val MISMATCH = CardExpiryCheck(JsonField.of("MISMATCH"))
@JvmField val NOT_PRESENT = CardExpiryCheck(JsonField.of("NOT_PRESENT"))
@JvmStatic fun of(value: String) = CardExpiryCheck(JsonField.of(value))
}
enum class Known {
MATCH,
MISMATCH,
NOT_PRESENT,
}
enum class Value {
MATCH,
MISMATCH,
NOT_PRESENT,
_UNKNOWN,
}
fun value(): Value =
when (this) {
MATCH -> Value.MATCH
MISMATCH -> Value.MISMATCH
NOT_PRESENT -> Value.NOT_PRESENT
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
MATCH -> Known.MATCH
MISMATCH -> Known.MISMATCH
NOT_PRESENT -> Known.NOT_PRESENT
else -> throw LithicInvalidDataException("Unknown CardExpiryCheck: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
/** Object containing data about the cardholder provided during the transaction. */
@JsonDeserialize(builder = Cardholder.Builder::class)
@NoAutoDetect
class Cardholder
private constructor(
private val addressMatch: JsonField,
private val billingAddress: JsonField,
private val email: JsonField,
private val name: JsonField,
private val phoneNumberHome: JsonField,
private val phoneNumberMobile: JsonField,
private val phoneNumberWork: JsonField,
private val shippingAddress: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/**
* Indicates whether the shipping address and billing address provided by the cardholder are
* the same. This value - and assessment of whether the addresses match - is provided
* directly in the 3DS request and is not determined by Lithic. Maps to EMV 3DS field
* addrMatch.
*/
fun addressMatch(): Optional =
Optional.ofNullable(addressMatch.getNullable("address_match"))
/** Object containing data on the billing address provided during the transaction. */
fun billingAddress(): Optional =
Optional.ofNullable(billingAddress.getNullable("billing_address"))
/**
* Email address that is either provided by the cardholder or is on file with the merchant
* in a 3RI request. Maps to EMV 3DS field email.
*/
fun email(): Optional = Optional.ofNullable(email.getNullable("email"))
/** Name of the cardholder. Maps to EMV 3DS field cardholderName. */
fun name(): Optional = Optional.ofNullable(name.getNullable("name"))
/**
* Home phone number provided by the cardholder. Maps to EMV 3DS fields homePhone.cc and
* homePhone.subscriber.
*/
fun phoneNumberHome(): Optional =
Optional.ofNullable(phoneNumberHome.getNullable("phone_number_home"))
/**
* Mobile/cell phone number provided by the cardholder. Maps to EMV 3DS fields
* mobilePhone.cc and mobilePhone.subscriber.
*/
fun phoneNumberMobile(): Optional =
Optional.ofNullable(phoneNumberMobile.getNullable("phone_number_mobile"))
/**
* Work phone number provided by the cardholder. Maps to EMV 3DS fields workPhone.cc and
* workPhone.subscriber.
*/
fun phoneNumberWork(): Optional =
Optional.ofNullable(phoneNumberWork.getNullable("phone_number_work"))
/** Object containing data on the shipping address provided during the transaction. */
fun shippingAddress(): Optional =
Optional.ofNullable(shippingAddress.getNullable("shipping_address"))
/**
* Indicates whether the shipping address and billing address provided by the cardholder are
* the same. This value - and assessment of whether the addresses match - is provided
* directly in the 3DS request and is not determined by Lithic. Maps to EMV 3DS field
* addrMatch.
*/
@JsonProperty("address_match") @ExcludeMissing fun _addressMatch() = addressMatch
/** Object containing data on the billing address provided during the transaction. */
@JsonProperty("billing_address") @ExcludeMissing fun _billingAddress() = billingAddress
/**
* Email address that is either provided by the cardholder or is on file with the merchant
* in a 3RI request. Maps to EMV 3DS field email.
*/
@JsonProperty("email") @ExcludeMissing fun _email() = email
/** Name of the cardholder. Maps to EMV 3DS field cardholderName. */
@JsonProperty("name") @ExcludeMissing fun _name() = name
/**
* Home phone number provided by the cardholder. Maps to EMV 3DS fields homePhone.cc and
* homePhone.subscriber.
*/
@JsonProperty("phone_number_home") @ExcludeMissing fun _phoneNumberHome() = phoneNumberHome
/**
* Mobile/cell phone number provided by the cardholder. Maps to EMV 3DS fields
* mobilePhone.cc and mobilePhone.subscriber.
*/
@JsonProperty("phone_number_mobile")
@ExcludeMissing
fun _phoneNumberMobile() = phoneNumberMobile
/**
* Work phone number provided by the cardholder. Maps to EMV 3DS fields workPhone.cc and
* workPhone.subscriber.
*/
@JsonProperty("phone_number_work") @ExcludeMissing fun _phoneNumberWork() = phoneNumberWork
/** Object containing data on the shipping address provided during the transaction. */
@JsonProperty("shipping_address") @ExcludeMissing fun _shippingAddress() = shippingAddress
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): Cardholder = apply {
if (!validated) {
addressMatch()
billingAddress().map { it.validate() }
email()
name()
phoneNumberHome()
phoneNumberMobile()
phoneNumberWork()
shippingAddress().map { it.validate() }
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Cardholder &&
this.addressMatch == other.addressMatch &&
this.billingAddress == other.billingAddress &&
this.email == other.email &&
this.name == other.name &&
this.phoneNumberHome == other.phoneNumberHome &&
this.phoneNumberMobile == other.phoneNumberMobile &&
this.phoneNumberWork == other.phoneNumberWork &&
this.shippingAddress == other.shippingAddress &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
addressMatch,
billingAddress,
email,
name,
phoneNumberHome,
phoneNumberMobile,
phoneNumberWork,
shippingAddress,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Cardholder{addressMatch=$addressMatch, billingAddress=$billingAddress, email=$email, name=$name, phoneNumberHome=$phoneNumberHome, phoneNumberMobile=$phoneNumberMobile, phoneNumberWork=$phoneNumberWork, shippingAddress=$shippingAddress, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var addressMatch: JsonField = JsonMissing.of()
private var billingAddress: JsonField = JsonMissing.of()
private var email: JsonField = JsonMissing.of()
private var name: JsonField = JsonMissing.of()
private var phoneNumberHome: JsonField = JsonMissing.of()
private var phoneNumberMobile: JsonField = JsonMissing.of()
private var phoneNumberWork: JsonField = JsonMissing.of()
private var shippingAddress: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(cardholder: Cardholder) = apply {
this.addressMatch = cardholder.addressMatch
this.billingAddress = cardholder.billingAddress
this.email = cardholder.email
this.name = cardholder.name
this.phoneNumberHome = cardholder.phoneNumberHome
this.phoneNumberMobile = cardholder.phoneNumberMobile
this.phoneNumberWork = cardholder.phoneNumberWork
this.shippingAddress = cardholder.shippingAddress
additionalProperties(cardholder.additionalProperties)
}
/**
* Indicates whether the shipping address and billing address provided by the cardholder
* are the same. This value - and assessment of whether the addresses match - is
* provided directly in the 3DS request and is not determined by Lithic. Maps to EMV 3DS
* field addrMatch.
*/
fun addressMatch(addressMatch: Boolean) = addressMatch(JsonField.of(addressMatch))
/**
* Indicates whether the shipping address and billing address provided by the cardholder
* are the same. This value - and assessment of whether the addresses match - is
* provided directly in the 3DS request and is not determined by Lithic. Maps to EMV 3DS
* field addrMatch.
*/
@JsonProperty("address_match")
@ExcludeMissing
fun addressMatch(addressMatch: JsonField) = apply {
this.addressMatch = addressMatch
}
/** Object containing data on the billing address provided during the transaction. */
fun billingAddress(billingAddress: ThreeDSAddress) =
billingAddress(JsonField.of(billingAddress))
/** Object containing data on the billing address provided during the transaction. */
@JsonProperty("billing_address")
@ExcludeMissing
fun billingAddress(billingAddress: JsonField) = apply {
this.billingAddress = billingAddress
}
/**
* Email address that is either provided by the cardholder or is on file with the
* merchant in a 3RI request. Maps to EMV 3DS field email.
*/
fun email(email: String) = email(JsonField.of(email))
/**
* Email address that is either provided by the cardholder or is on file with the
* merchant in a 3RI request. Maps to EMV 3DS field email.
*/
@JsonProperty("email")
@ExcludeMissing
fun email(email: JsonField) = apply { this.email = email }
/** Name of the cardholder. Maps to EMV 3DS field cardholderName. */
fun name(name: String) = name(JsonField.of(name))
/** Name of the cardholder. Maps to EMV 3DS field cardholderName. */
@JsonProperty("name")
@ExcludeMissing
fun name(name: JsonField) = apply { this.name = name }
/**
* Home phone number provided by the cardholder. Maps to EMV 3DS fields homePhone.cc and
* homePhone.subscriber.
*/
fun phoneNumberHome(phoneNumberHome: String) =
phoneNumberHome(JsonField.of(phoneNumberHome))
/**
* Home phone number provided by the cardholder. Maps to EMV 3DS fields homePhone.cc and
* homePhone.subscriber.
*/
@JsonProperty("phone_number_home")
@ExcludeMissing
fun phoneNumberHome(phoneNumberHome: JsonField) = apply {
this.phoneNumberHome = phoneNumberHome
}
/**
* Mobile/cell phone number provided by the cardholder. Maps to EMV 3DS fields
* mobilePhone.cc and mobilePhone.subscriber.
*/
fun phoneNumberMobile(phoneNumberMobile: String) =
phoneNumberMobile(JsonField.of(phoneNumberMobile))
/**
* Mobile/cell phone number provided by the cardholder. Maps to EMV 3DS fields
* mobilePhone.cc and mobilePhone.subscriber.
*/
@JsonProperty("phone_number_mobile")
@ExcludeMissing
fun phoneNumberMobile(phoneNumberMobile: JsonField) = apply {
this.phoneNumberMobile = phoneNumberMobile
}
/**
* Work phone number provided by the cardholder. Maps to EMV 3DS fields workPhone.cc and
* workPhone.subscriber.
*/
fun phoneNumberWork(phoneNumberWork: String) =
phoneNumberWork(JsonField.of(phoneNumberWork))
/**
* Work phone number provided by the cardholder. Maps to EMV 3DS fields workPhone.cc and
* workPhone.subscriber.
*/
@JsonProperty("phone_number_work")
@ExcludeMissing
fun phoneNumberWork(phoneNumberWork: JsonField) = apply {
this.phoneNumberWork = phoneNumberWork
}
/** Object containing data on the shipping address provided during the transaction. */
fun shippingAddress(shippingAddress: ThreeDSAddress) =
shippingAddress(JsonField.of(shippingAddress))
/** Object containing data on the shipping address provided during the transaction. */
@JsonProperty("shipping_address")
@ExcludeMissing
fun shippingAddress(shippingAddress: JsonField) = apply {
this.shippingAddress = shippingAddress
}
fun additionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.clear()
this.additionalProperties.putAll(additionalProperties)
}
@JsonAnySetter
fun putAdditionalProperty(key: String, value: JsonValue) = apply {
this.additionalProperties.put(key, value)
}
fun putAllAdditionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.putAll(additionalProperties)
}
fun build(): Cardholder =
Cardholder(
addressMatch,
billingAddress,
email,
name,
phoneNumberHome,
phoneNumberMobile,
phoneNumberWork,
shippingAddress,
additionalProperties.toUnmodifiable(),
)
}
/** Object containing data on the billing address provided during the transaction. */
@JsonDeserialize(builder = ThreeDSAddress.Builder::class)
@NoAutoDetect
class ThreeDSAddress
private constructor(
private val address1: JsonField,
private val address2: JsonField,
private val address3: JsonField,
private val city: JsonField,
private val country: JsonField,
private val postalCode: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/** First line of the street address provided by the cardholder. */
fun address1(): Optional = Optional.ofNullable(address1.getNullable("address1"))
/** Second line of the street address provided by the cardholder. */
fun address2(): Optional = Optional.ofNullable(address2.getNullable("address2"))
/** Third line of the street address provided by the cardholder. */
fun address3(): Optional = Optional.ofNullable(address3.getNullable("address3"))
/** City of the address provided by the cardholder. */
fun city(): Optional = Optional.ofNullable(city.getNullable("city"))
/**
* Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format (e.g.
* USA)
*/
fun country(): Optional = Optional.ofNullable(country.getNullable("country"))
/** Postal code (e.g., ZIP code) of the address provided by the cardholder */
fun postalCode(): Optional =
Optional.ofNullable(postalCode.getNullable("postal_code"))
/** First line of the street address provided by the cardholder. */
@JsonProperty("address1") @ExcludeMissing fun _address1() = address1
/** Second line of the street address provided by the cardholder. */
@JsonProperty("address2") @ExcludeMissing fun _address2() = address2
/** Third line of the street address provided by the cardholder. */
@JsonProperty("address3") @ExcludeMissing fun _address3() = address3
/** City of the address provided by the cardholder. */
@JsonProperty("city") @ExcludeMissing fun _city() = city
/**
* Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format (e.g.
* USA)
*/
@JsonProperty("country") @ExcludeMissing fun _country() = country
/** Postal code (e.g., ZIP code) of the address provided by the cardholder */
@JsonProperty("postal_code") @ExcludeMissing fun _postalCode() = postalCode
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): ThreeDSAddress = apply {
if (!validated) {
address1()
address2()
address3()
city()
country()
postalCode()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is ThreeDSAddress &&
this.address1 == other.address1 &&
this.address2 == other.address2 &&
this.address3 == other.address3 &&
this.city == other.city &&
this.country == other.country &&
this.postalCode == other.postalCode &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
address1,
address2,
address3,
city,
country,
postalCode,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"ThreeDSAddress{address1=$address1, address2=$address2, address3=$address3, city=$city, country=$country, postalCode=$postalCode, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var address1: JsonField = JsonMissing.of()
private var address2: JsonField = JsonMissing.of()
private var address3: JsonField = JsonMissing.of()
private var city: JsonField = JsonMissing.of()
private var country: JsonField = JsonMissing.of()
private var postalCode: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(threeDSAddress: ThreeDSAddress) = apply {
this.address1 = threeDSAddress.address1
this.address2 = threeDSAddress.address2
this.address3 = threeDSAddress.address3
this.city = threeDSAddress.city
this.country = threeDSAddress.country
this.postalCode = threeDSAddress.postalCode
additionalProperties(threeDSAddress.additionalProperties)
}
/** First line of the street address provided by the cardholder. */
fun address1(address1: String) = address1(JsonField.of(address1))
/** First line of the street address provided by the cardholder. */
@JsonProperty("address1")
@ExcludeMissing
fun address1(address1: JsonField) = apply { this.address1 = address1 }
/** Second line of the street address provided by the cardholder. */
fun address2(address2: String) = address2(JsonField.of(address2))
/** Second line of the street address provided by the cardholder. */
@JsonProperty("address2")
@ExcludeMissing
fun address2(address2: JsonField) = apply { this.address2 = address2 }
/** Third line of the street address provided by the cardholder. */
fun address3(address3: String) = address3(JsonField.of(address3))
/** Third line of the street address provided by the cardholder. */
@JsonProperty("address3")
@ExcludeMissing
fun address3(address3: JsonField) = apply { this.address3 = address3 }
/** City of the address provided by the cardholder. */
fun city(city: String) = city(JsonField.of(city))
/** City of the address provided by the cardholder. */
@JsonProperty("city")
@ExcludeMissing
fun city(city: JsonField) = apply { this.city = city }
/**
* Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format
* (e.g. USA)
*/
fun country(country: String) = country(JsonField.of(country))
/**
* Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format
* (e.g. USA)
*/
@JsonProperty("country")
@ExcludeMissing
fun country(country: JsonField) = apply { this.country = country }
/** Postal code (e.g., ZIP code) of the address provided by the cardholder */
fun postalCode(postalCode: String) = postalCode(JsonField.of(postalCode))
/** Postal code (e.g., ZIP code) of the address provided by the cardholder */
@JsonProperty("postal_code")
@ExcludeMissing
fun postalCode(postalCode: JsonField) = apply {
this.postalCode = postalCode
}
fun additionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.clear()
this.additionalProperties.putAll(additionalProperties)
}
@JsonAnySetter
fun putAdditionalProperty(key: String, value: JsonValue) = apply {
this.additionalProperties.put(key, value)
}
fun putAllAdditionalProperties(additionalProperties: Map) =
apply {
this.additionalProperties.putAll(additionalProperties)
}
fun build(): ThreeDSAddress =
ThreeDSAddress(
address1,
address2,
address3,
city,
country,
postalCode,
additionalProperties.toUnmodifiable(),
)
}
}
}
class Channel
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Channel && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val APP_BASED = Channel(JsonField.of("APP_BASED"))
@JvmField val BROWSER = Channel(JsonField.of("BROWSER"))
@JvmField
val THREE_DS_REQUESTOR_INITIATED = Channel(JsonField.of("THREE_DS_REQUESTOR_INITIATED"))
@JvmStatic fun of(value: String) = Channel(JsonField.of(value))
}
enum class Known {
APP_BASED,
BROWSER,
THREE_DS_REQUESTOR_INITIATED,
}
enum class Value {
APP_BASED,
BROWSER,
THREE_DS_REQUESTOR_INITIATED,
_UNKNOWN,
}
fun value(): Value =
when (this) {
APP_BASED -> Value.APP_BASED
BROWSER -> Value.BROWSER
THREE_DS_REQUESTOR_INITIATED -> Value.THREE_DS_REQUESTOR_INITIATED
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
APP_BASED -> Known.APP_BASED
BROWSER -> Known.BROWSER
THREE_DS_REQUESTOR_INITIATED -> Known.THREE_DS_REQUESTOR_INITIATED
else -> throw LithicInvalidDataException("Unknown Channel: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
class DecisionMadeBy
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is DecisionMadeBy && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val CUSTOMER_ENDPOINT = DecisionMadeBy(JsonField.of("CUSTOMER_ENDPOINT"))
@JvmField val LITHIC_DEFAULT = DecisionMadeBy(JsonField.of("LITHIC_DEFAULT"))
@JvmField val LITHIC_RULES = DecisionMadeBy(JsonField.of("LITHIC_RULES"))
@JvmField val NETWORK = DecisionMadeBy(JsonField.of("NETWORK"))
@JvmField val UNKNOWN = DecisionMadeBy(JsonField.of("UNKNOWN"))
@JvmStatic fun of(value: String) = DecisionMadeBy(JsonField.of(value))
}
enum class Known {
CUSTOMER_ENDPOINT,
LITHIC_DEFAULT,
LITHIC_RULES,
NETWORK,
UNKNOWN,
}
enum class Value {
CUSTOMER_ENDPOINT,
LITHIC_DEFAULT,
LITHIC_RULES,
NETWORK,
UNKNOWN,
_UNKNOWN,
}
fun value(): Value =
when (this) {
CUSTOMER_ENDPOINT -> Value.CUSTOMER_ENDPOINT
LITHIC_DEFAULT -> Value.LITHIC_DEFAULT
LITHIC_RULES -> Value.LITHIC_RULES
NETWORK -> Value.NETWORK
UNKNOWN -> Value.UNKNOWN
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
CUSTOMER_ENDPOINT -> Known.CUSTOMER_ENDPOINT
LITHIC_DEFAULT -> Known.LITHIC_DEFAULT
LITHIC_RULES -> Known.LITHIC_RULES
NETWORK -> Known.NETWORK
UNKNOWN -> Known.UNKNOWN
else -> throw LithicInvalidDataException("Unknown DecisionMadeBy: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
/** Object containing data about the merchant involved in the e-commerce transaction. */
@JsonDeserialize(builder = Merchant.Builder::class)
@NoAutoDetect
class Merchant
private constructor(
private val country: JsonField,
private val id: JsonField,
private val mcc: JsonField,
private val name: JsonField,
private val riskIndicator: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/**
* Country code of the merchant requesting 3DS authentication. Maps to EMV 3DS field
* merchantCountryCode.
*/
fun country(): String = country.getRequired("country")
/**
* Merchant identifier as assigned by the acquirer. Maps to EMV 3DS field
* acquirerMerchantId.
*/
fun id(): String = id.getRequired("id")
/**
* Merchant category code assigned to the merchant that describes its business activity
* type. Maps to EMV 3DS field mcc.
*/
fun mcc(): String = mcc.getRequired("mcc")
/** Name of the merchant. Maps to EMV 3DS field merchantName. */
fun name(): String = name.getRequired("name")
/**
* Object containing additional data indicating additional risk factors related to the
* e-commerce transaction.
*/
fun riskIndicator(): RiskIndicator = riskIndicator.getRequired("risk_indicator")
/**
* Country code of the merchant requesting 3DS authentication. Maps to EMV 3DS field
* merchantCountryCode.
*/
@JsonProperty("country") @ExcludeMissing fun _country() = country
/**
* Merchant identifier as assigned by the acquirer. Maps to EMV 3DS field
* acquirerMerchantId.
*/
@JsonProperty("id") @ExcludeMissing fun _id() = id
/**
* Merchant category code assigned to the merchant that describes its business activity
* type. Maps to EMV 3DS field mcc.
*/
@JsonProperty("mcc") @ExcludeMissing fun _mcc() = mcc
/** Name of the merchant. Maps to EMV 3DS field merchantName. */
@JsonProperty("name") @ExcludeMissing fun _name() = name
/**
* Object containing additional data indicating additional risk factors related to the
* e-commerce transaction.
*/
@JsonProperty("risk_indicator") @ExcludeMissing fun _riskIndicator() = riskIndicator
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): Merchant = apply {
if (!validated) {
country()
id()
mcc()
name()
riskIndicator().validate()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Merchant &&
this.country == other.country &&
this.id == other.id &&
this.mcc == other.mcc &&
this.name == other.name &&
this.riskIndicator == other.riskIndicator &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
country,
id,
mcc,
name,
riskIndicator,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Merchant{country=$country, id=$id, mcc=$mcc, name=$name, riskIndicator=$riskIndicator, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var country: JsonField = JsonMissing.of()
private var id: JsonField = JsonMissing.of()
private var mcc: JsonField = JsonMissing.of()
private var name: JsonField = JsonMissing.of()
private var riskIndicator: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(merchant: Merchant) = apply {
this.country = merchant.country
this.id = merchant.id
this.mcc = merchant.mcc
this.name = merchant.name
this.riskIndicator = merchant.riskIndicator
additionalProperties(merchant.additionalProperties)
}
/**
* Country code of the merchant requesting 3DS authentication. Maps to EMV 3DS field
* merchantCountryCode.
*/
fun country(country: String) = country(JsonField.of(country))
/**
* Country code of the merchant requesting 3DS authentication. Maps to EMV 3DS field
* merchantCountryCode.
*/
@JsonProperty("country")
@ExcludeMissing
fun country(country: JsonField) = apply { this.country = country }
/**
* Merchant identifier as assigned by the acquirer. Maps to EMV 3DS field
* acquirerMerchantId.
*/
fun id(id: String) = id(JsonField.of(id))
/**
* Merchant identifier as assigned by the acquirer. Maps to EMV 3DS field
* acquirerMerchantId.
*/
@JsonProperty("id")
@ExcludeMissing
fun id(id: JsonField) = apply { this.id = id }
/**
* Merchant category code assigned to the merchant that describes its business activity
* type. Maps to EMV 3DS field mcc.
*/
fun mcc(mcc: String) = mcc(JsonField.of(mcc))
/**
* Merchant category code assigned to the merchant that describes its business activity
* type. Maps to EMV 3DS field mcc.
*/
@JsonProperty("mcc")
@ExcludeMissing
fun mcc(mcc: JsonField) = apply { this.mcc = mcc }
/** Name of the merchant. Maps to EMV 3DS field merchantName. */
fun name(name: String) = name(JsonField.of(name))
/** Name of the merchant. Maps to EMV 3DS field merchantName. */
@JsonProperty("name")
@ExcludeMissing
fun name(name: JsonField) = apply { this.name = name }
/**
* Object containing additional data indicating additional risk factors related to the
* e-commerce transaction.
*/
fun riskIndicator(riskIndicator: RiskIndicator) =
riskIndicator(JsonField.of(riskIndicator))
/**
* Object containing additional data indicating additional risk factors related to the
* e-commerce transaction.
*/
@JsonProperty("risk_indicator")
@ExcludeMissing
fun riskIndicator(riskIndicator: JsonField) = apply {
this.riskIndicator = riskIndicator
}
fun additionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.clear()
this.additionalProperties.putAll(additionalProperties)
}
@JsonAnySetter
fun putAdditionalProperty(key: String, value: JsonValue) = apply {
this.additionalProperties.put(key, value)
}
fun putAllAdditionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.putAll(additionalProperties)
}
fun build(): Merchant =
Merchant(
country,
id,
mcc,
name,
riskIndicator,
additionalProperties.toUnmodifiable(),
)
}
/**
* Object containing additional data indicating additional risk factors related to the
* e-commerce transaction.
*/
@JsonDeserialize(builder = RiskIndicator.Builder::class)
@NoAutoDetect
class RiskIndicator
private constructor(
private val deliveryEmailAddress: JsonField,
private val deliveryTimeFrame: JsonField,
private val giftCardAmount: JsonField,
private val giftCardCount: JsonField,
private val giftCardCurrency: JsonField,
private val orderAvailability: JsonField,
private val preOrderAvailableDate: JsonField,
private val reorderItems: JsonField,
private val shippingMethod: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/**
* In transactions with electronic delivery, email address to which merchandise is
* delivered. Maps to EMV 3DS field deliveryEmailAddress.
*/
fun deliveryEmailAddress(): Optional =
Optional.ofNullable(deliveryEmailAddress.getNullable("delivery_email_address"))
/**
* The delivery time frame for the merchandise. Maps to EMV 3DS field deliveryTimeframe.
*/
fun deliveryTimeFrame(): Optional =
Optional.ofNullable(deliveryTimeFrame.getNullable("delivery_time_frame"))
/**
* In prepaid or gift card purchase transactions, purchase amount total in major units
* (e.g., a purchase of USD $205.10 would be 205). Maps to EMV 3DS field giftCardAmount.
*/
fun giftCardAmount(): Optional =
Optional.ofNullable(giftCardAmount.getNullable("gift_card_amount"))
/**
* In prepaid or gift card purchase transactions, count of individual prepaid or gift
* cards/codes purchased. Maps to EMV 3DS field giftCardCount.
*/
fun giftCardCount(): Optional =
Optional.ofNullable(giftCardCount.getNullable("gift_card_count"))
/**
* In prepaid or gift card purchase transactions, currency code of the gift card. Maps
* to EMV 3DS field giftCardCurr.
*/
fun giftCardCurrency(): Optional =
Optional.ofNullable(giftCardCurrency.getNullable("gift_card_currency"))
/**
* Indicates whether the purchase is for merchandise that is available now or at a
* future date. Maps to EMV 3DS field preOrderPurchaseInd.
*/
fun orderAvailability(): Optional =
Optional.ofNullable(orderAvailability.getNullable("order_availability"))
/**
* In pre-order purchase transactions, the expected date that the merchandise will be
* available. Maps to EMV 3DS field preOrderDate.
*/
fun preOrderAvailableDate(): Optional =
Optional.ofNullable(preOrderAvailableDate.getNullable("pre_order_available_date"))
/**
* Indicates whether the cardholder is reordering previously purchased merchandise. Maps
* to EMV 3DS field reorderItemsInd.
*/
fun reorderItems(): Optional =
Optional.ofNullable(reorderItems.getNullable("reorder_items"))
/**
* Shipping method that the cardholder chose for the transaction. If purchase includes
* one or more item, this indicator is used for the physical goods; if the purchase only
* includes digital goods, this indicator is used to describe the most expensive item
* purchased. Maps to EMV 3DS field shipIndicator.
*/
fun shippingMethod(): Optional =
Optional.ofNullable(shippingMethod.getNullable("shipping_method"))
/**
* In transactions with electronic delivery, email address to which merchandise is
* delivered. Maps to EMV 3DS field deliveryEmailAddress.
*/
@JsonProperty("delivery_email_address")
@ExcludeMissing
fun _deliveryEmailAddress() = deliveryEmailAddress
/**
* The delivery time frame for the merchandise. Maps to EMV 3DS field deliveryTimeframe.
*/
@JsonProperty("delivery_time_frame")
@ExcludeMissing
fun _deliveryTimeFrame() = deliveryTimeFrame
/**
* In prepaid or gift card purchase transactions, purchase amount total in major units
* (e.g., a purchase of USD $205.10 would be 205). Maps to EMV 3DS field giftCardAmount.
*/
@JsonProperty("gift_card_amount") @ExcludeMissing fun _giftCardAmount() = giftCardAmount
/**
* In prepaid or gift card purchase transactions, count of individual prepaid or gift
* cards/codes purchased. Maps to EMV 3DS field giftCardCount.
*/
@JsonProperty("gift_card_count") @ExcludeMissing fun _giftCardCount() = giftCardCount
/**
* In prepaid or gift card purchase transactions, currency code of the gift card. Maps
* to EMV 3DS field giftCardCurr.
*/
@JsonProperty("gift_card_currency")
@ExcludeMissing
fun _giftCardCurrency() = giftCardCurrency
/**
* Indicates whether the purchase is for merchandise that is available now or at a
* future date. Maps to EMV 3DS field preOrderPurchaseInd.
*/
@JsonProperty("order_availability")
@ExcludeMissing
fun _orderAvailability() = orderAvailability
/**
* In pre-order purchase transactions, the expected date that the merchandise will be
* available. Maps to EMV 3DS field preOrderDate.
*/
@JsonProperty("pre_order_available_date")
@ExcludeMissing
fun _preOrderAvailableDate() = preOrderAvailableDate
/**
* Indicates whether the cardholder is reordering previously purchased merchandise. Maps
* to EMV 3DS field reorderItemsInd.
*/
@JsonProperty("reorder_items") @ExcludeMissing fun _reorderItems() = reorderItems
/**
* Shipping method that the cardholder chose for the transaction. If purchase includes
* one or more item, this indicator is used for the physical goods; if the purchase only
* includes digital goods, this indicator is used to describe the most expensive item
* purchased. Maps to EMV 3DS field shipIndicator.
*/
@JsonProperty("shipping_method") @ExcludeMissing fun _shippingMethod() = shippingMethod
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): RiskIndicator = apply {
if (!validated) {
deliveryEmailAddress()
deliveryTimeFrame()
giftCardAmount()
giftCardCount()
giftCardCurrency()
orderAvailability()
preOrderAvailableDate()
reorderItems()
shippingMethod()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is RiskIndicator &&
this.deliveryEmailAddress == other.deliveryEmailAddress &&
this.deliveryTimeFrame == other.deliveryTimeFrame &&
this.giftCardAmount == other.giftCardAmount &&
this.giftCardCount == other.giftCardCount &&
this.giftCardCurrency == other.giftCardCurrency &&
this.orderAvailability == other.orderAvailability &&
this.preOrderAvailableDate == other.preOrderAvailableDate &&
this.reorderItems == other.reorderItems &&
this.shippingMethod == other.shippingMethod &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
deliveryEmailAddress,
deliveryTimeFrame,
giftCardAmount,
giftCardCount,
giftCardCurrency,
orderAvailability,
preOrderAvailableDate,
reorderItems,
shippingMethod,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"RiskIndicator{deliveryEmailAddress=$deliveryEmailAddress, deliveryTimeFrame=$deliveryTimeFrame, giftCardAmount=$giftCardAmount, giftCardCount=$giftCardCount, giftCardCurrency=$giftCardCurrency, orderAvailability=$orderAvailability, preOrderAvailableDate=$preOrderAvailableDate, reorderItems=$reorderItems, shippingMethod=$shippingMethod, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var deliveryEmailAddress: JsonField = JsonMissing.of()
private var deliveryTimeFrame: JsonField = JsonMissing.of()
private var giftCardAmount: JsonField = JsonMissing.of()
private var giftCardCount: JsonField = JsonMissing.of()
private var giftCardCurrency: JsonField = JsonMissing.of()
private var orderAvailability: JsonField = JsonMissing.of()
private var preOrderAvailableDate: JsonField = JsonMissing.of()
private var reorderItems: JsonField = JsonMissing.of()
private var shippingMethod: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(riskIndicator: RiskIndicator) = apply {
this.deliveryEmailAddress = riskIndicator.deliveryEmailAddress
this.deliveryTimeFrame = riskIndicator.deliveryTimeFrame
this.giftCardAmount = riskIndicator.giftCardAmount
this.giftCardCount = riskIndicator.giftCardCount
this.giftCardCurrency = riskIndicator.giftCardCurrency
this.orderAvailability = riskIndicator.orderAvailability
this.preOrderAvailableDate = riskIndicator.preOrderAvailableDate
this.reorderItems = riskIndicator.reorderItems
this.shippingMethod = riskIndicator.shippingMethod
additionalProperties(riskIndicator.additionalProperties)
}
/**
* In transactions with electronic delivery, email address to which merchandise is
* delivered. Maps to EMV 3DS field deliveryEmailAddress.
*/
fun deliveryEmailAddress(deliveryEmailAddress: String) =
deliveryEmailAddress(JsonField.of(deliveryEmailAddress))
/**
* In transactions with electronic delivery, email address to which merchandise is
* delivered. Maps to EMV 3DS field deliveryEmailAddress.
*/
@JsonProperty("delivery_email_address")
@ExcludeMissing
fun deliveryEmailAddress(deliveryEmailAddress: JsonField) = apply {
this.deliveryEmailAddress = deliveryEmailAddress
}
/**
* The delivery time frame for the merchandise. Maps to EMV 3DS field
* deliveryTimeframe.
*/
fun deliveryTimeFrame(deliveryTimeFrame: DeliveryTimeFrame) =
deliveryTimeFrame(JsonField.of(deliveryTimeFrame))
/**
* The delivery time frame for the merchandise. Maps to EMV 3DS field
* deliveryTimeframe.
*/
@JsonProperty("delivery_time_frame")
@ExcludeMissing
fun deliveryTimeFrame(deliveryTimeFrame: JsonField) = apply {
this.deliveryTimeFrame = deliveryTimeFrame
}
/**
* In prepaid or gift card purchase transactions, purchase amount total in major
* units (e.g., a purchase of USD $205.10 would be 205). Maps to EMV 3DS field
* giftCardAmount.
*/
fun giftCardAmount(giftCardAmount: Double) =
giftCardAmount(JsonField.of(giftCardAmount))
/**
* In prepaid or gift card purchase transactions, purchase amount total in major
* units (e.g., a purchase of USD $205.10 would be 205). Maps to EMV 3DS field
* giftCardAmount.
*/
@JsonProperty("gift_card_amount")
@ExcludeMissing
fun giftCardAmount(giftCardAmount: JsonField) = apply {
this.giftCardAmount = giftCardAmount
}
/**
* In prepaid or gift card purchase transactions, count of individual prepaid or
* gift cards/codes purchased. Maps to EMV 3DS field giftCardCount.
*/
fun giftCardCount(giftCardCount: Double) =
giftCardCount(JsonField.of(giftCardCount))
/**
* In prepaid or gift card purchase transactions, count of individual prepaid or
* gift cards/codes purchased. Maps to EMV 3DS field giftCardCount.
*/
@JsonProperty("gift_card_count")
@ExcludeMissing
fun giftCardCount(giftCardCount: JsonField) = apply {
this.giftCardCount = giftCardCount
}
/**
* In prepaid or gift card purchase transactions, currency code of the gift card.
* Maps to EMV 3DS field giftCardCurr.
*/
fun giftCardCurrency(giftCardCurrency: String) =
giftCardCurrency(JsonField.of(giftCardCurrency))
/**
* In prepaid or gift card purchase transactions, currency code of the gift card.
* Maps to EMV 3DS field giftCardCurr.
*/
@JsonProperty("gift_card_currency")
@ExcludeMissing
fun giftCardCurrency(giftCardCurrency: JsonField) = apply {
this.giftCardCurrency = giftCardCurrency
}
/**
* Indicates whether the purchase is for merchandise that is available now or at a
* future date. Maps to EMV 3DS field preOrderPurchaseInd.
*/
fun orderAvailability(orderAvailability: OrderAvailability) =
orderAvailability(JsonField.of(orderAvailability))
/**
* Indicates whether the purchase is for merchandise that is available now or at a
* future date. Maps to EMV 3DS field preOrderPurchaseInd.
*/
@JsonProperty("order_availability")
@ExcludeMissing
fun orderAvailability(orderAvailability: JsonField) = apply {
this.orderAvailability = orderAvailability
}
/**
* In pre-order purchase transactions, the expected date that the merchandise will
* be available. Maps to EMV 3DS field preOrderDate.
*/
fun preOrderAvailableDate(preOrderAvailableDate: OffsetDateTime) =
preOrderAvailableDate(JsonField.of(preOrderAvailableDate))
/**
* In pre-order purchase transactions, the expected date that the merchandise will
* be available. Maps to EMV 3DS field preOrderDate.
*/
@JsonProperty("pre_order_available_date")
@ExcludeMissing
fun preOrderAvailableDate(preOrderAvailableDate: JsonField) =
apply {
this.preOrderAvailableDate = preOrderAvailableDate
}
/**
* Indicates whether the cardholder is reordering previously purchased merchandise.
* Maps to EMV 3DS field reorderItemsInd.
*/
fun reorderItems(reorderItems: ReorderItems) =
reorderItems(JsonField.of(reorderItems))
/**
* Indicates whether the cardholder is reordering previously purchased merchandise.
* Maps to EMV 3DS field reorderItemsInd.
*/
@JsonProperty("reorder_items")
@ExcludeMissing
fun reorderItems(reorderItems: JsonField) = apply {
this.reorderItems = reorderItems
}
/**
* Shipping method that the cardholder chose for the transaction. If purchase
* includes one or more item, this indicator is used for the physical goods; if the
* purchase only includes digital goods, this indicator is used to describe the most
* expensive item purchased. Maps to EMV 3DS field shipIndicator.
*/
fun shippingMethod(shippingMethod: ShippingMethod) =
shippingMethod(JsonField.of(shippingMethod))
/**
* Shipping method that the cardholder chose for the transaction. If purchase
* includes one or more item, this indicator is used for the physical goods; if the
* purchase only includes digital goods, this indicator is used to describe the most
* expensive item purchased. Maps to EMV 3DS field shipIndicator.
*/
@JsonProperty("shipping_method")
@ExcludeMissing
fun shippingMethod(shippingMethod: JsonField) = apply {
this.shippingMethod = shippingMethod
}
fun additionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.clear()
this.additionalProperties.putAll(additionalProperties)
}
@JsonAnySetter
fun putAdditionalProperty(key: String, value: JsonValue) = apply {
this.additionalProperties.put(key, value)
}
fun putAllAdditionalProperties(additionalProperties: Map) =
apply {
this.additionalProperties.putAll(additionalProperties)
}
fun build(): RiskIndicator =
RiskIndicator(
deliveryEmailAddress,
deliveryTimeFrame,
giftCardAmount,
giftCardCount,
giftCardCurrency,
orderAvailability,
preOrderAvailableDate,
reorderItems,
shippingMethod,
additionalProperties.toUnmodifiable(),
)
}
class DeliveryTimeFrame
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is DeliveryTimeFrame && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField
val ELECTRONIC_DELIVERY = DeliveryTimeFrame(JsonField.of("ELECTRONIC_DELIVERY"))
@JvmField
val OVERNIGHT_SHIPPING = DeliveryTimeFrame(JsonField.of("OVERNIGHT_SHIPPING"))
@JvmField
val SAME_DAY_SHIPPING = DeliveryTimeFrame(JsonField.of("SAME_DAY_SHIPPING"))
@JvmField
val TWO_DAY_OR_MORE_SHIPPING =
DeliveryTimeFrame(JsonField.of("TWO_DAY_OR_MORE_SHIPPING"))
@JvmStatic fun of(value: String) = DeliveryTimeFrame(JsonField.of(value))
}
enum class Known {
ELECTRONIC_DELIVERY,
OVERNIGHT_SHIPPING,
SAME_DAY_SHIPPING,
TWO_DAY_OR_MORE_SHIPPING,
}
enum class Value {
ELECTRONIC_DELIVERY,
OVERNIGHT_SHIPPING,
SAME_DAY_SHIPPING,
TWO_DAY_OR_MORE_SHIPPING,
_UNKNOWN,
}
fun value(): Value =
when (this) {
ELECTRONIC_DELIVERY -> Value.ELECTRONIC_DELIVERY
OVERNIGHT_SHIPPING -> Value.OVERNIGHT_SHIPPING
SAME_DAY_SHIPPING -> Value.SAME_DAY_SHIPPING
TWO_DAY_OR_MORE_SHIPPING -> Value.TWO_DAY_OR_MORE_SHIPPING
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
ELECTRONIC_DELIVERY -> Known.ELECTRONIC_DELIVERY
OVERNIGHT_SHIPPING -> Known.OVERNIGHT_SHIPPING
SAME_DAY_SHIPPING -> Known.SAME_DAY_SHIPPING
TWO_DAY_OR_MORE_SHIPPING -> Known.TWO_DAY_OR_MORE_SHIPPING
else ->
throw LithicInvalidDataException("Unknown DeliveryTimeFrame: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
class OrderAvailability
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is OrderAvailability && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField
val FUTURE_AVAILABILITY = OrderAvailability(JsonField.of("FUTURE_AVAILABILITY"))
@JvmField
val MERCHANDISE_AVAILABLE =
OrderAvailability(JsonField.of("MERCHANDISE_AVAILABLE"))
@JvmStatic fun of(value: String) = OrderAvailability(JsonField.of(value))
}
enum class Known {
FUTURE_AVAILABILITY,
MERCHANDISE_AVAILABLE,
}
enum class Value {
FUTURE_AVAILABILITY,
MERCHANDISE_AVAILABLE,
_UNKNOWN,
}
fun value(): Value =
when (this) {
FUTURE_AVAILABILITY -> Value.FUTURE_AVAILABILITY
MERCHANDISE_AVAILABLE -> Value.MERCHANDISE_AVAILABLE
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
FUTURE_AVAILABILITY -> Known.FUTURE_AVAILABILITY
MERCHANDISE_AVAILABLE -> Known.MERCHANDISE_AVAILABLE
else ->
throw LithicInvalidDataException("Unknown OrderAvailability: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
class ReorderItems
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is ReorderItems && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField
val FIRST_TIME_ORDERED = ReorderItems(JsonField.of("FIRST_TIME_ORDERED"))
@JvmField val REORDERED = ReorderItems(JsonField.of("REORDERED"))
@JvmStatic fun of(value: String) = ReorderItems(JsonField.of(value))
}
enum class Known {
FIRST_TIME_ORDERED,
REORDERED,
}
enum class Value {
FIRST_TIME_ORDERED,
REORDERED,
_UNKNOWN,
}
fun value(): Value =
when (this) {
FIRST_TIME_ORDERED -> Value.FIRST_TIME_ORDERED
REORDERED -> Value.REORDERED
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
FIRST_TIME_ORDERED -> Known.FIRST_TIME_ORDERED
REORDERED -> Known.REORDERED
else -> throw LithicInvalidDataException("Unknown ReorderItems: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
class ShippingMethod
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is ShippingMethod && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val DIGITAL_GOODS = ShippingMethod(JsonField.of("DIGITAL_GOODS"))
@JvmField val LOCKER_DELIVERY = ShippingMethod(JsonField.of("LOCKER_DELIVERY"))
@JvmField val OTHER = ShippingMethod(JsonField.of("OTHER"))
@JvmField
val PICK_UP_AND_GO_DELIVERY =
ShippingMethod(JsonField.of("PICK_UP_AND_GO_DELIVERY"))
@JvmField
val SHIP_TO_BILLING_ADDRESS =
ShippingMethod(JsonField.of("SHIP_TO_BILLING_ADDRESS"))
@JvmField
val SHIP_TO_NON_BILLING_ADDRESS =
ShippingMethod(JsonField.of("SHIP_TO_NON_BILLING_ADDRESS"))
@JvmField
val SHIP_TO_OTHER_VERIFIED_ADDRESS =
ShippingMethod(JsonField.of("SHIP_TO_OTHER_VERIFIED_ADDRESS"))
@JvmField val SHIP_TO_STORE = ShippingMethod(JsonField.of("SHIP_TO_STORE"))
@JvmField
val TRAVEL_AND_EVENT_TICKETS =
ShippingMethod(JsonField.of("TRAVEL_AND_EVENT_TICKETS"))
@JvmStatic fun of(value: String) = ShippingMethod(JsonField.of(value))
}
enum class Known {
DIGITAL_GOODS,
LOCKER_DELIVERY,
OTHER,
PICK_UP_AND_GO_DELIVERY,
SHIP_TO_BILLING_ADDRESS,
SHIP_TO_NON_BILLING_ADDRESS,
SHIP_TO_OTHER_VERIFIED_ADDRESS,
SHIP_TO_STORE,
TRAVEL_AND_EVENT_TICKETS,
}
enum class Value {
DIGITAL_GOODS,
LOCKER_DELIVERY,
OTHER,
PICK_UP_AND_GO_DELIVERY,
SHIP_TO_BILLING_ADDRESS,
SHIP_TO_NON_BILLING_ADDRESS,
SHIP_TO_OTHER_VERIFIED_ADDRESS,
SHIP_TO_STORE,
TRAVEL_AND_EVENT_TICKETS,
_UNKNOWN,
}
fun value(): Value =
when (this) {
DIGITAL_GOODS -> Value.DIGITAL_GOODS
LOCKER_DELIVERY -> Value.LOCKER_DELIVERY
OTHER -> Value.OTHER
PICK_UP_AND_GO_DELIVERY -> Value.PICK_UP_AND_GO_DELIVERY
SHIP_TO_BILLING_ADDRESS -> Value.SHIP_TO_BILLING_ADDRESS
SHIP_TO_NON_BILLING_ADDRESS -> Value.SHIP_TO_NON_BILLING_ADDRESS
SHIP_TO_OTHER_VERIFIED_ADDRESS -> Value.SHIP_TO_OTHER_VERIFIED_ADDRESS
SHIP_TO_STORE -> Value.SHIP_TO_STORE
TRAVEL_AND_EVENT_TICKETS -> Value.TRAVEL_AND_EVENT_TICKETS
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
DIGITAL_GOODS -> Known.DIGITAL_GOODS
LOCKER_DELIVERY -> Known.LOCKER_DELIVERY
OTHER -> Known.OTHER
PICK_UP_AND_GO_DELIVERY -> Known.PICK_UP_AND_GO_DELIVERY
SHIP_TO_BILLING_ADDRESS -> Known.SHIP_TO_BILLING_ADDRESS
SHIP_TO_NON_BILLING_ADDRESS -> Known.SHIP_TO_NON_BILLING_ADDRESS
SHIP_TO_OTHER_VERIFIED_ADDRESS -> Known.SHIP_TO_OTHER_VERIFIED_ADDRESS
SHIP_TO_STORE -> Known.SHIP_TO_STORE
TRAVEL_AND_EVENT_TICKETS -> Known.TRAVEL_AND_EVENT_TICKETS
else -> throw LithicInvalidDataException("Unknown ShippingMethod: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
}
}
class MessageCategory
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is MessageCategory && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField
val NON_PAYMENT_AUTHENTICATION =
MessageCategory(JsonField.of("NON_PAYMENT_AUTHENTICATION"))
@JvmField
val PAYMENT_AUTHENTICATION = MessageCategory(JsonField.of("PAYMENT_AUTHENTICATION"))
@JvmStatic fun of(value: String) = MessageCategory(JsonField.of(value))
}
enum class Known {
NON_PAYMENT_AUTHENTICATION,
PAYMENT_AUTHENTICATION,
}
enum class Value {
NON_PAYMENT_AUTHENTICATION,
PAYMENT_AUTHENTICATION,
_UNKNOWN,
}
fun value(): Value =
when (this) {
NON_PAYMENT_AUTHENTICATION -> Value.NON_PAYMENT_AUTHENTICATION
PAYMENT_AUTHENTICATION -> Value.PAYMENT_AUTHENTICATION
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
NON_PAYMENT_AUTHENTICATION -> Known.NON_PAYMENT_AUTHENTICATION
PAYMENT_AUTHENTICATION -> Known.PAYMENT_AUTHENTICATION
else -> throw LithicInvalidDataException("Unknown MessageCategory: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
/**
* Object containing additional data about the 3DS request that is beyond the EMV 3DS standard
* spec (e.g., specific fields that only certain card networks send but are not required across
* all 3DS requests).
*/
@JsonDeserialize(builder = AdditionalData.Builder::class)
@NoAutoDetect
class AdditionalData
private constructor(
private val networkDecision: JsonField,
private val networkRiskScore: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/**
* Mastercard only: Indicates whether the network would have considered the authentication
* request to be low risk or not.
*/
fun networkDecision(): Optional =
Optional.ofNullable(networkDecision.getNullable("network_decision"))
/**
* Mastercard only: Assessment by the network of the authentication risk level, with a
* higher value indicating a higher amount of risk.
*/
fun networkRiskScore(): Optional =
Optional.ofNullable(networkRiskScore.getNullable("network_risk_score"))
/**
* Mastercard only: Indicates whether the network would have considered the authentication
* request to be low risk or not.
*/
@JsonProperty("network_decision") @ExcludeMissing fun _networkDecision() = networkDecision
/**
* Mastercard only: Assessment by the network of the authentication risk level, with a
* higher value indicating a higher amount of risk.
*/
@JsonProperty("network_risk_score")
@ExcludeMissing
fun _networkRiskScore() = networkRiskScore
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): AdditionalData = apply {
if (!validated) {
networkDecision()
networkRiskScore()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is AdditionalData &&
this.networkDecision == other.networkDecision &&
this.networkRiskScore == other.networkRiskScore &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
networkDecision,
networkRiskScore,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"AdditionalData{networkDecision=$networkDecision, networkRiskScore=$networkRiskScore, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var networkDecision: JsonField = JsonMissing.of()
private var networkRiskScore: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(additionalData: AdditionalData) = apply {
this.networkDecision = additionalData.networkDecision
this.networkRiskScore = additionalData.networkRiskScore
additionalProperties(additionalData.additionalProperties)
}
/**
* Mastercard only: Indicates whether the network would have considered the
* authentication request to be low risk or not.
*/
fun networkDecision(networkDecision: NetworkDecision) =
networkDecision(JsonField.of(networkDecision))
/**
* Mastercard only: Indicates whether the network would have considered the
* authentication request to be low risk or not.
*/
@JsonProperty("network_decision")
@ExcludeMissing
fun networkDecision(networkDecision: JsonField) = apply {
this.networkDecision = networkDecision
}
/**
* Mastercard only: Assessment by the network of the authentication risk level, with a
* higher value indicating a higher amount of risk.
*/
fun networkRiskScore(networkRiskScore: Double) =
networkRiskScore(JsonField.of(networkRiskScore))
/**
* Mastercard only: Assessment by the network of the authentication risk level, with a
* higher value indicating a higher amount of risk.
*/
@JsonProperty("network_risk_score")
@ExcludeMissing
fun networkRiskScore(networkRiskScore: JsonField) = apply {
this.networkRiskScore = networkRiskScore
}
fun additionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.clear()
this.additionalProperties.putAll(additionalProperties)
}
@JsonAnySetter
fun putAdditionalProperty(key: String, value: JsonValue) = apply {
this.additionalProperties.put(key, value)
}
fun putAllAdditionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.putAll(additionalProperties)
}
fun build(): AdditionalData =
AdditionalData(
networkDecision,
networkRiskScore,
additionalProperties.toUnmodifiable(),
)
}
class NetworkDecision
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is NetworkDecision && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val LOW_RISK = NetworkDecision(JsonField.of("LOW_RISK"))
@JvmField val NOT_LOW_RISK = NetworkDecision(JsonField.of("NOT_LOW_RISK"))
@JvmStatic fun of(value: String) = NetworkDecision(JsonField.of(value))
}
enum class Known {
LOW_RISK,
NOT_LOW_RISK,
}
enum class Value {
LOW_RISK,
NOT_LOW_RISK,
_UNKNOWN,
}
fun value(): Value =
when (this) {
LOW_RISK -> Value.LOW_RISK
NOT_LOW_RISK -> Value.NOT_LOW_RISK
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
LOW_RISK -> Known.LOW_RISK
NOT_LOW_RISK -> Known.NOT_LOW_RISK
else -> throw LithicInvalidDataException("Unknown NetworkDecision: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
}
/**
* Object containing data about the app used in the e-commerce transaction. Present if the
* channel is 'APP_BASED'.
*/
@JsonDeserialize(builder = App.Builder::class)
@NoAutoDetect
class App
private constructor(
private val deviceInfo: JsonField,
private val ip: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/**
* Device information gathered from the cardholder's device - JSON name/value pairs that is
* Base64url encoded. Maps to EMV 3DS field deviceInfo.
*/
fun deviceInfo(): Optional =
Optional.ofNullable(deviceInfo.getNullable("device_info"))
/**
* External IP address used by the app generating the 3DS authentication request. Maps to
* EMV 3DS field appIp.
*/
fun ip(): Optional = Optional.ofNullable(ip.getNullable("ip"))
/**
* Device information gathered from the cardholder's device - JSON name/value pairs that is
* Base64url encoded. Maps to EMV 3DS field deviceInfo.
*/
@JsonProperty("device_info") @ExcludeMissing fun _deviceInfo() = deviceInfo
/**
* External IP address used by the app generating the 3DS authentication request. Maps to
* EMV 3DS field appIp.
*/
@JsonProperty("ip") @ExcludeMissing fun _ip() = ip
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): App = apply {
if (!validated) {
deviceInfo()
ip()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is App &&
this.deviceInfo == other.deviceInfo &&
this.ip == other.ip &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
deviceInfo,
ip,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"App{deviceInfo=$deviceInfo, ip=$ip, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var deviceInfo: JsonField = JsonMissing.of()
private var ip: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(app: App) = apply {
this.deviceInfo = app.deviceInfo
this.ip = app.ip
additionalProperties(app.additionalProperties)
}
/**
* Device information gathered from the cardholder's device - JSON name/value pairs that
* is Base64url encoded. Maps to EMV 3DS field deviceInfo.
*/
fun deviceInfo(deviceInfo: String) = deviceInfo(JsonField.of(deviceInfo))
/**
* Device information gathered from the cardholder's device - JSON name/value pairs that
* is Base64url encoded. Maps to EMV 3DS field deviceInfo.
*/
@JsonProperty("device_info")
@ExcludeMissing
fun deviceInfo(deviceInfo: JsonField) = apply { this.deviceInfo = deviceInfo }
/**
* External IP address used by the app generating the 3DS authentication request. Maps
* to EMV 3DS field appIp.
*/
fun ip(ip: String) = ip(JsonField.of(ip))
/**
* External IP address used by the app generating the 3DS authentication request. Maps
* to EMV 3DS field appIp.
*/
@JsonProperty("ip")
@ExcludeMissing
fun ip(ip: JsonField) = apply { this.ip = ip }
fun additionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.clear()
this.additionalProperties.putAll(additionalProperties)
}
@JsonAnySetter
fun putAdditionalProperty(key: String, value: JsonValue) = apply {
this.additionalProperties.put(key, value)
}
fun putAllAdditionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.putAll(additionalProperties)
}
fun build(): App =
App(
deviceInfo,
ip,
additionalProperties.toUnmodifiable(),
)
}
}
class AuthenticationRequestType
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is AuthenticationRequestType && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val ADD_CARD = AuthenticationRequestType(JsonField.of("ADD_CARD"))
@JvmField
val BILLING_AGREEMENT = AuthenticationRequestType(JsonField.of("BILLING_AGREEMENT"))
@JvmField
val DELAYED_SHIPMENT = AuthenticationRequestType(JsonField.of("DELAYED_SHIPMENT"))
@JvmField
val EMV_TOKEN_CARDHOLDER_VERIFICATION =
AuthenticationRequestType(JsonField.of("EMV_TOKEN_CARDHOLDER_VERIFICATION"))
@JvmField
val INSTALLMENT_TRANSACTION =
AuthenticationRequestType(JsonField.of("INSTALLMENT_TRANSACTION"))
@JvmField val MAINTAIN_CARD = AuthenticationRequestType(JsonField.of("MAINTAIN_CARD"))
@JvmField
val PAYMENT_TRANSACTION = AuthenticationRequestType(JsonField.of("PAYMENT_TRANSACTION"))
@JvmField
val RECURRING_TRANSACTION =
AuthenticationRequestType(JsonField.of("RECURRING_TRANSACTION"))
@JvmField val SPLIT_PAYMENT = AuthenticationRequestType(JsonField.of("SPLIT_PAYMENT"))
@JvmField val SPLIT_SHIPMENT = AuthenticationRequestType(JsonField.of("SPLIT_SHIPMENT"))
@JvmStatic fun of(value: String) = AuthenticationRequestType(JsonField.of(value))
}
enum class Known {
ADD_CARD,
BILLING_AGREEMENT,
DELAYED_SHIPMENT,
EMV_TOKEN_CARDHOLDER_VERIFICATION,
INSTALLMENT_TRANSACTION,
MAINTAIN_CARD,
PAYMENT_TRANSACTION,
RECURRING_TRANSACTION,
SPLIT_PAYMENT,
SPLIT_SHIPMENT,
}
enum class Value {
ADD_CARD,
BILLING_AGREEMENT,
DELAYED_SHIPMENT,
EMV_TOKEN_CARDHOLDER_VERIFICATION,
INSTALLMENT_TRANSACTION,
MAINTAIN_CARD,
PAYMENT_TRANSACTION,
RECURRING_TRANSACTION,
SPLIT_PAYMENT,
SPLIT_SHIPMENT,
_UNKNOWN,
}
fun value(): Value =
when (this) {
ADD_CARD -> Value.ADD_CARD
BILLING_AGREEMENT -> Value.BILLING_AGREEMENT
DELAYED_SHIPMENT -> Value.DELAYED_SHIPMENT
EMV_TOKEN_CARDHOLDER_VERIFICATION -> Value.EMV_TOKEN_CARDHOLDER_VERIFICATION
INSTALLMENT_TRANSACTION -> Value.INSTALLMENT_TRANSACTION
MAINTAIN_CARD -> Value.MAINTAIN_CARD
PAYMENT_TRANSACTION -> Value.PAYMENT_TRANSACTION
RECURRING_TRANSACTION -> Value.RECURRING_TRANSACTION
SPLIT_PAYMENT -> Value.SPLIT_PAYMENT
SPLIT_SHIPMENT -> Value.SPLIT_SHIPMENT
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
ADD_CARD -> Known.ADD_CARD
BILLING_AGREEMENT -> Known.BILLING_AGREEMENT
DELAYED_SHIPMENT -> Known.DELAYED_SHIPMENT
EMV_TOKEN_CARDHOLDER_VERIFICATION -> Known.EMV_TOKEN_CARDHOLDER_VERIFICATION
INSTALLMENT_TRANSACTION -> Known.INSTALLMENT_TRANSACTION
MAINTAIN_CARD -> Known.MAINTAIN_CARD
PAYMENT_TRANSACTION -> Known.PAYMENT_TRANSACTION
RECURRING_TRANSACTION -> Known.RECURRING_TRANSACTION
SPLIT_PAYMENT -> Known.SPLIT_PAYMENT
SPLIT_SHIPMENT -> Known.SPLIT_SHIPMENT
else ->
throw LithicInvalidDataException("Unknown AuthenticationRequestType: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
/**
* Object containing data about the browser used in the e-commerce transaction. Present if the
* channel is 'BROWSER'.
*/
@JsonDeserialize(builder = Browser.Builder::class)
@NoAutoDetect
class Browser
private constructor(
private val ip: JsonField,
private val javaEnabled: JsonField,
private val javascriptEnabled: JsonField,
private val language: JsonField,
private val timeZone: JsonField,
private val userAgent: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/**
* IP address of the browser as returned by the HTTP headers to the 3DS requestor (e.g.,
* merchant or digital wallet). Maps to EMV 3DS field browserIP.
*/
fun ip(): Optional = Optional.ofNullable(ip.getNullable("ip"))
/**
* Indicates whether the cardholder's browser has the ability to execute Java. Maps to EMV
* 3DS field browserJavaEnabled.
*/
fun javaEnabled(): Optional