com.lithic.api.models.FinancialAccount.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lithic-kotlin-core Show documentation
The Lithic Developer API is designed to provide a predictable programmatic interface for accessing your Lithic account through an API and transaction webhooks. Note that your API key is a secret and should be treated as such. Don't share it with anyone, including us. We will never ask you for it.
The newest version!
// File generated from our OpenAPI spec by Stainless.

package com.lithic.api.models

import com.fasterxml.jackson.annotation.JsonAnyGetter
import com.fasterxml.jackson.annotation.JsonAnySetter
import com.fasterxml.jackson.annotation.JsonCreator
import com.fasterxml.jackson.annotation.JsonProperty
import com.fasterxml.jackson.databind.annotation.JsonDeserialize
import com.lithic.api.core.Enum
import com.lithic.api.core.ExcludeMissing
import com.lithic.api.core.JsonField
import com.lithic.api.core.JsonMissing
import com.lithic.api.core.JsonValue
import com.lithic.api.core.NoAutoDetect
import com.lithic.api.core.toImmutable
import com.lithic.api.errors.LithicInvalidDataException
import java.time.OffsetDateTime
import java.util.Objects

@JsonDeserialize(builder = FinancialAccount.Builder::class)
@NoAutoDetect
class FinancialAccount
private constructor(
    private val token: JsonField,
    private val created: JsonField,
    private val updated: JsonField,
    private val type: JsonField,
    private val routingNumber: JsonField,
    private val accountNumber: JsonField,
    private val nickname: JsonField,
    private val accountToken: JsonField,
    private val isForBenefitOf: JsonField,
    private val creditConfiguration: JsonField,
    private val additionalProperties: Map,
) {

    private var validated: Boolean = false

    /** Globally unique identifier for the account */
    fun token(): String = token.getRequired("token")

    fun created(): OffsetDateTime = created.getRequired("created")

    fun updated(): OffsetDateTime = updated.getRequired("updated")

    fun type(): Type = type.getRequired("type")

    fun routingNumber(): String? = routingNumber.getNullable("routing_number")

    fun accountNumber(): String? = accountNumber.getNullable("account_number")

    fun nickname(): String? = nickname.getNullable("nickname")

    fun accountToken(): String? = accountToken.getNullable("account_token")

    /** Whether financial account is for the benefit of another entity */
    fun isForBenefitOf(): Boolean = isForBenefitOf.getRequired("is_for_benefit_of")

    fun creditConfiguration(): FinancialAccountCreditConfig? =
        creditConfiguration.getNullable("credit_configuration")

    /** Globally unique identifier for the account */
    @JsonProperty("token") @ExcludeMissing fun _token() = token

    @JsonProperty("created") @ExcludeMissing fun _created() = created

    @JsonProperty("updated") @ExcludeMissing fun _updated() = updated

    @JsonProperty("type") @ExcludeMissing fun _type() = type

    @JsonProperty("routing_number") @ExcludeMissing fun _routingNumber() = routingNumber

    @JsonProperty("account_number") @ExcludeMissing fun _accountNumber() = accountNumber

    @JsonProperty("nickname") @ExcludeMissing fun _nickname() = nickname

    @JsonProperty("account_token") @ExcludeMissing fun _accountToken() = accountToken

    /** Whether financial account is for the benefit of another entity */
    @JsonProperty("is_for_benefit_of") @ExcludeMissing fun _isForBenefitOf() = isForBenefitOf

    @JsonProperty("credit_configuration")
    @ExcludeMissing
    fun _creditConfiguration() = creditConfiguration

    @JsonAnyGetter
    @ExcludeMissing
    fun _additionalProperties(): Map = additionalProperties

    fun validate(): FinancialAccount = apply {
        if (!validated) {
            token()
            created()
            updated()
            type()
            routingNumber()
            accountNumber()
            nickname()
            accountToken()
            isForBenefitOf()
            creditConfiguration()?.validate()
            validated = true
        }
    }

    fun toBuilder() = Builder().from(this)

    companion object {

        fun builder() = Builder()
    }

    class Builder {

        private var token: JsonField = JsonMissing.of()
        private var created: JsonField = JsonMissing.of()
        private var updated: JsonField = JsonMissing.of()
        private var type: JsonField = JsonMissing.of()
        private var routingNumber: JsonField = JsonMissing.of()
        private var accountNumber: JsonField = JsonMissing.of()
        private var nickname: JsonField = JsonMissing.of()
        private var accountToken: JsonField = JsonMissing.of()
        private var isForBenefitOf: JsonField = JsonMissing.of()
        private var creditConfiguration: JsonField = JsonMissing.of()
        private var additionalProperties: MutableMap = mutableMapOf()

        internal fun from(financialAccount: FinancialAccount) = apply {
            this.token = financialAccount.token
            this.created = financialAccount.created
            this.updated = financialAccount.updated
            this.type = financialAccount.type
            this.routingNumber = financialAccount.routingNumber
            this.accountNumber = financialAccount.accountNumber
            this.nickname = financialAccount.nickname
            this.accountToken = financialAccount.accountToken
            this.isForBenefitOf = financialAccount.isForBenefitOf
            this.creditConfiguration = financialAccount.creditConfiguration
            additionalProperties(financialAccount.additionalProperties)
        }

        /** Globally unique identifier for the account */
        fun token(token: String) = token(JsonField.of(token))

        /** Globally unique identifier for the account */
        @JsonProperty("token")
        @ExcludeMissing
        fun token(token: JsonField) = apply { this.token = token }

        fun created(created: OffsetDateTime) = created(JsonField.of(created))

        @JsonProperty("created")
        @ExcludeMissing
        fun created(created: JsonField) = apply { this.created = created }

        fun updated(updated: OffsetDateTime) = updated(JsonField.of(updated))

        @JsonProperty("updated")
        @ExcludeMissing
        fun updated(updated: JsonField) = apply { this.updated = updated }

        fun type(type: Type) = type(JsonField.of(type))

        @JsonProperty("type")
        @ExcludeMissing
        fun type(type: JsonField) = apply { this.type = type }

        fun routingNumber(routingNumber: String) = routingNumber(JsonField.of(routingNumber))

        @JsonProperty("routing_number")
        @ExcludeMissing
        fun routingNumber(routingNumber: JsonField) = apply {
            this.routingNumber = routingNumber
        }

        fun accountNumber(accountNumber: String) = accountNumber(JsonField.of(accountNumber))

        @JsonProperty("account_number")
        @ExcludeMissing
        fun accountNumber(accountNumber: JsonField) = apply {
            this.accountNumber = accountNumber
        }

        fun nickname(nickname: String) = nickname(JsonField.of(nickname))

        @JsonProperty("nickname")
        @ExcludeMissing
        fun nickname(nickname: JsonField) = apply { this.nickname = nickname }

        fun accountToken(accountToken: String) = accountToken(JsonField.of(accountToken))

        @JsonProperty("account_token")
        @ExcludeMissing
        fun accountToken(accountToken: JsonField) = apply {
            this.accountToken = accountToken
        }

        /** Whether financial account is for the benefit of another entity */
        fun isForBenefitOf(isForBenefitOf: Boolean) = isForBenefitOf(JsonField.of(isForBenefitOf))

        /** Whether financial account is for the benefit of another entity */
        @JsonProperty("is_for_benefit_of")
        @ExcludeMissing
        fun isForBenefitOf(isForBenefitOf: JsonField) = apply {
            this.isForBenefitOf = isForBenefitOf
        }

        fun creditConfiguration(creditConfiguration: FinancialAccountCreditConfig) =
            creditConfiguration(JsonField.of(creditConfiguration))

        @JsonProperty("credit_configuration")
        @ExcludeMissing
        fun creditConfiguration(creditConfiguration: JsonField) =
            apply {
                this.creditConfiguration = creditConfiguration
            }

        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(): FinancialAccount =
            FinancialAccount(
                token,
                created,
                updated,
                type,
                routingNumber,
                accountNumber,
                nickname,
                accountToken,
                isForBenefitOf,
                creditConfiguration,
                additionalProperties.toImmutable(),
            )
    }

    @JsonDeserialize(builder = FinancialAccountCreditConfig.Builder::class)
    @NoAutoDetect
    class FinancialAccountCreditConfig
    private constructor(
        private val creditLimit: JsonField,
        private val externalBankAccountToken: JsonField,
        private val creditProductToken: JsonField,
        private val tier: JsonField,
        private val isSpendBlocked: JsonField,
        private val financialAccountState: JsonField,
        private val chargedOffReason: JsonField,
        private val additionalProperties: Map,
    ) {

        private var validated: Boolean = false

        fun creditLimit(): Long? = creditLimit.getNullable("credit_limit")

        fun externalBankAccountToken(): String? =
            externalBankAccountToken.getNullable("external_bank_account_token")

        /** Globally unique identifier for the credit product */
        fun creditProductToken(): String? = creditProductToken.getNullable("credit_product_token")

        /** Tier assigned to the financial account */
        fun tier(): String? = tier.getNullable("tier")

        fun isSpendBlocked(): Boolean = isSpendBlocked.getRequired("is_spend_blocked")

        /** State of the financial account */
        fun financialAccountState(): FinancialAccountState? =
            financialAccountState.getNullable("financial_account_state")

        /** Reason for the financial account being marked as Charged Off */
        fun chargedOffReason(): ChargedOffReason? =
            chargedOffReason.getNullable("charged_off_reason")

        @JsonProperty("credit_limit") @ExcludeMissing fun _creditLimit() = creditLimit

        @JsonProperty("external_bank_account_token")
        @ExcludeMissing
        fun _externalBankAccountToken() = externalBankAccountToken

        /** Globally unique identifier for the credit product */
        @JsonProperty("credit_product_token")
        @ExcludeMissing
        fun _creditProductToken() = creditProductToken

        /** Tier assigned to the financial account */
        @JsonProperty("tier") @ExcludeMissing fun _tier() = tier

        @JsonProperty("is_spend_blocked") @ExcludeMissing fun _isSpendBlocked() = isSpendBlocked

        /** State of the financial account */
        @JsonProperty("financial_account_state")
        @ExcludeMissing
        fun _financialAccountState() = financialAccountState

        /** Reason for the financial account being marked as Charged Off */
        @JsonProperty("charged_off_reason")
        @ExcludeMissing
        fun _chargedOffReason() = chargedOffReason

        @JsonAnyGetter
        @ExcludeMissing
        fun _additionalProperties(): Map = additionalProperties

        fun validate(): FinancialAccountCreditConfig = apply {
            if (!validated) {
                creditLimit()
                externalBankAccountToken()
                creditProductToken()
                tier()
                isSpendBlocked()
                financialAccountState()
                chargedOffReason()
                validated = true
            }
        }

        fun toBuilder() = Builder().from(this)

        companion object {

            fun builder() = Builder()
        }

        class Builder {

            private var creditLimit: JsonField = JsonMissing.of()
            private var externalBankAccountToken: JsonField = JsonMissing.of()
            private var creditProductToken: JsonField = JsonMissing.of()
            private var tier: JsonField = JsonMissing.of()
            private var isSpendBlocked: JsonField = JsonMissing.of()
            private var financialAccountState: JsonField = JsonMissing.of()
            private var chargedOffReason: JsonField = JsonMissing.of()
            private var additionalProperties: MutableMap = mutableMapOf()

            internal fun from(financialAccountCreditConfig: FinancialAccountCreditConfig) = apply {
                this.creditLimit = financialAccountCreditConfig.creditLimit
                this.externalBankAccountToken =
                    financialAccountCreditConfig.externalBankAccountToken
                this.creditProductToken = financialAccountCreditConfig.creditProductToken
                this.tier = financialAccountCreditConfig.tier
                this.isSpendBlocked = financialAccountCreditConfig.isSpendBlocked
                this.financialAccountState = financialAccountCreditConfig.financialAccountState
                this.chargedOffReason = financialAccountCreditConfig.chargedOffReason
                additionalProperties(financialAccountCreditConfig.additionalProperties)
            }

            fun creditLimit(creditLimit: Long) = creditLimit(JsonField.of(creditLimit))

            @JsonProperty("credit_limit")
            @ExcludeMissing
            fun creditLimit(creditLimit: JsonField) = apply { this.creditLimit = creditLimit }

            fun externalBankAccountToken(externalBankAccountToken: String) =
                externalBankAccountToken(JsonField.of(externalBankAccountToken))

            @JsonProperty("external_bank_account_token")
            @ExcludeMissing
            fun externalBankAccountToken(externalBankAccountToken: JsonField) = apply {
                this.externalBankAccountToken = externalBankAccountToken
            }

            /** Globally unique identifier for the credit product */
            fun creditProductToken(creditProductToken: String) =
                creditProductToken(JsonField.of(creditProductToken))

            /** Globally unique identifier for the credit product */
            @JsonProperty("credit_product_token")
            @ExcludeMissing
            fun creditProductToken(creditProductToken: JsonField) = apply {
                this.creditProductToken = creditProductToken
            }

            /** Tier assigned to the financial account */
            fun tier(tier: String) = tier(JsonField.of(tier))

            /** Tier assigned to the financial account */
            @JsonProperty("tier")
            @ExcludeMissing
            fun tier(tier: JsonField) = apply { this.tier = tier }

            fun isSpendBlocked(isSpendBlocked: Boolean) =
                isSpendBlocked(JsonField.of(isSpendBlocked))

            @JsonProperty("is_spend_blocked")
            @ExcludeMissing
            fun isSpendBlocked(isSpendBlocked: JsonField) = apply {
                this.isSpendBlocked = isSpendBlocked
            }

            /** State of the financial account */
            fun financialAccountState(financialAccountState: FinancialAccountState) =
                financialAccountState(JsonField.of(financialAccountState))

            /** State of the financial account */
            @JsonProperty("financial_account_state")
            @ExcludeMissing
            fun financialAccountState(financialAccountState: JsonField) =
                apply {
                    this.financialAccountState = financialAccountState
                }

            /** Reason for the financial account being marked as Charged Off */
            fun chargedOffReason(chargedOffReason: ChargedOffReason) =
                chargedOffReason(JsonField.of(chargedOffReason))

            /** Reason for the financial account being marked as Charged Off */
            @JsonProperty("charged_off_reason")
            @ExcludeMissing
            fun chargedOffReason(chargedOffReason: JsonField) = apply {
                this.chargedOffReason = chargedOffReason
            }

            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(): FinancialAccountCreditConfig =
                FinancialAccountCreditConfig(
                    creditLimit,
                    externalBankAccountToken,
                    creditProductToken,
                    tier,
                    isSpendBlocked,
                    financialAccountState,
                    chargedOffReason,
                    additionalProperties.toImmutable(),
                )
        }

        class ChargedOffReason
        @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 ChargedOffReason && this.value == other.value /* spotless:on */
            }

            override fun hashCode() = value.hashCode()

            override fun toString() = value.toString()

            companion object {

                val DELINQUENT = ChargedOffReason(JsonField.of("DELINQUENT"))

                val FRAUD = ChargedOffReason(JsonField.of("FRAUD"))

                fun of(value: String) = ChargedOffReason(JsonField.of(value))
            }

            enum class Known {
                DELINQUENT,
                FRAUD,
            }

            enum class Value {
                DELINQUENT,
                FRAUD,
                _UNKNOWN,
            }

            fun value(): Value =
                when (this) {
                    DELINQUENT -> Value.DELINQUENT
                    FRAUD -> Value.FRAUD
                    else -> Value._UNKNOWN
                }

            fun known(): Known =
                when (this) {
                    DELINQUENT -> Known.DELINQUENT
                    FRAUD -> Known.FRAUD
                    else -> throw LithicInvalidDataException("Unknown ChargedOffReason: $value")
                }

            fun asString(): String = _value().asStringOrThrow()
        }

        class FinancialAccountState
        @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 FinancialAccountState && this.value == other.value /* spotless:on */
            }

            override fun hashCode() = value.hashCode()

            override fun toString() = value.toString()

            companion object {

                val PENDING = FinancialAccountState(JsonField.of("PENDING"))

                val CURRENT = FinancialAccountState(JsonField.of("CURRENT"))

                val DELINQUENT = FinancialAccountState(JsonField.of("DELINQUENT"))

                val CHARGED_OFF = FinancialAccountState(JsonField.of("CHARGED_OFF"))

                fun of(value: String) = FinancialAccountState(JsonField.of(value))
            }

            enum class Known {
                PENDING,
                CURRENT,
                DELINQUENT,
                CHARGED_OFF,
            }

            enum class Value {
                PENDING,
                CURRENT,
                DELINQUENT,
                CHARGED_OFF,
                _UNKNOWN,
            }

            fun value(): Value =
                when (this) {
                    PENDING -> Value.PENDING
                    CURRENT -> Value.CURRENT
                    DELINQUENT -> Value.DELINQUENT
                    CHARGED_OFF -> Value.CHARGED_OFF
                    else -> Value._UNKNOWN
                }

            fun known(): Known =
                when (this) {
                    PENDING -> Known.PENDING
                    CURRENT -> Known.CURRENT
                    DELINQUENT -> Known.DELINQUENT
                    CHARGED_OFF -> Known.CHARGED_OFF
                    else ->
                        throw LithicInvalidDataException("Unknown FinancialAccountState: $value")
                }

            fun asString(): String = _value().asStringOrThrow()
        }

        override fun equals(other: Any?): Boolean {
            if (this === other) {
                return true
            }

            return /* spotless:off */ other is FinancialAccountCreditConfig && this.creditLimit == other.creditLimit && this.externalBankAccountToken == other.externalBankAccountToken && this.creditProductToken == other.creditProductToken && this.tier == other.tier && this.isSpendBlocked == other.isSpendBlocked && this.financialAccountState == other.financialAccountState && this.chargedOffReason == other.chargedOffReason && this.additionalProperties == other.additionalProperties /* spotless:on */
        }

        private var hashCode: Int = 0

        override fun hashCode(): Int {
            if (hashCode == 0) {
                hashCode = /* spotless:off */ Objects.hash(creditLimit, externalBankAccountToken, creditProductToken, tier, isSpendBlocked, financialAccountState, chargedOffReason, additionalProperties) /* spotless:on */
            }
            return hashCode
        }

        override fun toString() =
            "FinancialAccountCreditConfig{creditLimit=$creditLimit, externalBankAccountToken=$externalBankAccountToken, creditProductToken=$creditProductToken, tier=$tier, isSpendBlocked=$isSpendBlocked, financialAccountState=$financialAccountState, chargedOffReason=$chargedOffReason, additionalProperties=$additionalProperties}"
    }

    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 /* spotless:off */ other is Type && this.value == other.value /* spotless:on */
        }

        override fun hashCode() = value.hashCode()

        override fun toString() = value.toString()

        companion object {

            val ISSUING = Type(JsonField.of("ISSUING"))

            val RESERVE = Type(JsonField.of("RESERVE"))

            val OPERATING = Type(JsonField.of("OPERATING"))

            fun of(value: String) = Type(JsonField.of(value))
        }

        enum class Known {
            ISSUING,
            RESERVE,
            OPERATING,
        }

        enum class Value {
            ISSUING,
            RESERVE,
            OPERATING,
            _UNKNOWN,
        }

        fun value(): Value =
            when (this) {
                ISSUING -> Value.ISSUING
                RESERVE -> Value.RESERVE
                OPERATING -> Value.OPERATING
                else -> Value._UNKNOWN
            }

        fun known(): Known =
            when (this) {
                ISSUING -> Known.ISSUING
                RESERVE -> Known.RESERVE
                OPERATING -> Known.OPERATING
                else -> throw LithicInvalidDataException("Unknown Type: $value")
            }

        fun asString(): String = _value().asStringOrThrow()
    }

    override fun equals(other: Any?): Boolean {
        if (this === other) {
            return true
        }

        return /* spotless:off */ other is FinancialAccount && this.token == other.token && this.created == other.created && this.updated == other.updated && this.type == other.type && this.routingNumber == other.routingNumber && this.accountNumber == other.accountNumber && this.nickname == other.nickname && this.accountToken == other.accountToken && this.isForBenefitOf == other.isForBenefitOf && this.creditConfiguration == other.creditConfiguration && this.additionalProperties == other.additionalProperties /* spotless:on */
    }

    private var hashCode: Int = 0

    override fun hashCode(): Int {
        if (hashCode == 0) {
            hashCode = /* spotless:off */ Objects.hash(token, created, updated, type, routingNumber, accountNumber, nickname, accountToken, isForBenefitOf, creditConfiguration, additionalProperties) /* spotless:on */
        }
        return hashCode
    }

    override fun toString() =
        "FinancialAccount{token=$token, created=$created, updated=$updated, type=$type, routingNumber=$routingNumber, accountNumber=$accountNumber, nickname=$nickname, accountToken=$accountToken, isForBenefitOf=$isForBenefitOf, creditConfiguration=$creditConfiguration, additionalProperties=$additionalProperties}"
}