com.increase.api.models.InboundCheckDeposit.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of increase-java-core Show documentation
Show all versions of increase-java-core Show documentation
An SDK library for increase
The newest version!
// 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.toUnmodifiable
import com.increase.api.errors.IncreaseInvalidDataException
import java.time.OffsetDateTime
import java.util.Objects
import java.util.Optional
/**
* Inbound Check Deposits are records of third-parties attempting to deposit checks against your
* account.
*/
@JsonDeserialize(builder = InboundCheckDeposit.Builder::class)
@NoAutoDetect
class InboundCheckDeposit
private constructor(
private val acceptedAt: JsonField,
private val accountId: JsonField,
private val accountNumberId: JsonField,
private val amount: JsonField,
private val backImageFileId: JsonField,
private val bankOfFirstDepositRoutingNumber: JsonField,
private val checkNumber: JsonField,
private val checkTransferId: JsonField,
private val createdAt: JsonField,
private val currency: JsonField,
private val declinedAt: JsonField,
private val declinedTransactionId: JsonField,
private val depositReturn: JsonField,
private val frontImageFileId: JsonField,
private val id: JsonField,
private val status: JsonField,
private val transactionId: JsonField,
private val type: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/**
* If the Inbound Check Deposit was accepted, the
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which this took place.
*/
fun acceptedAt(): Optional =
Optional.ofNullable(acceptedAt.getNullable("accepted_at"))
/** The Account the check is being deposited against. */
fun accountId(): String = accountId.getRequired("account_id")
/** The Account Number the check is being deposited against. */
fun accountNumberId(): Optional =
Optional.ofNullable(accountNumberId.getNullable("account_number_id"))
/**
* The deposited amount in the minor unit of the destination account currency. For dollars, for
* example, this is cents.
*/
fun amount(): Long = amount.getRequired("amount")
/** The ID for the File containing the image of the back of the check. */
fun backImageFileId(): Optional =
Optional.ofNullable(backImageFileId.getNullable("back_image_file_id"))
/**
* The American Bankers' Association (ABA) Routing Transit Number (RTN) for the bank depositing
* this check. In some rare cases, this is not transmitted via Check21 and the value will be
* null.
*/
fun bankOfFirstDepositRoutingNumber(): Optional =
Optional.ofNullable(
bankOfFirstDepositRoutingNumber.getNullable("bank_of_first_deposit_routing_number")
)
/** The check number printed on the check being deposited. */
fun checkNumber(): Optional =
Optional.ofNullable(checkNumber.getNullable("check_number"))
/** If this deposit is for an existing Check Transfer, the identifier of that Check Transfer. */
fun checkTransferId(): Optional =
Optional.ofNullable(checkTransferId.getNullable("check_transfer_id"))
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the deposit was
* attempted.
*/
fun createdAt(): OffsetDateTime = createdAt.getRequired("created_at")
/** The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the deposit. */
fun currency(): Currency = currency.getRequired("currency")
/**
* If the Inbound Check Deposit was declined, the
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which this took place.
*/
fun declinedAt(): Optional =
Optional.ofNullable(declinedAt.getNullable("declined_at"))
/**
* If the deposit attempt has been rejected, the identifier of the Declined Transaction object
* created as a result of the failed deposit.
*/
fun declinedTransactionId(): Optional =
Optional.ofNullable(declinedTransactionId.getNullable("declined_transaction_id"))
/** If you requested a return of this deposit, this will contain details of the return. */
fun depositReturn(): Optional =
Optional.ofNullable(depositReturn.getNullable("deposit_return"))
/** The ID for the File containing the image of the front of the check. */
fun frontImageFileId(): Optional =
Optional.ofNullable(frontImageFileId.getNullable("front_image_file_id"))
/** The deposit's identifier. */
fun id(): String = id.getRequired("id")
/** The status of the Inbound Check Deposit. */
fun status(): Status = status.getRequired("status")
/**
* If the deposit attempt has been accepted, the identifier of the Transaction object created as
* a result of the successful deposit.
*/
fun transactionId(): Optional =
Optional.ofNullable(transactionId.getNullable("transaction_id"))
/**
* A constant representing the object's type. For this resource it will always be
* `inbound_check_deposit`.
*/
fun type(): Type = type.getRequired("type")
/**
* If the Inbound Check Deposit was accepted, the
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which this took place.
*/
@JsonProperty("accepted_at") @ExcludeMissing fun _acceptedAt() = acceptedAt
/** The Account the check is being deposited against. */
@JsonProperty("account_id") @ExcludeMissing fun _accountId() = accountId
/** The Account Number the check is being deposited against. */
@JsonProperty("account_number_id") @ExcludeMissing fun _accountNumberId() = accountNumberId
/**
* The deposited amount in the minor unit of the destination account currency. For dollars, for
* example, this is cents.
*/
@JsonProperty("amount") @ExcludeMissing fun _amount() = amount
/** The ID for the File containing the image of the back of the check. */
@JsonProperty("back_image_file_id") @ExcludeMissing fun _backImageFileId() = backImageFileId
/**
* The American Bankers' Association (ABA) Routing Transit Number (RTN) for the bank depositing
* this check. In some rare cases, this is not transmitted via Check21 and the value will be
* null.
*/
@JsonProperty("bank_of_first_deposit_routing_number")
@ExcludeMissing
fun _bankOfFirstDepositRoutingNumber() = bankOfFirstDepositRoutingNumber
/** The check number printed on the check being deposited. */
@JsonProperty("check_number") @ExcludeMissing fun _checkNumber() = checkNumber
/** If this deposit is for an existing Check Transfer, the identifier of that Check Transfer. */
@JsonProperty("check_transfer_id") @ExcludeMissing fun _checkTransferId() = checkTransferId
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the deposit was
* attempted.
*/
@JsonProperty("created_at") @ExcludeMissing fun _createdAt() = createdAt
/** The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the deposit. */
@JsonProperty("currency") @ExcludeMissing fun _currency() = currency
/**
* If the Inbound Check Deposit was declined, the
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which this took place.
*/
@JsonProperty("declined_at") @ExcludeMissing fun _declinedAt() = declinedAt
/**
* If the deposit attempt has been rejected, the identifier of the Declined Transaction object
* created as a result of the failed deposit.
*/
@JsonProperty("declined_transaction_id")
@ExcludeMissing
fun _declinedTransactionId() = declinedTransactionId
/** If you requested a return of this deposit, this will contain details of the return. */
@JsonProperty("deposit_return") @ExcludeMissing fun _depositReturn() = depositReturn
/** The ID for the File containing the image of the front of the check. */
@JsonProperty("front_image_file_id") @ExcludeMissing fun _frontImageFileId() = frontImageFileId
/** The deposit's identifier. */
@JsonProperty("id") @ExcludeMissing fun _id() = id
/** The status of the Inbound Check Deposit. */
@JsonProperty("status") @ExcludeMissing fun _status() = status
/**
* If the deposit attempt has been accepted, the identifier of the Transaction object created as
* a result of the successful deposit.
*/
@JsonProperty("transaction_id") @ExcludeMissing fun _transactionId() = transactionId
/**
* A constant representing the object's type. For this resource it will always be
* `inbound_check_deposit`.
*/
@JsonProperty("type") @ExcludeMissing fun _type() = type
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): InboundCheckDeposit = apply {
if (!validated) {
acceptedAt()
accountId()
accountNumberId()
amount()
backImageFileId()
bankOfFirstDepositRoutingNumber()
checkNumber()
checkTransferId()
createdAt()
currency()
declinedAt()
declinedTransactionId()
depositReturn().map { it.validate() }
frontImageFileId()
id()
status()
transactionId()
type()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is InboundCheckDeposit &&
this.acceptedAt == other.acceptedAt &&
this.accountId == other.accountId &&
this.accountNumberId == other.accountNumberId &&
this.amount == other.amount &&
this.backImageFileId == other.backImageFileId &&
this.bankOfFirstDepositRoutingNumber == other.bankOfFirstDepositRoutingNumber &&
this.checkNumber == other.checkNumber &&
this.checkTransferId == other.checkTransferId &&
this.createdAt == other.createdAt &&
this.currency == other.currency &&
this.declinedAt == other.declinedAt &&
this.declinedTransactionId == other.declinedTransactionId &&
this.depositReturn == other.depositReturn &&
this.frontImageFileId == other.frontImageFileId &&
this.id == other.id &&
this.status == other.status &&
this.transactionId == other.transactionId &&
this.type == other.type &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
acceptedAt,
accountId,
accountNumberId,
amount,
backImageFileId,
bankOfFirstDepositRoutingNumber,
checkNumber,
checkTransferId,
createdAt,
currency,
declinedAt,
declinedTransactionId,
depositReturn,
frontImageFileId,
id,
status,
transactionId,
type,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"InboundCheckDeposit{acceptedAt=$acceptedAt, accountId=$accountId, accountNumberId=$accountNumberId, amount=$amount, backImageFileId=$backImageFileId, bankOfFirstDepositRoutingNumber=$bankOfFirstDepositRoutingNumber, checkNumber=$checkNumber, checkTransferId=$checkTransferId, createdAt=$createdAt, currency=$currency, declinedAt=$declinedAt, declinedTransactionId=$declinedTransactionId, depositReturn=$depositReturn, frontImageFileId=$frontImageFileId, id=$id, status=$status, transactionId=$transactionId, type=$type, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var acceptedAt: JsonField = JsonMissing.of()
private var accountId: JsonField = JsonMissing.of()
private var accountNumberId: JsonField = JsonMissing.of()
private var amount: JsonField = JsonMissing.of()
private var backImageFileId: JsonField = JsonMissing.of()
private var bankOfFirstDepositRoutingNumber: JsonField = JsonMissing.of()
private var checkNumber: JsonField = JsonMissing.of()
private var checkTransferId: JsonField = JsonMissing.of()
private var createdAt: JsonField = JsonMissing.of()
private var currency: JsonField = JsonMissing.of()
private var declinedAt: JsonField = JsonMissing.of()
private var declinedTransactionId: JsonField = JsonMissing.of()
private var depositReturn: JsonField = JsonMissing.of()
private var frontImageFileId: JsonField = JsonMissing.of()
private var id: JsonField = JsonMissing.of()
private var status: JsonField = JsonMissing.of()
private var transactionId: JsonField = JsonMissing.of()
private var type: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(inboundCheckDeposit: InboundCheckDeposit) = apply {
this.acceptedAt = inboundCheckDeposit.acceptedAt
this.accountId = inboundCheckDeposit.accountId
this.accountNumberId = inboundCheckDeposit.accountNumberId
this.amount = inboundCheckDeposit.amount
this.backImageFileId = inboundCheckDeposit.backImageFileId
this.bankOfFirstDepositRoutingNumber =
inboundCheckDeposit.bankOfFirstDepositRoutingNumber
this.checkNumber = inboundCheckDeposit.checkNumber
this.checkTransferId = inboundCheckDeposit.checkTransferId
this.createdAt = inboundCheckDeposit.createdAt
this.currency = inboundCheckDeposit.currency
this.declinedAt = inboundCheckDeposit.declinedAt
this.declinedTransactionId = inboundCheckDeposit.declinedTransactionId
this.depositReturn = inboundCheckDeposit.depositReturn
this.frontImageFileId = inboundCheckDeposit.frontImageFileId
this.id = inboundCheckDeposit.id
this.status = inboundCheckDeposit.status
this.transactionId = inboundCheckDeposit.transactionId
this.type = inboundCheckDeposit.type
additionalProperties(inboundCheckDeposit.additionalProperties)
}
/**
* If the Inbound Check Deposit was accepted, the
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which this took
* place.
*/
fun acceptedAt(acceptedAt: OffsetDateTime) = acceptedAt(JsonField.of(acceptedAt))
/**
* If the Inbound Check Deposit was accepted, the
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which this took
* place.
*/
@JsonProperty("accepted_at")
@ExcludeMissing
fun acceptedAt(acceptedAt: JsonField) = apply {
this.acceptedAt = acceptedAt
}
/** The Account the check is being deposited against. */
fun accountId(accountId: String) = accountId(JsonField.of(accountId))
/** The Account the check is being deposited against. */
@JsonProperty("account_id")
@ExcludeMissing
fun accountId(accountId: JsonField) = apply { this.accountId = accountId }
/** The Account Number the check is being deposited against. */
fun accountNumberId(accountNumberId: String) =
accountNumberId(JsonField.of(accountNumberId))
/** The Account Number the check is being deposited against. */
@JsonProperty("account_number_id")
@ExcludeMissing
fun accountNumberId(accountNumberId: JsonField) = apply {
this.accountNumberId = accountNumberId
}
/**
* The deposited amount in the minor unit of the destination account currency. For dollars,
* for example, this is cents.
*/
fun amount(amount: Long) = amount(JsonField.of(amount))
/**
* The deposited amount in the minor unit of the destination account currency. For dollars,
* for example, this is cents.
*/
@JsonProperty("amount")
@ExcludeMissing
fun amount(amount: JsonField) = apply { this.amount = amount }
/** The ID for the File containing the image of the back of the check. */
fun backImageFileId(backImageFileId: String) =
backImageFileId(JsonField.of(backImageFileId))
/** The ID for the File containing the image of the back of the check. */
@JsonProperty("back_image_file_id")
@ExcludeMissing
fun backImageFileId(backImageFileId: JsonField) = apply {
this.backImageFileId = backImageFileId
}
/**
* The American Bankers' Association (ABA) Routing Transit Number (RTN) for the bank
* depositing this check. In some rare cases, this is not transmitted via Check21 and the
* value will be null.
*/
fun bankOfFirstDepositRoutingNumber(bankOfFirstDepositRoutingNumber: String) =
bankOfFirstDepositRoutingNumber(JsonField.of(bankOfFirstDepositRoutingNumber))
/**
* The American Bankers' Association (ABA) Routing Transit Number (RTN) for the bank
* depositing this check. In some rare cases, this is not transmitted via Check21 and the
* value will be null.
*/
@JsonProperty("bank_of_first_deposit_routing_number")
@ExcludeMissing
fun bankOfFirstDepositRoutingNumber(bankOfFirstDepositRoutingNumber: JsonField) =
apply {
this.bankOfFirstDepositRoutingNumber = bankOfFirstDepositRoutingNumber
}
/** The check number printed on the check being deposited. */
fun checkNumber(checkNumber: String) = checkNumber(JsonField.of(checkNumber))
/** The check number printed on the check being deposited. */
@JsonProperty("check_number")
@ExcludeMissing
fun checkNumber(checkNumber: JsonField) = apply { this.checkNumber = checkNumber }
/**
* If this deposit is for an existing Check Transfer, the identifier of that Check Transfer.
*/
fun checkTransferId(checkTransferId: String) =
checkTransferId(JsonField.of(checkTransferId))
/**
* If this deposit is for an existing Check Transfer, the identifier of that Check Transfer.
*/
@JsonProperty("check_transfer_id")
@ExcludeMissing
fun checkTransferId(checkTransferId: JsonField) = apply {
this.checkTransferId = checkTransferId
}
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the deposit
* was attempted.
*/
fun createdAt(createdAt: OffsetDateTime) = createdAt(JsonField.of(createdAt))
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the deposit
* was attempted.
*/
@JsonProperty("created_at")
@ExcludeMissing
fun createdAt(createdAt: JsonField) = apply { this.createdAt = createdAt }
/** The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the deposit. */
fun currency(currency: Currency) = currency(JsonField.of(currency))
/** The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the deposit. */
@JsonProperty("currency")
@ExcludeMissing
fun currency(currency: JsonField) = apply { this.currency = currency }
/**
* If the Inbound Check Deposit was declined, the
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which this took
* place.
*/
fun declinedAt(declinedAt: OffsetDateTime) = declinedAt(JsonField.of(declinedAt))
/**
* If the Inbound Check Deposit was declined, the
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which this took
* place.
*/
@JsonProperty("declined_at")
@ExcludeMissing
fun declinedAt(declinedAt: JsonField) = apply {
this.declinedAt = declinedAt
}
/**
* If the deposit attempt has been rejected, the identifier of the Declined Transaction
* object created as a result of the failed deposit.
*/
fun declinedTransactionId(declinedTransactionId: String) =
declinedTransactionId(JsonField.of(declinedTransactionId))
/**
* If the deposit attempt has been rejected, the identifier of the Declined Transaction
* object created as a result of the failed deposit.
*/
@JsonProperty("declined_transaction_id")
@ExcludeMissing
fun declinedTransactionId(declinedTransactionId: JsonField) = apply {
this.declinedTransactionId = declinedTransactionId
}
/** If you requested a return of this deposit, this will contain details of the return. */
fun depositReturn(depositReturn: DepositReturn) = depositReturn(JsonField.of(depositReturn))
/** If you requested a return of this deposit, this will contain details of the return. */
@JsonProperty("deposit_return")
@ExcludeMissing
fun depositReturn(depositReturn: JsonField) = apply {
this.depositReturn = depositReturn
}
/** The ID for the File containing the image of the front of the check. */
fun frontImageFileId(frontImageFileId: String) =
frontImageFileId(JsonField.of(frontImageFileId))
/** The ID for the File containing the image of the front of the check. */
@JsonProperty("front_image_file_id")
@ExcludeMissing
fun frontImageFileId(frontImageFileId: JsonField) = apply {
this.frontImageFileId = frontImageFileId
}
/** The deposit's identifier. */
fun id(id: String) = id(JsonField.of(id))
/** The deposit's identifier. */
@JsonProperty("id") @ExcludeMissing fun id(id: JsonField) = apply { this.id = id }
/** The status of the Inbound Check Deposit. */
fun status(status: Status) = status(JsonField.of(status))
/** The status of the Inbound Check Deposit. */
@JsonProperty("status")
@ExcludeMissing
fun status(status: JsonField) = apply { this.status = status }
/**
* If the deposit attempt has been accepted, the identifier of the Transaction object
* created as a result of the successful deposit.
*/
fun transactionId(transactionId: String) = transactionId(JsonField.of(transactionId))
/**
* If the deposit attempt has been accepted, the identifier of the Transaction object
* created as a result of the successful deposit.
*/
@JsonProperty("transaction_id")
@ExcludeMissing
fun transactionId(transactionId: JsonField) = apply {
this.transactionId = transactionId
}
/**
* A constant representing the object's type. For this resource it will always be
* `inbound_check_deposit`.
*/
fun type(type: Type) = type(JsonField.of(type))
/**
* A constant representing the object's type. For this resource it will always be
* `inbound_check_deposit`.
*/
@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(): InboundCheckDeposit =
InboundCheckDeposit(
acceptedAt,
accountId,
accountNumberId,
amount,
backImageFileId,
bankOfFirstDepositRoutingNumber,
checkNumber,
checkTransferId,
createdAt,
currency,
declinedAt,
declinedTransactionId,
depositReturn,
frontImageFileId,
id,
status,
transactionId,
type,
additionalProperties.toUnmodifiable(),
)
}
class Currency
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Currency && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val CAD = Currency(JsonField.of("CAD"))
@JvmField val CHF = Currency(JsonField.of("CHF"))
@JvmField val EUR = Currency(JsonField.of("EUR"))
@JvmField val GBP = Currency(JsonField.of("GBP"))
@JvmField val JPY = Currency(JsonField.of("JPY"))
@JvmField val USD = Currency(JsonField.of("USD"))
@JvmStatic fun of(value: String) = Currency(JsonField.of(value))
}
enum class Known {
CAD,
CHF,
EUR,
GBP,
JPY,
USD,
}
enum class Value {
CAD,
CHF,
EUR,
GBP,
JPY,
USD,
_UNKNOWN,
}
fun value(): Value =
when (this) {
CAD -> Value.CAD
CHF -> Value.CHF
EUR -> Value.EUR
GBP -> Value.GBP
JPY -> Value.JPY
USD -> Value.USD
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
CAD -> Known.CAD
CHF -> Known.CHF
EUR -> Known.EUR
GBP -> Known.GBP
JPY -> Known.JPY
USD -> Known.USD
else -> throw IncreaseInvalidDataException("Unknown Currency: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
/** If you requested a return of this deposit, this will contain details of the return. */
@JsonDeserialize(builder = DepositReturn.Builder::class)
@NoAutoDetect
class DepositReturn
private constructor(
private val reason: JsonField,
private val returnedAt: JsonField,
private val transactionId: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/** The reason the deposit was returned. */
fun reason(): Reason = reason.getRequired("reason")
/** The time at which the deposit was returned. */
fun returnedAt(): OffsetDateTime = returnedAt.getRequired("returned_at")
/** The id of the transaction for the returned deposit. */
fun transactionId(): String = transactionId.getRequired("transaction_id")
/** The reason the deposit was returned. */
@JsonProperty("reason") @ExcludeMissing fun _reason() = reason
/** The time at which the deposit was returned. */
@JsonProperty("returned_at") @ExcludeMissing fun _returnedAt() = returnedAt
/** The id of the transaction for the returned deposit. */
@JsonProperty("transaction_id") @ExcludeMissing fun _transactionId() = transactionId
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): DepositReturn = apply {
if (!validated) {
reason()
returnedAt()
transactionId()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is DepositReturn &&
this.reason == other.reason &&
this.returnedAt == other.returnedAt &&
this.transactionId == other.transactionId &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
reason,
returnedAt,
transactionId,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"DepositReturn{reason=$reason, returnedAt=$returnedAt, transactionId=$transactionId, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var reason: JsonField = JsonMissing.of()
private var returnedAt: JsonField = JsonMissing.of()
private var transactionId: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(depositReturn: DepositReturn) = apply {
this.reason = depositReturn.reason
this.returnedAt = depositReturn.returnedAt
this.transactionId = depositReturn.transactionId
additionalProperties(depositReturn.additionalProperties)
}
/** The reason the deposit was returned. */
fun reason(reason: Reason) = reason(JsonField.of(reason))
/** The reason the deposit was returned. */
@JsonProperty("reason")
@ExcludeMissing
fun reason(reason: JsonField) = apply { this.reason = reason }
/** The time at which the deposit was returned. */
fun returnedAt(returnedAt: OffsetDateTime) = returnedAt(JsonField.of(returnedAt))
/** The time at which the deposit was returned. */
@JsonProperty("returned_at")
@ExcludeMissing
fun returnedAt(returnedAt: JsonField) = apply {
this.returnedAt = returnedAt
}
/** The id of the transaction for the returned deposit. */
fun transactionId(transactionId: String) = transactionId(JsonField.of(transactionId))
/** The id of the transaction for the returned deposit. */
@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(): DepositReturn =
DepositReturn(
reason,
returnedAt,
transactionId,
additionalProperties.toUnmodifiable(),
)
}
class Reason
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Reason && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val ALTERED_OR_FICTITIOUS = Reason(JsonField.of("altered_or_fictitious"))
@JvmField val NOT_AUTHORIZED = Reason(JsonField.of("not_authorized"))
@JvmField val DUPLICATE_PRESENTMENT = Reason(JsonField.of("duplicate_presentment"))
@JvmField val ENDORSEMENT_MISSING = Reason(JsonField.of("endorsement_missing"))
@JvmField val ENDORSEMENT_IRREGULAR = Reason(JsonField.of("endorsement_irregular"))
@JvmStatic fun of(value: String) = Reason(JsonField.of(value))
}
enum class Known {
ALTERED_OR_FICTITIOUS,
NOT_AUTHORIZED,
DUPLICATE_PRESENTMENT,
ENDORSEMENT_MISSING,
ENDORSEMENT_IRREGULAR,
}
enum class Value {
ALTERED_OR_FICTITIOUS,
NOT_AUTHORIZED,
DUPLICATE_PRESENTMENT,
ENDORSEMENT_MISSING,
ENDORSEMENT_IRREGULAR,
_UNKNOWN,
}
fun value(): Value =
when (this) {
ALTERED_OR_FICTITIOUS -> Value.ALTERED_OR_FICTITIOUS
NOT_AUTHORIZED -> Value.NOT_AUTHORIZED
DUPLICATE_PRESENTMENT -> Value.DUPLICATE_PRESENTMENT
ENDORSEMENT_MISSING -> Value.ENDORSEMENT_MISSING
ENDORSEMENT_IRREGULAR -> Value.ENDORSEMENT_IRREGULAR
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
ALTERED_OR_FICTITIOUS -> Known.ALTERED_OR_FICTITIOUS
NOT_AUTHORIZED -> Known.NOT_AUTHORIZED
DUPLICATE_PRESENTMENT -> Known.DUPLICATE_PRESENTMENT
ENDORSEMENT_MISSING -> Known.ENDORSEMENT_MISSING
ENDORSEMENT_IRREGULAR -> Known.ENDORSEMENT_IRREGULAR
else -> throw IncreaseInvalidDataException("Unknown Reason: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
}
class Status
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Status && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val PENDING = Status(JsonField.of("pending"))
@JvmField val ACCEPTED = Status(JsonField.of("accepted"))
@JvmField val DECLINED = Status(JsonField.of("declined"))
@JvmField val RETURNED = Status(JsonField.of("returned"))
@JvmField val REQUIRES_ATTENTION = Status(JsonField.of("requires_attention"))
@JvmStatic fun of(value: String) = Status(JsonField.of(value))
}
enum class Known {
PENDING,
ACCEPTED,
DECLINED,
RETURNED,
REQUIRES_ATTENTION,
}
enum class Value {
PENDING,
ACCEPTED,
DECLINED,
RETURNED,
REQUIRES_ATTENTION,
_UNKNOWN,
}
fun value(): Value =
when (this) {
PENDING -> Value.PENDING
ACCEPTED -> Value.ACCEPTED
DECLINED -> Value.DECLINED
RETURNED -> Value.RETURNED
REQUIRES_ATTENTION -> Value.REQUIRES_ATTENTION
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
PENDING -> Known.PENDING
ACCEPTED -> Known.ACCEPTED
DECLINED -> Known.DECLINED
RETURNED -> Known.RETURNED
REQUIRES_ATTENTION -> Known.REQUIRES_ATTENTION
else -> throw IncreaseInvalidDataException("Unknown Status: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
class Type
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Type && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val INBOUND_CHECK_DEPOSIT = Type(JsonField.of("inbound_check_deposit"))
@JvmStatic fun of(value: String) = Type(JsonField.of(value))
}
enum class Known {
INBOUND_CHECK_DEPOSIT,
}
enum class Value {
INBOUND_CHECK_DEPOSIT,
_UNKNOWN,
}
fun value(): Value =
when (this) {
INBOUND_CHECK_DEPOSIT -> Value.INBOUND_CHECK_DEPOSIT
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
INBOUND_CHECK_DEPOSIT -> Known.INBOUND_CHECK_DEPOSIT
else -> throw IncreaseInvalidDataException("Unknown Type: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
}