com.increase.api.models.ExternalAccount.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
// 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
/**
* External Accounts represent accounts at financial institutions other than Increase. You can use
* this API to store their details for reuse.
*/
@JsonDeserialize(builder = ExternalAccount.Builder::class)
@NoAutoDetect
class ExternalAccount
private constructor(
private val accountHolder: JsonField,
private val accountNumber: JsonField,
private val createdAt: JsonField,
private val description: JsonField,
private val funding: JsonField,
private val id: JsonField,
private val idempotencyKey: JsonField,
private val routingNumber: JsonField,
private val status: JsonField,
private val type: JsonField,
private val verificationStatus: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/** The type of entity that owns the External Account. */
fun accountHolder(): AccountHolder = accountHolder.getRequired("account_holder")
/** The destination account number. */
fun accountNumber(): String = accountNumber.getRequired("account_number")
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the External
* Account was created.
*/
fun createdAt(): OffsetDateTime = createdAt.getRequired("created_at")
/** The External Account's description for display purposes. */
fun description(): String = description.getRequired("description")
/** The type of the account to which the transfer will be sent. */
fun funding(): Funding = funding.getRequired("funding")
/** The External Account's identifier. */
fun id(): String = id.getRequired("id")
/**
* The idempotency key you chose for this object. This value is unique across Increase and is
* used to ensure that a request is only processed once. Learn more about
* [idempotency](https://increase.com/documentation/idempotency-keys).
*/
fun idempotencyKey(): Optional =
Optional.ofNullable(idempotencyKey.getNullable("idempotency_key"))
/** The American Bankers' Association (ABA) Routing Transit Number (RTN). */
fun routingNumber(): String = routingNumber.getRequired("routing_number")
/** The External Account's status. */
fun status(): Status = status.getRequired("status")
/**
* A constant representing the object's type. For this resource it will always be
* `external_account`.
*/
fun type(): Type = type.getRequired("type")
/** If you have verified ownership of the External Account. */
fun verificationStatus(): VerificationStatus =
verificationStatus.getRequired("verification_status")
/** The type of entity that owns the External Account. */
@JsonProperty("account_holder") @ExcludeMissing fun _accountHolder() = accountHolder
/** The destination account number. */
@JsonProperty("account_number") @ExcludeMissing fun _accountNumber() = accountNumber
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the External
* Account was created.
*/
@JsonProperty("created_at") @ExcludeMissing fun _createdAt() = createdAt
/** The External Account's description for display purposes. */
@JsonProperty("description") @ExcludeMissing fun _description() = description
/** The type of the account to which the transfer will be sent. */
@JsonProperty("funding") @ExcludeMissing fun _funding() = funding
/** The External Account's identifier. */
@JsonProperty("id") @ExcludeMissing fun _id() = id
/**
* The idempotency key you chose for this object. This value is unique across Increase and is
* used to ensure that a request is only processed once. Learn more about
* [idempotency](https://increase.com/documentation/idempotency-keys).
*/
@JsonProperty("idempotency_key") @ExcludeMissing fun _idempotencyKey() = idempotencyKey
/** The American Bankers' Association (ABA) Routing Transit Number (RTN). */
@JsonProperty("routing_number") @ExcludeMissing fun _routingNumber() = routingNumber
/** The External Account's status. */
@JsonProperty("status") @ExcludeMissing fun _status() = status
/**
* A constant representing the object's type. For this resource it will always be
* `external_account`.
*/
@JsonProperty("type") @ExcludeMissing fun _type() = type
/** If you have verified ownership of the External Account. */
@JsonProperty("verification_status")
@ExcludeMissing
fun _verificationStatus() = verificationStatus
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): ExternalAccount = apply {
if (!validated) {
accountHolder()
accountNumber()
createdAt()
description()
funding()
id()
idempotencyKey()
routingNumber()
status()
type()
verificationStatus()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is ExternalAccount &&
this.accountHolder == other.accountHolder &&
this.accountNumber == other.accountNumber &&
this.createdAt == other.createdAt &&
this.description == other.description &&
this.funding == other.funding &&
this.id == other.id &&
this.idempotencyKey == other.idempotencyKey &&
this.routingNumber == other.routingNumber &&
this.status == other.status &&
this.type == other.type &&
this.verificationStatus == other.verificationStatus &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
accountHolder,
accountNumber,
createdAt,
description,
funding,
id,
idempotencyKey,
routingNumber,
status,
type,
verificationStatus,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"ExternalAccount{accountHolder=$accountHolder, accountNumber=$accountNumber, createdAt=$createdAt, description=$description, funding=$funding, id=$id, idempotencyKey=$idempotencyKey, routingNumber=$routingNumber, status=$status, type=$type, verificationStatus=$verificationStatus, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var accountHolder: JsonField = JsonMissing.of()
private var accountNumber: JsonField = JsonMissing.of()
private var createdAt: JsonField = JsonMissing.of()
private var description: JsonField = JsonMissing.of()
private var funding: JsonField = JsonMissing.of()
private var id: JsonField = JsonMissing.of()
private var idempotencyKey: JsonField = JsonMissing.of()
private var routingNumber: JsonField = JsonMissing.of()
private var status: JsonField = JsonMissing.of()
private var type: JsonField = JsonMissing.of()
private var verificationStatus: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(externalAccount: ExternalAccount) = apply {
this.accountHolder = externalAccount.accountHolder
this.accountNumber = externalAccount.accountNumber
this.createdAt = externalAccount.createdAt
this.description = externalAccount.description
this.funding = externalAccount.funding
this.id = externalAccount.id
this.idempotencyKey = externalAccount.idempotencyKey
this.routingNumber = externalAccount.routingNumber
this.status = externalAccount.status
this.type = externalAccount.type
this.verificationStatus = externalAccount.verificationStatus
additionalProperties(externalAccount.additionalProperties)
}
/** The type of entity that owns the External Account. */
fun accountHolder(accountHolder: AccountHolder) = accountHolder(JsonField.of(accountHolder))
/** The type of entity that owns the External Account. */
@JsonProperty("account_holder")
@ExcludeMissing
fun accountHolder(accountHolder: JsonField) = apply {
this.accountHolder = accountHolder
}
/** The destination account number. */
fun accountNumber(accountNumber: String) = accountNumber(JsonField.of(accountNumber))
/** The destination account number. */
@JsonProperty("account_number")
@ExcludeMissing
fun accountNumber(accountNumber: JsonField) = apply {
this.accountNumber = accountNumber
}
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the
* External Account 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
* External Account was created.
*/
@JsonProperty("created_at")
@ExcludeMissing
fun createdAt(createdAt: JsonField) = apply { this.createdAt = createdAt }
/** The External Account's description for display purposes. */
fun description(description: String) = description(JsonField.of(description))
/** The External Account's description for display purposes. */
@JsonProperty("description")
@ExcludeMissing
fun description(description: JsonField) = apply { this.description = description }
/** The type of the account to which the transfer will be sent. */
fun funding(funding: Funding) = funding(JsonField.of(funding))
/** The type of the account to which the transfer will be sent. */
@JsonProperty("funding")
@ExcludeMissing
fun funding(funding: JsonField) = apply { this.funding = funding }
/** The External Account's identifier. */
fun id(id: String) = id(JsonField.of(id))
/** The External Account's identifier. */
@JsonProperty("id") @ExcludeMissing fun id(id: JsonField) = apply { this.id = id }
/**
* The idempotency key you chose for this object. This value is unique across Increase and
* is used to ensure that a request is only processed once. Learn more about
* [idempotency](https://increase.com/documentation/idempotency-keys).
*/
fun idempotencyKey(idempotencyKey: String) = idempotencyKey(JsonField.of(idempotencyKey))
/**
* The idempotency key you chose for this object. This value is unique across Increase and
* is used to ensure that a request is only processed once. Learn more about
* [idempotency](https://increase.com/documentation/idempotency-keys).
*/
@JsonProperty("idempotency_key")
@ExcludeMissing
fun idempotencyKey(idempotencyKey: JsonField) = apply {
this.idempotencyKey = idempotencyKey
}
/** The American Bankers' Association (ABA) Routing Transit Number (RTN). */
fun routingNumber(routingNumber: String) = routingNumber(JsonField.of(routingNumber))
/** The American Bankers' Association (ABA) Routing Transit Number (RTN). */
@JsonProperty("routing_number")
@ExcludeMissing
fun routingNumber(routingNumber: JsonField) = apply {
this.routingNumber = routingNumber
}
/** The External Account's status. */
fun status(status: Status) = status(JsonField.of(status))
/** The External Account's status. */
@JsonProperty("status")
@ExcludeMissing
fun status(status: JsonField) = apply { this.status = status }
/**
* A constant representing the object's type. For this resource it will always be
* `external_account`.
*/
fun type(type: Type) = type(JsonField.of(type))
/**
* A constant representing the object's type. For this resource it will always be
* `external_account`.
*/
@JsonProperty("type")
@ExcludeMissing
fun type(type: JsonField) = apply { this.type = type }
/** If you have verified ownership of the External Account. */
fun verificationStatus(verificationStatus: VerificationStatus) =
verificationStatus(JsonField.of(verificationStatus))
/** If you have verified ownership of the External Account. */
@JsonProperty("verification_status")
@ExcludeMissing
fun verificationStatus(verificationStatus: JsonField) = apply {
this.verificationStatus = verificationStatus
}
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(): ExternalAccount =
ExternalAccount(
accountHolder,
accountNumber,
createdAt,
description,
funding,
id,
idempotencyKey,
routingNumber,
status,
type,
verificationStatus,
additionalProperties.toUnmodifiable(),
)
}
class AccountHolder
@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 AccountHolder && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val BUSINESS = AccountHolder(JsonField.of("business"))
@JvmField val INDIVIDUAL = AccountHolder(JsonField.of("individual"))
@JvmField val UNKNOWN = AccountHolder(JsonField.of("unknown"))
@JvmStatic fun of(value: String) = AccountHolder(JsonField.of(value))
}
enum class Known {
BUSINESS,
INDIVIDUAL,
UNKNOWN,
}
enum class Value {
BUSINESS,
INDIVIDUAL,
UNKNOWN,
_UNKNOWN,
}
fun value(): Value =
when (this) {
BUSINESS -> Value.BUSINESS
INDIVIDUAL -> Value.INDIVIDUAL
UNKNOWN -> Value.UNKNOWN
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
BUSINESS -> Known.BUSINESS
INDIVIDUAL -> Known.INDIVIDUAL
UNKNOWN -> Known.UNKNOWN
else -> throw IncreaseInvalidDataException("Unknown AccountHolder: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
class Funding
@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 Funding && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val CHECKING = Funding(JsonField.of("checking"))
@JvmField val SAVINGS = Funding(JsonField.of("savings"))
@JvmField val OTHER = Funding(JsonField.of("other"))
@JvmStatic fun of(value: String) = Funding(JsonField.of(value))
}
enum class Known {
CHECKING,
SAVINGS,
OTHER,
}
enum class Value {
CHECKING,
SAVINGS,
OTHER,
_UNKNOWN,
}
fun value(): Value =
when (this) {
CHECKING -> Value.CHECKING
SAVINGS -> Value.SAVINGS
OTHER -> Value.OTHER
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
CHECKING -> Known.CHECKING
SAVINGS -> Known.SAVINGS
OTHER -> Known.OTHER
else -> throw IncreaseInvalidDataException("Unknown Funding: $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 ACTIVE = Status(JsonField.of("active"))
@JvmField val ARCHIVED = Status(JsonField.of("archived"))
@JvmStatic fun of(value: String) = Status(JsonField.of(value))
}
enum class Known {
ACTIVE,
ARCHIVED,
}
enum class Value {
ACTIVE,
ARCHIVED,
_UNKNOWN,
}
fun value(): Value =
when (this) {
ACTIVE -> Value.ACTIVE
ARCHIVED -> Value.ARCHIVED
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
ACTIVE -> Known.ACTIVE
ARCHIVED -> Known.ARCHIVED
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 EXTERNAL_ACCOUNT = Type(JsonField.of("external_account"))
@JvmStatic fun of(value: String) = Type(JsonField.of(value))
}
enum class Known {
EXTERNAL_ACCOUNT,
}
enum class Value {
EXTERNAL_ACCOUNT,
_UNKNOWN,
}
fun value(): Value =
when (this) {
EXTERNAL_ACCOUNT -> Value.EXTERNAL_ACCOUNT
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
EXTERNAL_ACCOUNT -> Known.EXTERNAL_ACCOUNT
else -> throw IncreaseInvalidDataException("Unknown Type: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
class VerificationStatus
@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 VerificationStatus && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val UNVERIFIED = VerificationStatus(JsonField.of("unverified"))
@JvmField val PENDING = VerificationStatus(JsonField.of("pending"))
@JvmField val VERIFIED = VerificationStatus(JsonField.of("verified"))
@JvmStatic fun of(value: String) = VerificationStatus(JsonField.of(value))
}
enum class Known {
UNVERIFIED,
PENDING,
VERIFIED,
}
enum class Value {
UNVERIFIED,
PENDING,
VERIFIED,
_UNKNOWN,
}
fun value(): Value =
when (this) {
UNVERIFIED -> Value.UNVERIFIED
PENDING -> Value.PENDING
VERIFIED -> Value.VERIFIED
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
UNVERIFIED -> Known.UNVERIFIED
PENDING -> Known.PENDING
VERIFIED -> Known.VERIFIED
else -> throw IncreaseInvalidDataException("Unknown VerificationStatus: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
}