Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
// File generated from our OpenAPI spec by Stainless.
package com.increase.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.increase.api.core.Enum
import com.increase.api.core.ExcludeMissing
import com.increase.api.core.JsonField
import com.increase.api.core.JsonMissing
import com.increase.api.core.JsonValue
import com.increase.api.core.NoAutoDetect
import com.increase.api.core.toImmutable
import com.increase.api.errors.IncreaseInvalidDataException
import java.time.OffsetDateTime
import java.util.Objects
/**
* Real Time Decisions are created when your application needs to take action in real-time to some
* event such as a card authorization. For more information, see our
* [Real-Time Decisions guide](https://increase.com/documentation/real-time-decisions).
*/
@JsonDeserialize(builder = RealTimeDecision.Builder::class)
@NoAutoDetect
class RealTimeDecision
private constructor(
private val cardAuthentication: JsonField,
private val cardAuthenticationChallenge: JsonField,
private val cardAuthorization: JsonField,
private val category: JsonField,
private val createdAt: JsonField,
private val digitalWalletAuthentication: JsonField,
private val digitalWalletToken: JsonField,
private val id: JsonField,
private val status: JsonField,
private val timeoutAt: JsonField,
private val type: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
/** Fields related to a 3DS authentication attempt. */
fun cardAuthentication(): CardAuthentication? =
cardAuthentication.getNullable("card_authentication")
/** Fields related to a 3DS authentication attempt. */
fun cardAuthenticationChallenge(): CardAuthenticationChallenge? =
cardAuthenticationChallenge.getNullable("card_authentication_challenge")
/** Fields related to a card authorization. */
fun cardAuthorization(): CardAuthorization? =
cardAuthorization.getNullable("card_authorization")
/** The category of the Real-Time Decision. */
fun category(): Category = category.getRequired("category")
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Real-Time
* Decision was created.
*/
fun createdAt(): OffsetDateTime = createdAt.getRequired("created_at")
/** Fields related to a digital wallet authentication attempt. */
fun digitalWalletAuthentication(): DigitalWalletAuthentication? =
digitalWalletAuthentication.getNullable("digital_wallet_authentication")
/** Fields related to a digital wallet token provisioning attempt. */
fun digitalWalletToken(): DigitalWalletToken? =
digitalWalletToken.getNullable("digital_wallet_token")
/** The Real-Time Decision identifier. */
fun id(): String = id.getRequired("id")
/** The status of the Real-Time Decision. */
fun status(): Status = status.getRequired("status")
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which your
* application can no longer respond to the Real-Time Decision.
*/
fun timeoutAt(): OffsetDateTime = timeoutAt.getRequired("timeout_at")
/**
* A constant representing the object's type. For this resource it will always be
* `real_time_decision`.
*/
fun type(): Type = type.getRequired("type")
/** Fields related to a 3DS authentication attempt. */
@JsonProperty("card_authentication")
@ExcludeMissing
fun _cardAuthentication() = cardAuthentication
/** Fields related to a 3DS authentication attempt. */
@JsonProperty("card_authentication_challenge")
@ExcludeMissing
fun _cardAuthenticationChallenge() = cardAuthenticationChallenge
/** Fields related to a card authorization. */
@JsonProperty("card_authorization") @ExcludeMissing fun _cardAuthorization() = cardAuthorization
/** The category of the Real-Time Decision. */
@JsonProperty("category") @ExcludeMissing fun _category() = category
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Real-Time
* Decision was created.
*/
@JsonProperty("created_at") @ExcludeMissing fun _createdAt() = createdAt
/** Fields related to a digital wallet authentication attempt. */
@JsonProperty("digital_wallet_authentication")
@ExcludeMissing
fun _digitalWalletAuthentication() = digitalWalletAuthentication
/** Fields related to a digital wallet token provisioning attempt. */
@JsonProperty("digital_wallet_token")
@ExcludeMissing
fun _digitalWalletToken() = digitalWalletToken
/** The Real-Time Decision identifier. */
@JsonProperty("id") @ExcludeMissing fun _id() = id
/** The status of the Real-Time Decision. */
@JsonProperty("status") @ExcludeMissing fun _status() = status
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which your
* application can no longer respond to the Real-Time Decision.
*/
@JsonProperty("timeout_at") @ExcludeMissing fun _timeoutAt() = timeoutAt
/**
* A constant representing the object's type. For this resource it will always be
* `real_time_decision`.
*/
@JsonProperty("type") @ExcludeMissing fun _type() = type
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): RealTimeDecision = apply {
if (!validated) {
cardAuthentication()?.validate()
cardAuthenticationChallenge()?.validate()
cardAuthorization()?.validate()
category()
createdAt()
digitalWalletAuthentication()?.validate()
digitalWalletToken()?.validate()
id()
status()
timeoutAt()
type()
validated = true
}
}
fun toBuilder() = Builder().from(this)
companion object {
fun builder() = Builder()
}
class Builder {
private var cardAuthentication: JsonField = JsonMissing.of()
private var cardAuthenticationChallenge: JsonField =
JsonMissing.of()
private var cardAuthorization: JsonField = JsonMissing.of()
private var category: JsonField = JsonMissing.of()
private var createdAt: JsonField = JsonMissing.of()
private var digitalWalletAuthentication: JsonField =
JsonMissing.of()
private var digitalWalletToken: JsonField = JsonMissing.of()
private var id: JsonField = JsonMissing.of()
private var status: JsonField = JsonMissing.of()
private var timeoutAt: JsonField = JsonMissing.of()
private var type: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(realTimeDecision: RealTimeDecision) = apply {
this.cardAuthentication = realTimeDecision.cardAuthentication
this.cardAuthenticationChallenge = realTimeDecision.cardAuthenticationChallenge
this.cardAuthorization = realTimeDecision.cardAuthorization
this.category = realTimeDecision.category
this.createdAt = realTimeDecision.createdAt
this.digitalWalletAuthentication = realTimeDecision.digitalWalletAuthentication
this.digitalWalletToken = realTimeDecision.digitalWalletToken
this.id = realTimeDecision.id
this.status = realTimeDecision.status
this.timeoutAt = realTimeDecision.timeoutAt
this.type = realTimeDecision.type
additionalProperties(realTimeDecision.additionalProperties)
}
/** Fields related to a 3DS authentication attempt. */
fun cardAuthentication(cardAuthentication: CardAuthentication) =
cardAuthentication(JsonField.of(cardAuthentication))
/** Fields related to a 3DS authentication attempt. */
@JsonProperty("card_authentication")
@ExcludeMissing
fun cardAuthentication(cardAuthentication: JsonField) = apply {
this.cardAuthentication = cardAuthentication
}
/** Fields related to a 3DS authentication attempt. */
fun cardAuthenticationChallenge(cardAuthenticationChallenge: CardAuthenticationChallenge) =
cardAuthenticationChallenge(JsonField.of(cardAuthenticationChallenge))
/** Fields related to a 3DS authentication attempt. */
@JsonProperty("card_authentication_challenge")
@ExcludeMissing
fun cardAuthenticationChallenge(
cardAuthenticationChallenge: JsonField
) = apply { this.cardAuthenticationChallenge = cardAuthenticationChallenge }
/** Fields related to a card authorization. */
fun cardAuthorization(cardAuthorization: CardAuthorization) =
cardAuthorization(JsonField.of(cardAuthorization))
/** Fields related to a card authorization. */
@JsonProperty("card_authorization")
@ExcludeMissing
fun cardAuthorization(cardAuthorization: JsonField) = apply {
this.cardAuthorization = cardAuthorization
}
/** The category of the Real-Time Decision. */
fun category(category: Category) = category(JsonField.of(category))
/** The category of the Real-Time Decision. */
@JsonProperty("category")
@ExcludeMissing
fun category(category: JsonField) = apply { this.category = category }
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the
* Real-Time Decision was created.
*/
fun createdAt(createdAt: OffsetDateTime) = createdAt(JsonField.of(createdAt))
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the
* Real-Time Decision was created.
*/
@JsonProperty("created_at")
@ExcludeMissing
fun createdAt(createdAt: JsonField) = apply { this.createdAt = createdAt }
/** Fields related to a digital wallet authentication attempt. */
fun digitalWalletAuthentication(digitalWalletAuthentication: DigitalWalletAuthentication) =
digitalWalletAuthentication(JsonField.of(digitalWalletAuthentication))
/** Fields related to a digital wallet authentication attempt. */
@JsonProperty("digital_wallet_authentication")
@ExcludeMissing
fun digitalWalletAuthentication(
digitalWalletAuthentication: JsonField
) = apply { this.digitalWalletAuthentication = digitalWalletAuthentication }
/** Fields related to a digital wallet token provisioning attempt. */
fun digitalWalletToken(digitalWalletToken: DigitalWalletToken) =
digitalWalletToken(JsonField.of(digitalWalletToken))
/** Fields related to a digital wallet token provisioning attempt. */
@JsonProperty("digital_wallet_token")
@ExcludeMissing
fun digitalWalletToken(digitalWalletToken: JsonField) = apply {
this.digitalWalletToken = digitalWalletToken
}
/** The Real-Time Decision identifier. */
fun id(id: String) = id(JsonField.of(id))
/** The Real-Time Decision identifier. */
@JsonProperty("id") @ExcludeMissing fun id(id: JsonField) = apply { this.id = id }
/** The status of the Real-Time Decision. */
fun status(status: Status) = status(JsonField.of(status))
/** The status of the Real-Time Decision. */
@JsonProperty("status")
@ExcludeMissing
fun status(status: JsonField) = apply { this.status = status }
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which your
* application can no longer respond to the Real-Time Decision.
*/
fun timeoutAt(timeoutAt: OffsetDateTime) = timeoutAt(JsonField.of(timeoutAt))
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which your
* application can no longer respond to the Real-Time Decision.
*/
@JsonProperty("timeout_at")
@ExcludeMissing
fun timeoutAt(timeoutAt: JsonField) = apply { this.timeoutAt = timeoutAt }
/**
* A constant representing the object's type. For this resource it will always be
* `real_time_decision`.
*/
fun type(type: Type) = type(JsonField.of(type))
/**
* A constant representing the object's type. For this resource it will always be
* `real_time_decision`.
*/
@JsonProperty("type")
@ExcludeMissing
fun type(type: JsonField) = apply { this.type = type }
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(): RealTimeDecision =
RealTimeDecision(
cardAuthentication,
cardAuthenticationChallenge,
cardAuthorization,
category,
createdAt,
digitalWalletAuthentication,
digitalWalletToken,
id,
status,
timeoutAt,
type,
additionalProperties.toImmutable(),
)
}
/** Fields related to a 3DS authentication attempt. */
@JsonDeserialize(builder = CardAuthentication.Builder::class)
@NoAutoDetect
class CardAuthentication
private constructor(
private val accountId: JsonField,
private val cardId: JsonField,
private val decision: JsonField,
private val upcomingCardPaymentId: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
/** The identifier of the Account the card belongs to. */
fun accountId(): String = accountId.getRequired("account_id")
/** The identifier of the Card that is being tokenized. */
fun cardId(): String = cardId.getRequired("card_id")
/** Whether or not the authentication attempt was approved. */
fun decision(): Decision? = decision.getNullable("decision")
/**
* The identifier of the Card Payment this authentication attempt will belong to. Available
* in the API once the card authentication has completed.
*/
fun upcomingCardPaymentId(): String =
upcomingCardPaymentId.getRequired("upcoming_card_payment_id")
/** The identifier of the Account the card belongs to. */
@JsonProperty("account_id") @ExcludeMissing fun _accountId() = accountId
/** The identifier of the Card that is being tokenized. */
@JsonProperty("card_id") @ExcludeMissing fun _cardId() = cardId
/** Whether or not the authentication attempt was approved. */
@JsonProperty("decision") @ExcludeMissing fun _decision() = decision
/**
* The identifier of the Card Payment this authentication attempt will belong to. Available
* in the API once the card authentication has completed.
*/
@JsonProperty("upcoming_card_payment_id")
@ExcludeMissing
fun _upcomingCardPaymentId() = upcomingCardPaymentId
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): CardAuthentication = apply {
if (!validated) {
accountId()
cardId()
decision()
upcomingCardPaymentId()
validated = true
}
}
fun toBuilder() = Builder().from(this)
companion object {
fun builder() = Builder()
}
class Builder {
private var accountId: JsonField = JsonMissing.of()
private var cardId: JsonField = JsonMissing.of()
private var decision: JsonField = JsonMissing.of()
private var upcomingCardPaymentId: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(cardAuthentication: CardAuthentication) = apply {
this.accountId = cardAuthentication.accountId
this.cardId = cardAuthentication.cardId
this.decision = cardAuthentication.decision
this.upcomingCardPaymentId = cardAuthentication.upcomingCardPaymentId
additionalProperties(cardAuthentication.additionalProperties)
}
/** The identifier of the Account the card belongs to. */
fun accountId(accountId: String) = accountId(JsonField.of(accountId))
/** The identifier of the Account the card belongs to. */
@JsonProperty("account_id")
@ExcludeMissing
fun accountId(accountId: JsonField) = apply { this.accountId = accountId }
/** The identifier of the Card that is being tokenized. */
fun cardId(cardId: String) = cardId(JsonField.of(cardId))
/** The identifier of the Card that is being tokenized. */
@JsonProperty("card_id")
@ExcludeMissing
fun cardId(cardId: JsonField) = apply { this.cardId = cardId }
/** Whether or not the authentication attempt was approved. */
fun decision(decision: Decision) = decision(JsonField.of(decision))
/** Whether or not the authentication attempt was approved. */
@JsonProperty("decision")
@ExcludeMissing
fun decision(decision: JsonField) = apply { this.decision = decision }
/**
* The identifier of the Card Payment this authentication attempt will belong to.
* Available in the API once the card authentication has completed.
*/
fun upcomingCardPaymentId(upcomingCardPaymentId: String) =
upcomingCardPaymentId(JsonField.of(upcomingCardPaymentId))
/**
* The identifier of the Card Payment this authentication attempt will belong to.
* Available in the API once the card authentication has completed.
*/
@JsonProperty("upcoming_card_payment_id")
@ExcludeMissing
fun upcomingCardPaymentId(upcomingCardPaymentId: JsonField) = apply {
this.upcomingCardPaymentId = upcomingCardPaymentId
}
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(): CardAuthentication =
CardAuthentication(
accountId,
cardId,
decision,
upcomingCardPaymentId,
additionalProperties.toImmutable(),
)
}
class Decision
@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 /* spotless:off */ other is Decision && this.value == other.value /* spotless:on */
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
val APPROVE = Decision(JsonField.of("approve"))
val CHALLENGE = Decision(JsonField.of("challenge"))
val DENY = Decision(JsonField.of("deny"))
fun of(value: String) = Decision(JsonField.of(value))
}
enum class Known {
APPROVE,
CHALLENGE,
DENY,
}
enum class Value {
APPROVE,
CHALLENGE,
DENY,
_UNKNOWN,
}
fun value(): Value =
when (this) {
APPROVE -> Value.APPROVE
CHALLENGE -> Value.CHALLENGE
DENY -> Value.DENY
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
APPROVE -> Known.APPROVE
CHALLENGE -> Known.CHALLENGE
DENY -> Known.DENY
else -> throw IncreaseInvalidDataException("Unknown Decision: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return /* spotless:off */ other is CardAuthentication && this.accountId == other.accountId && this.cardId == other.cardId && this.decision == other.decision && this.upcomingCardPaymentId == other.upcomingCardPaymentId && this.additionalProperties == other.additionalProperties /* spotless:on */
}
private var hashCode: Int = 0
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode = /* spotless:off */ Objects.hash(accountId, cardId, decision, upcomingCardPaymentId, additionalProperties) /* spotless:on */
}
return hashCode
}
override fun toString() =
"CardAuthentication{accountId=$accountId, cardId=$cardId, decision=$decision, upcomingCardPaymentId=$upcomingCardPaymentId, additionalProperties=$additionalProperties}"
}
/** Fields related to a 3DS authentication attempt. */
@JsonDeserialize(builder = CardAuthenticationChallenge.Builder::class)
@NoAutoDetect
class CardAuthenticationChallenge
private constructor(
private val accountId: JsonField,
private val cardId: JsonField,
private val cardPaymentId: JsonField,
private val oneTimeCode: JsonField,
private val result: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
/** The identifier of the Account the card belongs to. */
fun accountId(): String = accountId.getRequired("account_id")
/** The identifier of the Card that is being tokenized. */
fun cardId(): String = cardId.getRequired("card_id")
/** The identifier of the Card Payment this authentication challenge attempt belongs to. */
fun cardPaymentId(): String = cardPaymentId.getRequired("card_payment_id")
/** The one-time code delivered to the cardholder. */
fun oneTimeCode(): String = oneTimeCode.getRequired("one_time_code")
/** Whether or not the challenge was delivered to the cardholder. */
fun result(): Result? = result.getNullable("result")
/** The identifier of the Account the card belongs to. */
@JsonProperty("account_id") @ExcludeMissing fun _accountId() = accountId
/** The identifier of the Card that is being tokenized. */
@JsonProperty("card_id") @ExcludeMissing fun _cardId() = cardId
/** The identifier of the Card Payment this authentication challenge attempt belongs to. */
@JsonProperty("card_payment_id") @ExcludeMissing fun _cardPaymentId() = cardPaymentId
/** The one-time code delivered to the cardholder. */
@JsonProperty("one_time_code") @ExcludeMissing fun _oneTimeCode() = oneTimeCode
/** Whether or not the challenge was delivered to the cardholder. */
@JsonProperty("result") @ExcludeMissing fun _result() = result
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): CardAuthenticationChallenge = apply {
if (!validated) {
accountId()
cardId()
cardPaymentId()
oneTimeCode()
result()
validated = true
}
}
fun toBuilder() = Builder().from(this)
companion object {
fun builder() = Builder()
}
class Builder {
private var accountId: JsonField = JsonMissing.of()
private var cardId: JsonField = JsonMissing.of()
private var cardPaymentId: JsonField = JsonMissing.of()
private var oneTimeCode: JsonField = JsonMissing.of()
private var result: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(cardAuthenticationChallenge: CardAuthenticationChallenge) = apply {
this.accountId = cardAuthenticationChallenge.accountId
this.cardId = cardAuthenticationChallenge.cardId
this.cardPaymentId = cardAuthenticationChallenge.cardPaymentId
this.oneTimeCode = cardAuthenticationChallenge.oneTimeCode
this.result = cardAuthenticationChallenge.result
additionalProperties(cardAuthenticationChallenge.additionalProperties)
}
/** The identifier of the Account the card belongs to. */
fun accountId(accountId: String) = accountId(JsonField.of(accountId))
/** The identifier of the Account the card belongs to. */
@JsonProperty("account_id")
@ExcludeMissing
fun accountId(accountId: JsonField) = apply { this.accountId = accountId }
/** The identifier of the Card that is being tokenized. */
fun cardId(cardId: String) = cardId(JsonField.of(cardId))
/** The identifier of the Card that is being tokenized. */
@JsonProperty("card_id")
@ExcludeMissing
fun cardId(cardId: JsonField) = apply { this.cardId = cardId }
/**
* The identifier of the Card Payment this authentication challenge attempt belongs to.
*/
fun cardPaymentId(cardPaymentId: String) = cardPaymentId(JsonField.of(cardPaymentId))
/**
* The identifier of the Card Payment this authentication challenge attempt belongs to.
*/
@JsonProperty("card_payment_id")
@ExcludeMissing
fun cardPaymentId(cardPaymentId: JsonField) = apply {
this.cardPaymentId = cardPaymentId
}
/** The one-time code delivered to the cardholder. */
fun oneTimeCode(oneTimeCode: String) = oneTimeCode(JsonField.of(oneTimeCode))
/** The one-time code delivered to the cardholder. */
@JsonProperty("one_time_code")
@ExcludeMissing
fun oneTimeCode(oneTimeCode: JsonField) = apply {
this.oneTimeCode = oneTimeCode
}
/** Whether or not the challenge was delivered to the cardholder. */
fun result(result: Result) = result(JsonField.of(result))
/** Whether or not the challenge was delivered to the cardholder. */
@JsonProperty("result")
@ExcludeMissing
fun result(result: JsonField) = apply { this.result = result }
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(): CardAuthenticationChallenge =
CardAuthenticationChallenge(
accountId,
cardId,
cardPaymentId,
oneTimeCode,
result,
additionalProperties.toImmutable(),
)
}
class Result
@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 /* spotless:off */ other is Result && this.value == other.value /* spotless:on */
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
val SUCCESS = Result(JsonField.of("success"))
val FAILURE = Result(JsonField.of("failure"))
fun of(value: String) = Result(JsonField.of(value))
}
enum class Known {
SUCCESS,
FAILURE,
}
enum class Value {
SUCCESS,
FAILURE,
_UNKNOWN,
}
fun value(): Value =
when (this) {
SUCCESS -> Value.SUCCESS
FAILURE -> Value.FAILURE
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
SUCCESS -> Known.SUCCESS
FAILURE -> Known.FAILURE
else -> throw IncreaseInvalidDataException("Unknown Result: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return /* spotless:off */ other is CardAuthenticationChallenge && this.accountId == other.accountId && this.cardId == other.cardId && this.cardPaymentId == other.cardPaymentId && this.oneTimeCode == other.oneTimeCode && this.result == other.result && this.additionalProperties == other.additionalProperties /* spotless:on */
}
private var hashCode: Int = 0
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode = /* spotless:off */ Objects.hash(accountId, cardId, cardPaymentId, oneTimeCode, result, additionalProperties) /* spotless:on */
}
return hashCode
}
override fun toString() =
"CardAuthenticationChallenge{accountId=$accountId, cardId=$cardId, cardPaymentId=$cardPaymentId, oneTimeCode=$oneTimeCode, result=$result, additionalProperties=$additionalProperties}"
}
/** Fields related to a card authorization. */
@JsonDeserialize(builder = CardAuthorization.Builder::class)
@NoAutoDetect
class CardAuthorization
private constructor(
private val accountId: JsonField,
private val cardId: JsonField,
private val decision: JsonField,
private val digitalWalletTokenId: JsonField,
private val direction: JsonField,
private val merchantAcceptorId: JsonField,
private val merchantCategoryCode: JsonField,
private val merchantCity: JsonField,
private val merchantCountry: JsonField,
private val merchantDescriptor: JsonField,
private val merchantPostalCode: JsonField,
private val merchantState: JsonField,
private val networkDetails: JsonField,
private val networkIdentifiers: JsonField,
private val networkRiskScore: JsonField,
private val physicalCardId: JsonField,
private val presentmentAmount: JsonField,
private val presentmentCurrency: JsonField,
private val processingCategory: JsonField,
private val requestDetails: JsonField,
private val settlementAmount: JsonField,
private val settlementCurrency: JsonField,
private val terminalId: JsonField,
private val upcomingCardPaymentId: JsonField,
private val verification: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
/** The identifier of the Account the authorization will debit. */
fun accountId(): String = accountId.getRequired("account_id")
/** The identifier of the Card that is being authorized. */
fun cardId(): String = cardId.getRequired("card_id")
/** Whether or not the authorization was approved. */
fun decision(): Decision? = decision.getNullable("decision")
/**
* If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase),
* the identifier of the token that was used.
*/
fun digitalWalletTokenId(): String? =
digitalWalletTokenId.getNullable("digital_wallet_token_id")
/**
* The direction describes the direction the funds will move, either from the cardholder to
* the merchant or from the merchant to the cardholder.
*/
fun direction(): Direction = direction.getRequired("direction")
/**
* The merchant identifier (commonly abbreviated as MID) of the merchant the card is
* transacting with.
*/
fun merchantAcceptorId(): String = merchantAcceptorId.getRequired("merchant_acceptor_id")
/**
* The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is
* transacting with.
*/
fun merchantCategoryCode(): String =
merchantCategoryCode.getRequired("merchant_category_code")
/** The city the merchant resides in. */
fun merchantCity(): String? = merchantCity.getNullable("merchant_city")
/** The country the merchant resides in. */
fun merchantCountry(): String = merchantCountry.getRequired("merchant_country")
/** The merchant descriptor of the merchant the card is transacting with. */
fun merchantDescriptor(): String = merchantDescriptor.getRequired("merchant_descriptor")
/**
* The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP
* code, where the first 5 and last 4 are separated by a dash.
*/
fun merchantPostalCode(): String? = merchantPostalCode.getNullable("merchant_postal_code")
/** The state the merchant resides in. */
fun merchantState(): String? = merchantState.getNullable("merchant_state")
/** Fields specific to the `network`. */
fun networkDetails(): NetworkDetails = networkDetails.getRequired("network_details")
/** Network-specific identifiers for a specific request or transaction. */
fun networkIdentifiers(): NetworkIdentifiers =
networkIdentifiers.getRequired("network_identifiers")
/**
* The risk score generated by the card network. For Visa this is the Visa Advanced
* Authorization risk score, from 0 to 99, where 99 is the riskiest.
*/
fun networkRiskScore(): Long? = networkRiskScore.getNullable("network_risk_score")
/**
* If the authorization was made in-person with a physical card, the Physical Card that was
* used.
*/
fun physicalCardId(): String? = physicalCardId.getNullable("physical_card_id")
/**
* The amount of the attempted authorization in the currency the card user sees at the time
* of purchase, in the minor unit of that currency. For dollars, for example, this is cents.
*/
fun presentmentAmount(): Long = presentmentAmount.getRequired("presentment_amount")
/**
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the user
* sees at the time of purchase.
*/
fun presentmentCurrency(): String = presentmentCurrency.getRequired("presentment_currency")
/**
* The processing category describes the intent behind the authorization, such as whether it
* was used for bill payments or an automatic fuel dispenser.
*/
fun processingCategory(): ProcessingCategory =
processingCategory.getRequired("processing_category")
/** Fields specific to the type of request, such as an incremental authorization. */
fun requestDetails(): RequestDetails = requestDetails.getRequired("request_details")
/**
* The amount of the attempted authorization in the currency it will be settled in. This
* currency is the same as that of the Account the card belongs to.
*/
fun settlementAmount(): Long = settlementAmount.getRequired("settlement_amount")
/**
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the
* transaction will be settled in.
*/
fun settlementCurrency(): String = settlementCurrency.getRequired("settlement_currency")
/**
* The terminal identifier (commonly abbreviated as TID) of the terminal the card is
* transacting with.
*/
fun terminalId(): String? = terminalId.getNullable("terminal_id")
/**
* The identifier of the Card Payment this authorization will belong to. Available in the
* API once the card authorization has completed.
*/
fun upcomingCardPaymentId(): String =
upcomingCardPaymentId.getRequired("upcoming_card_payment_id")
/** Fields related to verification of cardholder-provided values. */
fun verification(): Verification = verification.getRequired("verification")
/** The identifier of the Account the authorization will debit. */
@JsonProperty("account_id") @ExcludeMissing fun _accountId() = accountId
/** The identifier of the Card that is being authorized. */
@JsonProperty("card_id") @ExcludeMissing fun _cardId() = cardId
/** Whether or not the authorization was approved. */
@JsonProperty("decision") @ExcludeMissing fun _decision() = decision
/**
* If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase),
* the identifier of the token that was used.
*/
@JsonProperty("digital_wallet_token_id")
@ExcludeMissing
fun _digitalWalletTokenId() = digitalWalletTokenId
/**
* The direction describes the direction the funds will move, either from the cardholder to
* the merchant or from the merchant to the cardholder.
*/
@JsonProperty("direction") @ExcludeMissing fun _direction() = direction
/**
* The merchant identifier (commonly abbreviated as MID) of the merchant the card is
* transacting with.
*/
@JsonProperty("merchant_acceptor_id")
@ExcludeMissing
fun _merchantAcceptorId() = merchantAcceptorId
/**
* The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is
* transacting with.
*/
@JsonProperty("merchant_category_code")
@ExcludeMissing
fun _merchantCategoryCode() = merchantCategoryCode
/** The city the merchant resides in. */
@JsonProperty("merchant_city") @ExcludeMissing fun _merchantCity() = merchantCity
/** The country the merchant resides in. */
@JsonProperty("merchant_country") @ExcludeMissing fun _merchantCountry() = merchantCountry
/** The merchant descriptor of the merchant the card is transacting with. */
@JsonProperty("merchant_descriptor")
@ExcludeMissing
fun _merchantDescriptor() = merchantDescriptor
/**
* The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP
* code, where the first 5 and last 4 are separated by a dash.
*/
@JsonProperty("merchant_postal_code")
@ExcludeMissing
fun _merchantPostalCode() = merchantPostalCode
/** The state the merchant resides in. */
@JsonProperty("merchant_state") @ExcludeMissing fun _merchantState() = merchantState
/** Fields specific to the `network`. */
@JsonProperty("network_details") @ExcludeMissing fun _networkDetails() = networkDetails
/** Network-specific identifiers for a specific request or transaction. */
@JsonProperty("network_identifiers")
@ExcludeMissing
fun _networkIdentifiers() = networkIdentifiers
/**
* The risk score generated by the card network. For Visa this is the Visa Advanced
* Authorization risk score, from 0 to 99, where 99 is the riskiest.
*/
@JsonProperty("network_risk_score")
@ExcludeMissing
fun _networkRiskScore() = networkRiskScore
/**
* If the authorization was made in-person with a physical card, the Physical Card that was
* used.
*/
@JsonProperty("physical_card_id") @ExcludeMissing fun _physicalCardId() = physicalCardId
/**
* The amount of the attempted authorization in the currency the card user sees at the time
* of purchase, in the minor unit of that currency. For dollars, for example, this is cents.
*/
@JsonProperty("presentment_amount")
@ExcludeMissing
fun _presentmentAmount() = presentmentAmount
/**
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the user
* sees at the time of purchase.
*/
@JsonProperty("presentment_currency")
@ExcludeMissing
fun _presentmentCurrency() = presentmentCurrency
/**
* The processing category describes the intent behind the authorization, such as whether it
* was used for bill payments or an automatic fuel dispenser.
*/
@JsonProperty("processing_category")
@ExcludeMissing
fun _processingCategory() = processingCategory
/** Fields specific to the type of request, such as an incremental authorization. */
@JsonProperty("request_details") @ExcludeMissing fun _requestDetails() = requestDetails
/**
* The amount of the attempted authorization in the currency it will be settled in. This
* currency is the same as that of the Account the card belongs to.
*/
@JsonProperty("settlement_amount")
@ExcludeMissing
fun _settlementAmount() = settlementAmount
/**
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the
* transaction will be settled in.
*/
@JsonProperty("settlement_currency")
@ExcludeMissing
fun _settlementCurrency() = settlementCurrency
/**
* The terminal identifier (commonly abbreviated as TID) of the terminal the card is
* transacting with.
*/
@JsonProperty("terminal_id") @ExcludeMissing fun _terminalId() = terminalId
/**
* The identifier of the Card Payment this authorization will belong to. Available in the
* API once the card authorization has completed.
*/
@JsonProperty("upcoming_card_payment_id")
@ExcludeMissing
fun _upcomingCardPaymentId() = upcomingCardPaymentId
/** Fields related to verification of cardholder-provided values. */
@JsonProperty("verification") @ExcludeMissing fun _verification() = verification
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): CardAuthorization = apply {
if (!validated) {
accountId()
cardId()
decision()
digitalWalletTokenId()
direction()
merchantAcceptorId()
merchantCategoryCode()
merchantCity()
merchantCountry()
merchantDescriptor()
merchantPostalCode()
merchantState()
networkDetails().validate()
networkIdentifiers().validate()
networkRiskScore()
physicalCardId()
presentmentAmount()
presentmentCurrency()
processingCategory()
requestDetails().validate()
settlementAmount()
settlementCurrency()
terminalId()
upcomingCardPaymentId()
verification().validate()
validated = true
}
}
fun toBuilder() = Builder().from(this)
companion object {
fun builder() = Builder()
}
class Builder {
private var accountId: JsonField = JsonMissing.of()
private var cardId: JsonField = JsonMissing.of()
private var decision: JsonField = JsonMissing.of()
private var digitalWalletTokenId: JsonField = JsonMissing.of()
private var direction: JsonField = JsonMissing.of()
private var merchantAcceptorId: JsonField = JsonMissing.of()
private var merchantCategoryCode: JsonField = JsonMissing.of()
private var merchantCity: JsonField = JsonMissing.of()
private var merchantCountry: JsonField = JsonMissing.of()
private var merchantDescriptor: JsonField = JsonMissing.of()
private var merchantPostalCode: JsonField = JsonMissing.of()
private var merchantState: JsonField = JsonMissing.of()
private var networkDetails: JsonField = JsonMissing.of()
private var networkIdentifiers: JsonField = JsonMissing.of()
private var networkRiskScore: JsonField = JsonMissing.of()
private var physicalCardId: JsonField = JsonMissing.of()
private var presentmentAmount: JsonField = JsonMissing.of()
private var presentmentCurrency: JsonField = JsonMissing.of()
private var processingCategory: JsonField = JsonMissing.of()
private var requestDetails: JsonField = JsonMissing.of()
private var settlementAmount: JsonField = JsonMissing.of()
private var settlementCurrency: JsonField = JsonMissing.of()
private var terminalId: JsonField = JsonMissing.of()
private var upcomingCardPaymentId: JsonField = JsonMissing.of()
private var verification: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(cardAuthorization: CardAuthorization) = apply {
this.accountId = cardAuthorization.accountId
this.cardId = cardAuthorization.cardId
this.decision = cardAuthorization.decision
this.digitalWalletTokenId = cardAuthorization.digitalWalletTokenId
this.direction = cardAuthorization.direction
this.merchantAcceptorId = cardAuthorization.merchantAcceptorId
this.merchantCategoryCode = cardAuthorization.merchantCategoryCode
this.merchantCity = cardAuthorization.merchantCity
this.merchantCountry = cardAuthorization.merchantCountry
this.merchantDescriptor = cardAuthorization.merchantDescriptor
this.merchantPostalCode = cardAuthorization.merchantPostalCode
this.merchantState = cardAuthorization.merchantState
this.networkDetails = cardAuthorization.networkDetails
this.networkIdentifiers = cardAuthorization.networkIdentifiers
this.networkRiskScore = cardAuthorization.networkRiskScore
this.physicalCardId = cardAuthorization.physicalCardId
this.presentmentAmount = cardAuthorization.presentmentAmount
this.presentmentCurrency = cardAuthorization.presentmentCurrency
this.processingCategory = cardAuthorization.processingCategory
this.requestDetails = cardAuthorization.requestDetails
this.settlementAmount = cardAuthorization.settlementAmount
this.settlementCurrency = cardAuthorization.settlementCurrency
this.terminalId = cardAuthorization.terminalId
this.upcomingCardPaymentId = cardAuthorization.upcomingCardPaymentId
this.verification = cardAuthorization.verification
additionalProperties(cardAuthorization.additionalProperties)
}
/** The identifier of the Account the authorization will debit. */
fun accountId(accountId: String) = accountId(JsonField.of(accountId))
/** The identifier of the Account the authorization will debit. */
@JsonProperty("account_id")
@ExcludeMissing
fun accountId(accountId: JsonField) = apply { this.accountId = accountId }
/** The identifier of the Card that is being authorized. */
fun cardId(cardId: String) = cardId(JsonField.of(cardId))
/** The identifier of the Card that is being authorized. */
@JsonProperty("card_id")
@ExcludeMissing
fun cardId(cardId: JsonField) = apply { this.cardId = cardId }
/** Whether or not the authorization was approved. */
fun decision(decision: Decision) = decision(JsonField.of(decision))
/** Whether or not the authorization was approved. */
@JsonProperty("decision")
@ExcludeMissing
fun decision(decision: JsonField) = apply { this.decision = decision }
/**
* If the authorization was made via a Digital Wallet Token (such as an Apple Pay
* purchase), the identifier of the token that was used.
*/
fun digitalWalletTokenId(digitalWalletTokenId: String) =
digitalWalletTokenId(JsonField.of(digitalWalletTokenId))
/**
* If the authorization was made via a Digital Wallet Token (such as an Apple Pay
* purchase), the identifier of the token that was used.
*/
@JsonProperty("digital_wallet_token_id")
@ExcludeMissing
fun digitalWalletTokenId(digitalWalletTokenId: JsonField) = apply {
this.digitalWalletTokenId = digitalWalletTokenId
}
/**
* The direction describes the direction the funds will move, either from the cardholder
* to the merchant or from the merchant to the cardholder.
*/
fun direction(direction: Direction) = direction(JsonField.of(direction))
/**
* The direction describes the direction the funds will move, either from the cardholder
* to the merchant or from the merchant to the cardholder.
*/
@JsonProperty("direction")
@ExcludeMissing
fun direction(direction: JsonField) = apply { this.direction = direction }
/**
* The merchant identifier (commonly abbreviated as MID) of the merchant the card is
* transacting with.
*/
fun merchantAcceptorId(merchantAcceptorId: String) =
merchantAcceptorId(JsonField.of(merchantAcceptorId))
/**
* The merchant identifier (commonly abbreviated as MID) of the merchant the card is
* transacting with.
*/
@JsonProperty("merchant_acceptor_id")
@ExcludeMissing
fun merchantAcceptorId(merchantAcceptorId: JsonField) = apply {
this.merchantAcceptorId = merchantAcceptorId
}
/**
* The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is
* transacting with.
*/
fun merchantCategoryCode(merchantCategoryCode: String) =
merchantCategoryCode(JsonField.of(merchantCategoryCode))
/**
* The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is
* transacting with.
*/
@JsonProperty("merchant_category_code")
@ExcludeMissing
fun merchantCategoryCode(merchantCategoryCode: JsonField) = apply {
this.merchantCategoryCode = merchantCategoryCode
}
/** The city the merchant resides in. */
fun merchantCity(merchantCity: String) = merchantCity(JsonField.of(merchantCity))
/** The city the merchant resides in. */
@JsonProperty("merchant_city")
@ExcludeMissing
fun merchantCity(merchantCity: JsonField) = apply {
this.merchantCity = merchantCity
}
/** The country the merchant resides in. */
fun merchantCountry(merchantCountry: String) =
merchantCountry(JsonField.of(merchantCountry))
/** The country the merchant resides in. */
@JsonProperty("merchant_country")
@ExcludeMissing
fun merchantCountry(merchantCountry: JsonField) = apply {
this.merchantCountry = merchantCountry
}
/** The merchant descriptor of the merchant the card is transacting with. */
fun merchantDescriptor(merchantDescriptor: String) =
merchantDescriptor(JsonField.of(merchantDescriptor))
/** The merchant descriptor of the merchant the card is transacting with. */
@JsonProperty("merchant_descriptor")
@ExcludeMissing
fun merchantDescriptor(merchantDescriptor: JsonField) = apply {
this.merchantDescriptor = merchantDescriptor
}
/**
* The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP
* code, where the first 5 and last 4 are separated by a dash.
*/
fun merchantPostalCode(merchantPostalCode: String) =
merchantPostalCode(JsonField.of(merchantPostalCode))
/**
* The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP
* code, where the first 5 and last 4 are separated by a dash.
*/
@JsonProperty("merchant_postal_code")
@ExcludeMissing
fun merchantPostalCode(merchantPostalCode: JsonField) = apply {
this.merchantPostalCode = merchantPostalCode
}
/** The state the merchant resides in. */
fun merchantState(merchantState: String) = merchantState(JsonField.of(merchantState))
/** The state the merchant resides in. */
@JsonProperty("merchant_state")
@ExcludeMissing
fun merchantState(merchantState: JsonField) = apply {
this.merchantState = merchantState
}
/** Fields specific to the `network`. */
fun networkDetails(networkDetails: NetworkDetails) =
networkDetails(JsonField.of(networkDetails))
/** Fields specific to the `network`. */
@JsonProperty("network_details")
@ExcludeMissing
fun networkDetails(networkDetails: JsonField) = apply {
this.networkDetails = networkDetails
}
/** Network-specific identifiers for a specific request or transaction. */
fun networkIdentifiers(networkIdentifiers: NetworkIdentifiers) =
networkIdentifiers(JsonField.of(networkIdentifiers))
/** Network-specific identifiers for a specific request or transaction. */
@JsonProperty("network_identifiers")
@ExcludeMissing
fun networkIdentifiers(networkIdentifiers: JsonField) = apply {
this.networkIdentifiers = networkIdentifiers
}
/**
* The risk score generated by the card network. For Visa this is the Visa Advanced
* Authorization risk score, from 0 to 99, where 99 is the riskiest.
*/
fun networkRiskScore(networkRiskScore: Long) =
networkRiskScore(JsonField.of(networkRiskScore))
/**
* The risk score generated by the card network. For Visa this is the Visa Advanced
* Authorization risk score, from 0 to 99, where 99 is the riskiest.
*/
@JsonProperty("network_risk_score")
@ExcludeMissing
fun networkRiskScore(networkRiskScore: JsonField) = apply {
this.networkRiskScore = networkRiskScore
}
/**
* If the authorization was made in-person with a physical card, the Physical Card that
* was used.
*/
fun physicalCardId(physicalCardId: String) =
physicalCardId(JsonField.of(physicalCardId))
/**
* If the authorization was made in-person with a physical card, the Physical Card that
* was used.
*/
@JsonProperty("physical_card_id")
@ExcludeMissing
fun physicalCardId(physicalCardId: JsonField) = apply {
this.physicalCardId = physicalCardId
}
/**
* The amount of the attempted authorization in the currency the card user sees at the
* time of purchase, in the minor unit of that currency. For dollars, for example, this
* is cents.
*/
fun presentmentAmount(presentmentAmount: Long) =
presentmentAmount(JsonField.of(presentmentAmount))
/**
* The amount of the attempted authorization in the currency the card user sees at the
* time of purchase, in the minor unit of that currency. For dollars, for example, this
* is cents.
*/
@JsonProperty("presentment_amount")
@ExcludeMissing
fun presentmentAmount(presentmentAmount: JsonField) = apply {
this.presentmentAmount = presentmentAmount
}
/**
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the user
* sees at the time of purchase.
*/
fun presentmentCurrency(presentmentCurrency: String) =
presentmentCurrency(JsonField.of(presentmentCurrency))
/**
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the user
* sees at the time of purchase.
*/
@JsonProperty("presentment_currency")
@ExcludeMissing
fun presentmentCurrency(presentmentCurrency: JsonField) = apply {
this.presentmentCurrency = presentmentCurrency
}
/**
* The processing category describes the intent behind the authorization, such as
* whether it was used for bill payments or an automatic fuel dispenser.
*/
fun processingCategory(processingCategory: ProcessingCategory) =
processingCategory(JsonField.of(processingCategory))
/**
* The processing category describes the intent behind the authorization, such as
* whether it was used for bill payments or an automatic fuel dispenser.
*/
@JsonProperty("processing_category")
@ExcludeMissing
fun processingCategory(processingCategory: JsonField) = apply {
this.processingCategory = processingCategory
}
/** Fields specific to the type of request, such as an incremental authorization. */
fun requestDetails(requestDetails: RequestDetails) =
requestDetails(JsonField.of(requestDetails))
/** Fields specific to the type of request, such as an incremental authorization. */
@JsonProperty("request_details")
@ExcludeMissing
fun requestDetails(requestDetails: JsonField) = apply {
this.requestDetails = requestDetails
}
/**
* The amount of the attempted authorization in the currency it will be settled in. This
* currency is the same as that of the Account the card belongs to.
*/
fun settlementAmount(settlementAmount: Long) =
settlementAmount(JsonField.of(settlementAmount))
/**
* The amount of the attempted authorization in the currency it will be settled in. This
* currency is the same as that of the Account the card belongs to.
*/
@JsonProperty("settlement_amount")
@ExcludeMissing
fun settlementAmount(settlementAmount: JsonField) = apply {
this.settlementAmount = settlementAmount
}
/**
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the
* transaction will be settled in.
*/
fun settlementCurrency(settlementCurrency: String) =
settlementCurrency(JsonField.of(settlementCurrency))
/**
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the
* transaction will be settled in.
*/
@JsonProperty("settlement_currency")
@ExcludeMissing
fun settlementCurrency(settlementCurrency: JsonField) = apply {
this.settlementCurrency = settlementCurrency
}
/**
* The terminal identifier (commonly abbreviated as TID) of the terminal the card is
* transacting with.
*/
fun terminalId(terminalId: String) = terminalId(JsonField.of(terminalId))
/**
* The terminal identifier (commonly abbreviated as TID) of the terminal the card is
* transacting with.
*/
@JsonProperty("terminal_id")
@ExcludeMissing
fun terminalId(terminalId: JsonField) = apply { this.terminalId = terminalId }
/**
* The identifier of the Card Payment this authorization will belong to. Available in
* the API once the card authorization has completed.
*/
fun upcomingCardPaymentId(upcomingCardPaymentId: String) =
upcomingCardPaymentId(JsonField.of(upcomingCardPaymentId))
/**
* The identifier of the Card Payment this authorization will belong to. Available in
* the API once the card authorization has completed.
*/
@JsonProperty("upcoming_card_payment_id")
@ExcludeMissing
fun upcomingCardPaymentId(upcomingCardPaymentId: JsonField) = apply {
this.upcomingCardPaymentId = upcomingCardPaymentId
}
/** Fields related to verification of cardholder-provided values. */
fun verification(verification: Verification) = verification(JsonField.of(verification))
/** Fields related to verification of cardholder-provided values. */
@JsonProperty("verification")
@ExcludeMissing
fun verification(verification: JsonField) = apply {
this.verification = verification
}
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(): CardAuthorization =
CardAuthorization(
accountId,
cardId,
decision,
digitalWalletTokenId,
direction,
merchantAcceptorId,
merchantCategoryCode,
merchantCity,
merchantCountry,
merchantDescriptor,
merchantPostalCode,
merchantState,
networkDetails,
networkIdentifiers,
networkRiskScore,
physicalCardId,
presentmentAmount,
presentmentCurrency,
processingCategory,
requestDetails,
settlementAmount,
settlementCurrency,
terminalId,
upcomingCardPaymentId,
verification,
additionalProperties.toImmutable(),
)
}
class Decision
@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 /* spotless:off */ other is Decision && this.value == other.value /* spotless:on */
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
val APPROVE = Decision(JsonField.of("approve"))
val DECLINE = Decision(JsonField.of("decline"))
fun of(value: String) = Decision(JsonField.of(value))
}
enum class Known {
APPROVE,
DECLINE,
}
enum class Value {
APPROVE,
DECLINE,
_UNKNOWN,
}
fun value(): Value =
when (this) {
APPROVE -> Value.APPROVE
DECLINE -> Value.DECLINE
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
APPROVE -> Known.APPROVE
DECLINE -> Known.DECLINE
else -> throw IncreaseInvalidDataException("Unknown Decision: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
class Direction
@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 /* spotless:off */ other is Direction && this.value == other.value /* spotless:on */
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
val SETTLEMENT = Direction(JsonField.of("settlement"))
val REFUND = Direction(JsonField.of("refund"))
fun of(value: String) = Direction(JsonField.of(value))
}
enum class Known {
SETTLEMENT,
REFUND,
}
enum class Value {
SETTLEMENT,
REFUND,
_UNKNOWN,
}
fun value(): Value =
when (this) {
SETTLEMENT -> Value.SETTLEMENT
REFUND -> Value.REFUND
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
SETTLEMENT -> Known.SETTLEMENT
REFUND -> Known.REFUND
else -> throw IncreaseInvalidDataException("Unknown Direction: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
/** Fields specific to the `network`. */
@JsonDeserialize(builder = NetworkDetails.Builder::class)
@NoAutoDetect
class NetworkDetails
private constructor(
private val category: JsonField,
private val visa: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
/** The payment network used to process this card authorization. */
fun category(): Category = category.getRequired("category")
/** Fields specific to the `visa` network. */
fun visa(): Visa? = visa.getNullable("visa")
/** The payment network used to process this card authorization. */
@JsonProperty("category") @ExcludeMissing fun _category() = category
/** Fields specific to the `visa` network. */
@JsonProperty("visa") @ExcludeMissing fun _visa() = visa
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): NetworkDetails = apply {
if (!validated) {
category()
visa()?.validate()
validated = true
}
}
fun toBuilder() = Builder().from(this)
companion object {
fun builder() = Builder()
}
class Builder {
private var category: JsonField = JsonMissing.of()
private var visa: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(networkDetails: NetworkDetails) = apply {
this.category = networkDetails.category
this.visa = networkDetails.visa
additionalProperties(networkDetails.additionalProperties)
}
/** The payment network used to process this card authorization. */
fun category(category: Category) = category(JsonField.of(category))
/** The payment network used to process this card authorization. */
@JsonProperty("category")
@ExcludeMissing
fun category(category: JsonField) = apply { this.category = category }
/** Fields specific to the `visa` network. */
fun visa(visa: Visa) = visa(JsonField.of(visa))
/** Fields specific to the `visa` network. */
@JsonProperty("visa")
@ExcludeMissing
fun visa(visa: JsonField) = apply { this.visa = visa }
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(): NetworkDetails =
NetworkDetails(
category,
visa,
additionalProperties.toImmutable(),
)
}
class Category
@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 /* spotless:off */ other is Category && this.value == other.value /* spotless:on */
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
val VISA = Category(JsonField.of("visa"))
fun of(value: String) = Category(JsonField.of(value))
}
enum class Known {
VISA,
}
enum class Value {
VISA,
_UNKNOWN,
}
fun value(): Value =
when (this) {
VISA -> Value.VISA
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
VISA -> Known.VISA
else -> throw IncreaseInvalidDataException("Unknown Category: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
/** Fields specific to the `visa` network. */
@JsonDeserialize(builder = Visa.Builder::class)
@NoAutoDetect
class Visa
private constructor(
private val electronicCommerceIndicator: JsonField,
private val pointOfServiceEntryMode: JsonField,
private val standInProcessingReason: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
/**
* For electronic commerce transactions, this identifies the level of security used
* in obtaining the customer's payment credential. For mail or telephone order
* transactions, identifies the type of mail or telephone order.
*/
fun electronicCommerceIndicator(): ElectronicCommerceIndicator? =
electronicCommerceIndicator.getNullable("electronic_commerce_indicator")
/**
* The method used to enter the cardholder's primary account number and card
* expiration date.
*/
fun pointOfServiceEntryMode(): PointOfServiceEntryMode? =
pointOfServiceEntryMode.getNullable("point_of_service_entry_mode")
/**
* Only present when `actioner: network`. Describes why a card authorization was
* approved or declined by Visa through stand-in processing.
*/
fun standInProcessingReason(): StandInProcessingReason? =
standInProcessingReason.getNullable("stand_in_processing_reason")
/**
* For electronic commerce transactions, this identifies the level of security used
* in obtaining the customer's payment credential. For mail or telephone order
* transactions, identifies the type of mail or telephone order.
*/
@JsonProperty("electronic_commerce_indicator")
@ExcludeMissing
fun _electronicCommerceIndicator() = electronicCommerceIndicator
/**
* The method used to enter the cardholder's primary account number and card
* expiration date.
*/
@JsonProperty("point_of_service_entry_mode")
@ExcludeMissing
fun _pointOfServiceEntryMode() = pointOfServiceEntryMode
/**
* Only present when `actioner: network`. Describes why a card authorization was
* approved or declined by Visa through stand-in processing.
*/
@JsonProperty("stand_in_processing_reason")
@ExcludeMissing
fun _standInProcessingReason() = standInProcessingReason
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): Visa = apply {
if (!validated) {
electronicCommerceIndicator()
pointOfServiceEntryMode()
standInProcessingReason()
validated = true
}
}
fun toBuilder() = Builder().from(this)
companion object {
fun builder() = Builder()
}
class Builder {
private var electronicCommerceIndicator:
JsonField =
JsonMissing.of()
private var pointOfServiceEntryMode: JsonField =
JsonMissing.of()
private var standInProcessingReason: JsonField =
JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(visa: Visa) = apply {
this.electronicCommerceIndicator = visa.electronicCommerceIndicator
this.pointOfServiceEntryMode = visa.pointOfServiceEntryMode
this.standInProcessingReason = visa.standInProcessingReason
additionalProperties(visa.additionalProperties)
}
/**
* For electronic commerce transactions, this identifies the level of security
* used in obtaining the customer's payment credential. For mail or telephone
* order transactions, identifies the type of mail or telephone order.
*/
fun electronicCommerceIndicator(
electronicCommerceIndicator: ElectronicCommerceIndicator
) = electronicCommerceIndicator(JsonField.of(electronicCommerceIndicator))
/**
* For electronic commerce transactions, this identifies the level of security
* used in obtaining the customer's payment credential. For mail or telephone
* order transactions, identifies the type of mail or telephone order.
*/
@JsonProperty("electronic_commerce_indicator")
@ExcludeMissing
fun electronicCommerceIndicator(
electronicCommerceIndicator: JsonField
) = apply { this.electronicCommerceIndicator = electronicCommerceIndicator }
/**
* The method used to enter the cardholder's primary account number and card
* expiration date.
*/
fun pointOfServiceEntryMode(pointOfServiceEntryMode: PointOfServiceEntryMode) =
pointOfServiceEntryMode(JsonField.of(pointOfServiceEntryMode))
/**
* The method used to enter the cardholder's primary account number and card
* expiration date.
*/
@JsonProperty("point_of_service_entry_mode")
@ExcludeMissing
fun pointOfServiceEntryMode(
pointOfServiceEntryMode: JsonField
) = apply { this.pointOfServiceEntryMode = pointOfServiceEntryMode }
/**
* Only present when `actioner: network`. Describes why a card authorization was
* approved or declined by Visa through stand-in processing.
*/
fun standInProcessingReason(standInProcessingReason: StandInProcessingReason) =
standInProcessingReason(JsonField.of(standInProcessingReason))
/**
* Only present when `actioner: network`. Describes why a card authorization was
* approved or declined by Visa through stand-in processing.
*/
@JsonProperty("stand_in_processing_reason")
@ExcludeMissing
fun standInProcessingReason(
standInProcessingReason: JsonField
) = apply { this.standInProcessingReason = standInProcessingReason }
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(): Visa =
Visa(
electronicCommerceIndicator,
pointOfServiceEntryMode,
standInProcessingReason,
additionalProperties.toImmutable(),
)
}
class ElectronicCommerceIndicator
@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 /* spotless:off */ other is ElectronicCommerceIndicator && this.value == other.value /* spotless:on */
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
val MAIL_PHONE_ORDER =
ElectronicCommerceIndicator(JsonField.of("mail_phone_order"))
val RECURRING = ElectronicCommerceIndicator(JsonField.of("recurring"))
val INSTALLMENT = ElectronicCommerceIndicator(JsonField.of("installment"))
val UNKNOWN_MAIL_PHONE_ORDER =
ElectronicCommerceIndicator(JsonField.of("unknown_mail_phone_order"))
val SECURE_ELECTRONIC_COMMERCE =
ElectronicCommerceIndicator(JsonField.of("secure_electronic_commerce"))
val NON_AUTHENTICATED_SECURITY_TRANSACTION_AT_3DS_CAPABLE_MERCHANT =
ElectronicCommerceIndicator(
JsonField.of(
"non_authenticated_security_transaction_at_3ds_capable_merchant"
)
)
val NON_AUTHENTICATED_SECURITY_TRANSACTION =
ElectronicCommerceIndicator(
JsonField.of("non_authenticated_security_transaction")
)
val NON_SECURE_TRANSACTION =
ElectronicCommerceIndicator(JsonField.of("non_secure_transaction"))
fun of(value: String) = ElectronicCommerceIndicator(JsonField.of(value))
}
enum class Known {
MAIL_PHONE_ORDER,
RECURRING,
INSTALLMENT,
UNKNOWN_MAIL_PHONE_ORDER,
SECURE_ELECTRONIC_COMMERCE,
NON_AUTHENTICATED_SECURITY_TRANSACTION_AT_3DS_CAPABLE_MERCHANT,
NON_AUTHENTICATED_SECURITY_TRANSACTION,
NON_SECURE_TRANSACTION,
}
enum class Value {
MAIL_PHONE_ORDER,
RECURRING,
INSTALLMENT,
UNKNOWN_MAIL_PHONE_ORDER,
SECURE_ELECTRONIC_COMMERCE,
NON_AUTHENTICATED_SECURITY_TRANSACTION_AT_3DS_CAPABLE_MERCHANT,
NON_AUTHENTICATED_SECURITY_TRANSACTION,
NON_SECURE_TRANSACTION,
_UNKNOWN,
}
fun value(): Value =
when (this) {
MAIL_PHONE_ORDER -> Value.MAIL_PHONE_ORDER
RECURRING -> Value.RECURRING
INSTALLMENT -> Value.INSTALLMENT
UNKNOWN_MAIL_PHONE_ORDER -> Value.UNKNOWN_MAIL_PHONE_ORDER
SECURE_ELECTRONIC_COMMERCE -> Value.SECURE_ELECTRONIC_COMMERCE
NON_AUTHENTICATED_SECURITY_TRANSACTION_AT_3DS_CAPABLE_MERCHANT ->
Value.NON_AUTHENTICATED_SECURITY_TRANSACTION_AT_3DS_CAPABLE_MERCHANT
NON_AUTHENTICATED_SECURITY_TRANSACTION ->
Value.NON_AUTHENTICATED_SECURITY_TRANSACTION
NON_SECURE_TRANSACTION -> Value.NON_SECURE_TRANSACTION
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
MAIL_PHONE_ORDER -> Known.MAIL_PHONE_ORDER
RECURRING -> Known.RECURRING
INSTALLMENT -> Known.INSTALLMENT
UNKNOWN_MAIL_PHONE_ORDER -> Known.UNKNOWN_MAIL_PHONE_ORDER
SECURE_ELECTRONIC_COMMERCE -> Known.SECURE_ELECTRONIC_COMMERCE
NON_AUTHENTICATED_SECURITY_TRANSACTION_AT_3DS_CAPABLE_MERCHANT ->
Known.NON_AUTHENTICATED_SECURITY_TRANSACTION_AT_3DS_CAPABLE_MERCHANT
NON_AUTHENTICATED_SECURITY_TRANSACTION ->
Known.NON_AUTHENTICATED_SECURITY_TRANSACTION
NON_SECURE_TRANSACTION -> Known.NON_SECURE_TRANSACTION
else ->
throw IncreaseInvalidDataException(
"Unknown ElectronicCommerceIndicator: $value"
)
}
fun asString(): String = _value().asStringOrThrow()
}
class PointOfServiceEntryMode
@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 /* spotless:off */ other is PointOfServiceEntryMode && this.value == other.value /* spotless:on */
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
val UNKNOWN = PointOfServiceEntryMode(JsonField.of("unknown"))
val MANUAL = PointOfServiceEntryMode(JsonField.of("manual"))
val MAGNETIC_STRIPE_NO_CVV =
PointOfServiceEntryMode(JsonField.of("magnetic_stripe_no_cvv"))
val OPTICAL_CODE = PointOfServiceEntryMode(JsonField.of("optical_code"))
val INTEGRATED_CIRCUIT_CARD =
PointOfServiceEntryMode(JsonField.of("integrated_circuit_card"))
val CONTACTLESS = PointOfServiceEntryMode(JsonField.of("contactless"))
val CREDENTIAL_ON_FILE =
PointOfServiceEntryMode(JsonField.of("credential_on_file"))
val MAGNETIC_STRIPE =
PointOfServiceEntryMode(JsonField.of("magnetic_stripe"))
val CONTACTLESS_MAGNETIC_STRIPE =
PointOfServiceEntryMode(JsonField.of("contactless_magnetic_stripe"))
val INTEGRATED_CIRCUIT_CARD_NO_CVV =
PointOfServiceEntryMode(JsonField.of("integrated_circuit_card_no_cvv"))
fun of(value: String) = PointOfServiceEntryMode(JsonField.of(value))
}
enum class Known {
UNKNOWN,
MANUAL,
MAGNETIC_STRIPE_NO_CVV,
OPTICAL_CODE,
INTEGRATED_CIRCUIT_CARD,
CONTACTLESS,
CREDENTIAL_ON_FILE,
MAGNETIC_STRIPE,
CONTACTLESS_MAGNETIC_STRIPE,
INTEGRATED_CIRCUIT_CARD_NO_CVV,
}
enum class Value {
UNKNOWN,
MANUAL,
MAGNETIC_STRIPE_NO_CVV,
OPTICAL_CODE,
INTEGRATED_CIRCUIT_CARD,
CONTACTLESS,
CREDENTIAL_ON_FILE,
MAGNETIC_STRIPE,
CONTACTLESS_MAGNETIC_STRIPE,
INTEGRATED_CIRCUIT_CARD_NO_CVV,
_UNKNOWN,
}
fun value(): Value =
when (this) {
UNKNOWN -> Value.UNKNOWN
MANUAL -> Value.MANUAL
MAGNETIC_STRIPE_NO_CVV -> Value.MAGNETIC_STRIPE_NO_CVV
OPTICAL_CODE -> Value.OPTICAL_CODE
INTEGRATED_CIRCUIT_CARD -> Value.INTEGRATED_CIRCUIT_CARD
CONTACTLESS -> Value.CONTACTLESS
CREDENTIAL_ON_FILE -> Value.CREDENTIAL_ON_FILE
MAGNETIC_STRIPE -> Value.MAGNETIC_STRIPE
CONTACTLESS_MAGNETIC_STRIPE -> Value.CONTACTLESS_MAGNETIC_STRIPE
INTEGRATED_CIRCUIT_CARD_NO_CVV -> Value.INTEGRATED_CIRCUIT_CARD_NO_CVV
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
UNKNOWN -> Known.UNKNOWN
MANUAL -> Known.MANUAL
MAGNETIC_STRIPE_NO_CVV -> Known.MAGNETIC_STRIPE_NO_CVV
OPTICAL_CODE -> Known.OPTICAL_CODE
INTEGRATED_CIRCUIT_CARD -> Known.INTEGRATED_CIRCUIT_CARD
CONTACTLESS -> Known.CONTACTLESS
CREDENTIAL_ON_FILE -> Known.CREDENTIAL_ON_FILE
MAGNETIC_STRIPE -> Known.MAGNETIC_STRIPE
CONTACTLESS_MAGNETIC_STRIPE -> Known.CONTACTLESS_MAGNETIC_STRIPE
INTEGRATED_CIRCUIT_CARD_NO_CVV -> Known.INTEGRATED_CIRCUIT_CARD_NO_CVV
else ->
throw IncreaseInvalidDataException(
"Unknown PointOfServiceEntryMode: $value"
)
}
fun asString(): String = _value().asStringOrThrow()
}
class StandInProcessingReason
@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 /* spotless:off */ other is StandInProcessingReason && this.value == other.value /* spotless:on */
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
val ISSUER_ERROR = StandInProcessingReason(JsonField.of("issuer_error"))
val INVALID_PHYSICAL_CARD =
StandInProcessingReason(JsonField.of("invalid_physical_card"))
val INVALID_CARDHOLDER_AUTHENTICATION_VERIFICATION_VALUE =
StandInProcessingReason(
JsonField.of("invalid_cardholder_authentication_verification_value")
)
val INTERNAL_VISA_ERROR =
StandInProcessingReason(JsonField.of("internal_visa_error"))
val MERCHANT_TRANSACTION_ADVISORY_SERVICE_AUTHENTICATION_REQUIRED =
StandInProcessingReason(
JsonField.of(
"merchant_transaction_advisory_service_authentication_required"
)
)
val OTHER = StandInProcessingReason(JsonField.of("other"))
fun of(value: String) = StandInProcessingReason(JsonField.of(value))
}
enum class Known {
ISSUER_ERROR,
INVALID_PHYSICAL_CARD,
INVALID_CARDHOLDER_AUTHENTICATION_VERIFICATION_VALUE,
INTERNAL_VISA_ERROR,
MERCHANT_TRANSACTION_ADVISORY_SERVICE_AUTHENTICATION_REQUIRED,
OTHER,
}
enum class Value {
ISSUER_ERROR,
INVALID_PHYSICAL_CARD,
INVALID_CARDHOLDER_AUTHENTICATION_VERIFICATION_VALUE,
INTERNAL_VISA_ERROR,
MERCHANT_TRANSACTION_ADVISORY_SERVICE_AUTHENTICATION_REQUIRED,
OTHER,
_UNKNOWN,
}
fun value(): Value =
when (this) {
ISSUER_ERROR -> Value.ISSUER_ERROR
INVALID_PHYSICAL_CARD -> Value.INVALID_PHYSICAL_CARD
INVALID_CARDHOLDER_AUTHENTICATION_VERIFICATION_VALUE ->
Value.INVALID_CARDHOLDER_AUTHENTICATION_VERIFICATION_VALUE
INTERNAL_VISA_ERROR -> Value.INTERNAL_VISA_ERROR
MERCHANT_TRANSACTION_ADVISORY_SERVICE_AUTHENTICATION_REQUIRED ->
Value.MERCHANT_TRANSACTION_ADVISORY_SERVICE_AUTHENTICATION_REQUIRED
OTHER -> Value.OTHER
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
ISSUER_ERROR -> Known.ISSUER_ERROR
INVALID_PHYSICAL_CARD -> Known.INVALID_PHYSICAL_CARD
INVALID_CARDHOLDER_AUTHENTICATION_VERIFICATION_VALUE ->
Known.INVALID_CARDHOLDER_AUTHENTICATION_VERIFICATION_VALUE
INTERNAL_VISA_ERROR -> Known.INTERNAL_VISA_ERROR
MERCHANT_TRANSACTION_ADVISORY_SERVICE_AUTHENTICATION_REQUIRED ->
Known.MERCHANT_TRANSACTION_ADVISORY_SERVICE_AUTHENTICATION_REQUIRED
OTHER -> Known.OTHER
else ->
throw IncreaseInvalidDataException(
"Unknown StandInProcessingReason: $value"
)
}
fun asString(): String = _value().asStringOrThrow()
}
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return /* spotless:off */ other is Visa && this.electronicCommerceIndicator == other.electronicCommerceIndicator && this.pointOfServiceEntryMode == other.pointOfServiceEntryMode && this.standInProcessingReason == other.standInProcessingReason && this.additionalProperties == other.additionalProperties /* spotless:on */
}
private var hashCode: Int = 0
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode = /* spotless:off */ Objects.hash(electronicCommerceIndicator, pointOfServiceEntryMode, standInProcessingReason, additionalProperties) /* spotless:on */
}
return hashCode
}
override fun toString() =
"Visa{electronicCommerceIndicator=$electronicCommerceIndicator, pointOfServiceEntryMode=$pointOfServiceEntryMode, standInProcessingReason=$standInProcessingReason, additionalProperties=$additionalProperties}"
}
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return /* spotless:off */ other is NetworkDetails && this.category == other.category && this.visa == other.visa && this.additionalProperties == other.additionalProperties /* spotless:on */
}
private var hashCode: Int = 0
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode = /* spotless:off */ Objects.hash(category, visa, additionalProperties) /* spotless:on */
}
return hashCode
}
override fun toString() =
"NetworkDetails{category=$category, visa=$visa, additionalProperties=$additionalProperties}"
}
/** Network-specific identifiers for a specific request or transaction. */
@JsonDeserialize(builder = NetworkIdentifiers.Builder::class)
@NoAutoDetect
class NetworkIdentifiers
private constructor(
private val retrievalReferenceNumber: JsonField,
private val traceNumber: JsonField,
private val transactionId: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
/**
* A life-cycle identifier used across e.g., an authorization and a reversal. Expected
* to be unique per acquirer within a window of time. For some card networks the
* retrieval reference number includes the trace counter.
*/
fun retrievalReferenceNumber(): String? =
retrievalReferenceNumber.getNullable("retrieval_reference_number")
/**
* A counter used to verify an individual authorization. Expected to be unique per
* acquirer within a window of time.
*/
fun traceNumber(): String? = traceNumber.getNullable("trace_number")
/**
* A globally unique transaction identifier provided by the card network, used across
* multiple life-cycle requests.
*/
fun transactionId(): String? = transactionId.getNullable("transaction_id")
/**
* A life-cycle identifier used across e.g., an authorization and a reversal. Expected
* to be unique per acquirer within a window of time. For some card networks the
* retrieval reference number includes the trace counter.
*/
@JsonProperty("retrieval_reference_number")
@ExcludeMissing
fun _retrievalReferenceNumber() = retrievalReferenceNumber
/**
* A counter used to verify an individual authorization. Expected to be unique per
* acquirer within a window of time.
*/
@JsonProperty("trace_number") @ExcludeMissing fun _traceNumber() = traceNumber
/**
* A globally unique transaction identifier provided by the card network, used across
* multiple life-cycle requests.
*/
@JsonProperty("transaction_id") @ExcludeMissing fun _transactionId() = transactionId
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): NetworkIdentifiers = apply {
if (!validated) {
retrievalReferenceNumber()
traceNumber()
transactionId()
validated = true
}
}
fun toBuilder() = Builder().from(this)
companion object {
fun builder() = Builder()
}
class Builder {
private var retrievalReferenceNumber: JsonField = JsonMissing.of()
private var traceNumber: JsonField = JsonMissing.of()
private var transactionId: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(networkIdentifiers: NetworkIdentifiers) = apply {
this.retrievalReferenceNumber = networkIdentifiers.retrievalReferenceNumber
this.traceNumber = networkIdentifiers.traceNumber
this.transactionId = networkIdentifiers.transactionId
additionalProperties(networkIdentifiers.additionalProperties)
}
/**
* A life-cycle identifier used across e.g., an authorization and a reversal.
* Expected to be unique per acquirer within a window of time. For some card
* networks the retrieval reference number includes the trace counter.
*/
fun retrievalReferenceNumber(retrievalReferenceNumber: String) =
retrievalReferenceNumber(JsonField.of(retrievalReferenceNumber))
/**
* A life-cycle identifier used across e.g., an authorization and a reversal.
* Expected to be unique per acquirer within a window of time. For some card
* networks the retrieval reference number includes the trace counter.
*/
@JsonProperty("retrieval_reference_number")
@ExcludeMissing
fun retrievalReferenceNumber(retrievalReferenceNumber: JsonField) = apply {
this.retrievalReferenceNumber = retrievalReferenceNumber
}
/**
* A counter used to verify an individual authorization. Expected to be unique per
* acquirer within a window of time.
*/
fun traceNumber(traceNumber: String) = traceNumber(JsonField.of(traceNumber))
/**
* A counter used to verify an individual authorization. Expected to be unique per
* acquirer within a window of time.
*/
@JsonProperty("trace_number")
@ExcludeMissing
fun traceNumber(traceNumber: JsonField) = apply {
this.traceNumber = traceNumber
}
/**
* A globally unique transaction identifier provided by the card network, used
* across multiple life-cycle requests.
*/
fun transactionId(transactionId: String) =
transactionId(JsonField.of(transactionId))
/**
* A globally unique transaction identifier provided by the card network, used
* across multiple life-cycle requests.
*/
@JsonProperty("transaction_id")
@ExcludeMissing
fun transactionId(transactionId: JsonField) = apply {
this.transactionId = transactionId
}
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(): NetworkIdentifiers =
NetworkIdentifiers(
retrievalReferenceNumber,
traceNumber,
transactionId,
additionalProperties.toImmutable(),
)
}
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return /* spotless:off */ other is NetworkIdentifiers && this.retrievalReferenceNumber == other.retrievalReferenceNumber && this.traceNumber == other.traceNumber && this.transactionId == other.transactionId && this.additionalProperties == other.additionalProperties /* spotless:on */
}
private var hashCode: Int = 0
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode = /* spotless:off */ Objects.hash(retrievalReferenceNumber, traceNumber, transactionId, additionalProperties) /* spotless:on */
}
return hashCode
}
override fun toString() =
"NetworkIdentifiers{retrievalReferenceNumber=$retrievalReferenceNumber, traceNumber=$traceNumber, transactionId=$transactionId, additionalProperties=$additionalProperties}"
}
class ProcessingCategory
@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 /* spotless:off */ other is ProcessingCategory && this.value == other.value /* spotless:on */
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
val ACCOUNT_FUNDING = ProcessingCategory(JsonField.of("account_funding"))
val AUTOMATIC_FUEL_DISPENSER =
ProcessingCategory(JsonField.of("automatic_fuel_dispenser"))
val BILL_PAYMENT = ProcessingCategory(JsonField.of("bill_payment"))
val PURCHASE = ProcessingCategory(JsonField.of("purchase"))
val QUASI_CASH = ProcessingCategory(JsonField.of("quasi_cash"))
val REFUND = ProcessingCategory(JsonField.of("refund"))
fun of(value: String) = ProcessingCategory(JsonField.of(value))
}
enum class Known {
ACCOUNT_FUNDING,
AUTOMATIC_FUEL_DISPENSER,
BILL_PAYMENT,
PURCHASE,
QUASI_CASH,
REFUND,
}
enum class Value {
ACCOUNT_FUNDING,
AUTOMATIC_FUEL_DISPENSER,
BILL_PAYMENT,
PURCHASE,
QUASI_CASH,
REFUND,
_UNKNOWN,
}
fun value(): Value =
when (this) {
ACCOUNT_FUNDING -> Value.ACCOUNT_FUNDING
AUTOMATIC_FUEL_DISPENSER -> Value.AUTOMATIC_FUEL_DISPENSER
BILL_PAYMENT -> Value.BILL_PAYMENT
PURCHASE -> Value.PURCHASE
QUASI_CASH -> Value.QUASI_CASH
REFUND -> Value.REFUND
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
ACCOUNT_FUNDING -> Known.ACCOUNT_FUNDING
AUTOMATIC_FUEL_DISPENSER -> Known.AUTOMATIC_FUEL_DISPENSER
BILL_PAYMENT -> Known.BILL_PAYMENT
PURCHASE -> Known.PURCHASE
QUASI_CASH -> Known.QUASI_CASH
REFUND -> Known.REFUND
else -> throw IncreaseInvalidDataException("Unknown ProcessingCategory: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
/** Fields specific to the type of request, such as an incremental authorization. */
@JsonDeserialize(builder = RequestDetails.Builder::class)
@NoAutoDetect
class RequestDetails
private constructor(
private val category: JsonField,
private val incrementalAuthorization: JsonField,
private val initialAuthorization: JsonValue,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
/**
* The type of this request (e.g., an initial authorization or an incremental
* authorization).
*/
fun category(): Category = category.getRequired("category")
/** Fields specific to the category `incremental_authorization`. */
fun incrementalAuthorization(): IncrementalAuthorization? =
incrementalAuthorization.getNullable("incremental_authorization")
/**
* The type of this request (e.g., an initial authorization or an incremental
* authorization).
*/
@JsonProperty("category") @ExcludeMissing fun _category() = category
/** Fields specific to the category `incremental_authorization`. */
@JsonProperty("incremental_authorization")
@ExcludeMissing
fun _incrementalAuthorization() = incrementalAuthorization
/** Fields specific to the category `initial_authorization`. */
@JsonProperty("initial_authorization")
@ExcludeMissing
fun _initialAuthorization() = initialAuthorization
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): RequestDetails = apply {
if (!validated) {
category()
incrementalAuthorization()?.validate()
validated = true
}
}
fun toBuilder() = Builder().from(this)
companion object {
fun builder() = Builder()
}
class Builder {
private var category: JsonField = JsonMissing.of()
private var incrementalAuthorization: JsonField =
JsonMissing.of()
private var initialAuthorization: JsonValue = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(requestDetails: RequestDetails) = apply {
this.category = requestDetails.category
this.incrementalAuthorization = requestDetails.incrementalAuthorization
this.initialAuthorization = requestDetails.initialAuthorization
additionalProperties(requestDetails.additionalProperties)
}
/**
* The type of this request (e.g., an initial authorization or an incremental
* authorization).
*/
fun category(category: Category) = category(JsonField.of(category))
/**
* The type of this request (e.g., an initial authorization or an incremental
* authorization).
*/
@JsonProperty("category")
@ExcludeMissing
fun category(category: JsonField) = apply { this.category = category }
/** Fields specific to the category `incremental_authorization`. */
fun incrementalAuthorization(incrementalAuthorization: IncrementalAuthorization) =
incrementalAuthorization(JsonField.of(incrementalAuthorization))
/** Fields specific to the category `incremental_authorization`. */
@JsonProperty("incremental_authorization")
@ExcludeMissing
fun incrementalAuthorization(
incrementalAuthorization: JsonField
) = apply { this.incrementalAuthorization = incrementalAuthorization }
/** Fields specific to the category `initial_authorization`. */
@JsonProperty("initial_authorization")
@ExcludeMissing
fun initialAuthorization(initialAuthorization: JsonValue) = apply {
this.initialAuthorization = initialAuthorization
}
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(): RequestDetails =
RequestDetails(
category,
incrementalAuthorization,
initialAuthorization,
additionalProperties.toImmutable(),
)
}
class Category
@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 /* spotless:off */ other is Category && this.value == other.value /* spotless:on */
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
val INITIAL_AUTHORIZATION = Category(JsonField.of("initial_authorization"))
val INCREMENTAL_AUTHORIZATION =
Category(JsonField.of("incremental_authorization"))
fun of(value: String) = Category(JsonField.of(value))
}
enum class Known {
INITIAL_AUTHORIZATION,
INCREMENTAL_AUTHORIZATION,
}
enum class Value {
INITIAL_AUTHORIZATION,
INCREMENTAL_AUTHORIZATION,
_UNKNOWN,
}
fun value(): Value =
when (this) {
INITIAL_AUTHORIZATION -> Value.INITIAL_AUTHORIZATION
INCREMENTAL_AUTHORIZATION -> Value.INCREMENTAL_AUTHORIZATION
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
INITIAL_AUTHORIZATION -> Known.INITIAL_AUTHORIZATION
INCREMENTAL_AUTHORIZATION -> Known.INCREMENTAL_AUTHORIZATION
else -> throw IncreaseInvalidDataException("Unknown Category: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
/** Fields specific to the category `incremental_authorization`. */
@JsonDeserialize(builder = IncrementalAuthorization.Builder::class)
@NoAutoDetect
class IncrementalAuthorization
private constructor(
private val cardPaymentId: JsonField,
private val originalCardAuthorizationId: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
/** The card payment for this authorization and increment. */
fun cardPaymentId(): String = cardPaymentId.getRequired("card_payment_id")
/**
* The identifier of the card authorization this request is attempting to increment.
*/
fun originalCardAuthorizationId(): String =
originalCardAuthorizationId.getRequired("original_card_authorization_id")
/** The card payment for this authorization and increment. */
@JsonProperty("card_payment_id")
@ExcludeMissing
fun _cardPaymentId() = cardPaymentId
/**
* The identifier of the card authorization this request is attempting to increment.
*/
@JsonProperty("original_card_authorization_id")
@ExcludeMissing
fun _originalCardAuthorizationId() = originalCardAuthorizationId
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): IncrementalAuthorization = apply {
if (!validated) {
cardPaymentId()
originalCardAuthorizationId()
validated = true
}
}
fun toBuilder() = Builder().from(this)
companion object {
fun builder() = Builder()
}
class Builder {
private var cardPaymentId: JsonField = JsonMissing.of()
private var originalCardAuthorizationId: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(incrementalAuthorization: IncrementalAuthorization) = apply {
this.cardPaymentId = incrementalAuthorization.cardPaymentId
this.originalCardAuthorizationId =
incrementalAuthorization.originalCardAuthorizationId
additionalProperties(incrementalAuthorization.additionalProperties)
}
/** The card payment for this authorization and increment. */
fun cardPaymentId(cardPaymentId: String) =
cardPaymentId(JsonField.of(cardPaymentId))
/** The card payment for this authorization and increment. */
@JsonProperty("card_payment_id")
@ExcludeMissing
fun cardPaymentId(cardPaymentId: JsonField) = apply {
this.cardPaymentId = cardPaymentId
}
/**
* The identifier of the card authorization this request is attempting to
* increment.
*/
fun originalCardAuthorizationId(originalCardAuthorizationId: String) =
originalCardAuthorizationId(JsonField.of(originalCardAuthorizationId))
/**
* The identifier of the card authorization this request is attempting to
* increment.
*/
@JsonProperty("original_card_authorization_id")
@ExcludeMissing
fun originalCardAuthorizationId(
originalCardAuthorizationId: JsonField
) = apply { this.originalCardAuthorizationId = originalCardAuthorizationId }
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(): IncrementalAuthorization =
IncrementalAuthorization(
cardPaymentId,
originalCardAuthorizationId,
additionalProperties.toImmutable(),
)
}
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return /* spotless:off */ other is IncrementalAuthorization && this.cardPaymentId == other.cardPaymentId && this.originalCardAuthorizationId == other.originalCardAuthorizationId && this.additionalProperties == other.additionalProperties /* spotless:on */
}
private var hashCode: Int = 0
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode = /* spotless:off */ Objects.hash(cardPaymentId, originalCardAuthorizationId, additionalProperties) /* spotless:on */
}
return hashCode
}
override fun toString() =
"IncrementalAuthorization{cardPaymentId=$cardPaymentId, originalCardAuthorizationId=$originalCardAuthorizationId, additionalProperties=$additionalProperties}"
}
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return /* spotless:off */ other is RequestDetails && this.category == other.category && this.incrementalAuthorization == other.incrementalAuthorization && this.initialAuthorization == other.initialAuthorization && this.additionalProperties == other.additionalProperties /* spotless:on */
}
private var hashCode: Int = 0
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode = /* spotless:off */ Objects.hash(category, incrementalAuthorization, initialAuthorization, additionalProperties) /* spotless:on */
}
return hashCode
}
override fun toString() =
"RequestDetails{category=$category, incrementalAuthorization=$incrementalAuthorization, initialAuthorization=$initialAuthorization, additionalProperties=$additionalProperties}"
}
/** Fields related to verification of cardholder-provided values. */
@JsonDeserialize(builder = Verification.Builder::class)
@NoAutoDetect
class Verification
private constructor(
private val cardVerificationCode: JsonField,
private val cardholderAddress: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
/**
* Fields related to verification of the Card Verification Code, a 3-digit code on the
* back of the card.
*/
fun cardVerificationCode(): CardVerificationCode =
cardVerificationCode.getRequired("card_verification_code")
/**
* Cardholder address provided in the authorization request and the address on file we
* verified it against.
*/
fun cardholderAddress(): CardholderAddress =
cardholderAddress.getRequired("cardholder_address")
/**
* Fields related to verification of the Card Verification Code, a 3-digit code on the
* back of the card.
*/
@JsonProperty("card_verification_code")
@ExcludeMissing
fun _cardVerificationCode() = cardVerificationCode
/**
* Cardholder address provided in the authorization request and the address on file we
* verified it against.
*/
@JsonProperty("cardholder_address")
@ExcludeMissing
fun _cardholderAddress() = cardholderAddress
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): Verification = apply {
if (!validated) {
cardVerificationCode().validate()
cardholderAddress().validate()
validated = true
}
}
fun toBuilder() = Builder().from(this)
companion object {
fun builder() = Builder()
}
class Builder {
private var cardVerificationCode: JsonField = JsonMissing.of()
private var cardholderAddress: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(verification: Verification) = apply {
this.cardVerificationCode = verification.cardVerificationCode
this.cardholderAddress = verification.cardholderAddress
additionalProperties(verification.additionalProperties)
}
/**
* Fields related to verification of the Card Verification Code, a 3-digit code on
* the back of the card.
*/
fun cardVerificationCode(cardVerificationCode: CardVerificationCode) =
cardVerificationCode(JsonField.of(cardVerificationCode))
/**
* Fields related to verification of the Card Verification Code, a 3-digit code on
* the back of the card.
*/
@JsonProperty("card_verification_code")
@ExcludeMissing
fun cardVerificationCode(cardVerificationCode: JsonField) =
apply {
this.cardVerificationCode = cardVerificationCode
}
/**
* Cardholder address provided in the authorization request and the address on file
* we verified it against.
*/
fun cardholderAddress(cardholderAddress: CardholderAddress) =
cardholderAddress(JsonField.of(cardholderAddress))
/**
* Cardholder address provided in the authorization request and the address on file
* we verified it against.
*/
@JsonProperty("cardholder_address")
@ExcludeMissing
fun cardholderAddress(cardholderAddress: JsonField) = apply {
this.cardholderAddress = cardholderAddress
}
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(): Verification =
Verification(
cardVerificationCode,
cardholderAddress,
additionalProperties.toImmutable(),
)
}
/**
* Fields related to verification of the Card Verification Code, a 3-digit code on the
* back of the card.
*/
@JsonDeserialize(builder = CardVerificationCode.Builder::class)
@NoAutoDetect
class CardVerificationCode
private constructor(
private val result: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
/** The result of verifying the Card Verification Code. */
fun result(): Result = result.getRequired("result")
/** The result of verifying the Card Verification Code. */
@JsonProperty("result") @ExcludeMissing fun _result() = result
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): CardVerificationCode = apply {
if (!validated) {
result()
validated = true
}
}
fun toBuilder() = Builder().from(this)
companion object {
fun builder() = Builder()
}
class Builder {
private var result: JsonField