com.lithic.api.models.AccountUpdateParams.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.JsonValue
import com.lithic.api.core.NoAutoDetect
import com.lithic.api.core.http.Headers
import com.lithic.api.core.http.QueryParams
import com.lithic.api.core.toImmutable
import com.lithic.api.errors.LithicInvalidDataException
import com.lithic.api.models.*
import java.util.Objects

class AccountUpdateParams
constructor(
    private val accountToken: String,
    private val dailySpendLimit: Long?,
    private val lifetimeSpendLimit: Long?,
    private val monthlySpendLimit: Long?,
    private val state: State?,
    private val verificationAddress: VerificationAddress?,
    private val additionalHeaders: Headers,
    private val additionalQueryParams: QueryParams,
    private val additionalBodyProperties: Map,
) {

    fun accountToken(): String = accountToken

    fun dailySpendLimit(): Long? = dailySpendLimit

    fun lifetimeSpendLimit(): Long? = lifetimeSpendLimit

    fun monthlySpendLimit(): Long? = monthlySpendLimit

    fun state(): State? = state

    fun verificationAddress(): VerificationAddress? = verificationAddress

    internal fun getBody(): AccountUpdateBody {
        return AccountUpdateBody(
            dailySpendLimit,
            lifetimeSpendLimit,
            monthlySpendLimit,
            state,
            verificationAddress,
            additionalBodyProperties,
        )
    }

    internal fun getHeaders(): Headers = additionalHeaders

    internal fun getQueryParams(): QueryParams = additionalQueryParams

    fun getPathParam(index: Int): String {
        return when (index) {
            0 -> accountToken
            else -> ""
        }
    }

    @JsonDeserialize(builder = AccountUpdateBody.Builder::class)
    @NoAutoDetect
    class AccountUpdateBody
    internal constructor(
        private val dailySpendLimit: Long?,
        private val lifetimeSpendLimit: Long?,
        private val monthlySpendLimit: Long?,
        private val state: State?,
        private val verificationAddress: VerificationAddress?,
        private val additionalProperties: Map,
    ) {

        /**
         * Amount (in cents) for the account's daily spend limit. By default the daily spend limit
         * is set to $1,250.
         */
        @JsonProperty("daily_spend_limit") fun dailySpendLimit(): Long? = dailySpendLimit

        /**
         * Amount (in cents) for the account's lifetime spend limit. Once this limit is reached, no
         * transactions will be accepted on any card created for this account until the limit is
         * updated. Note that a spend limit of 0 is effectively no limit, and should only be used to
         * reset or remove a prior limit. Only a limit of 1 or above will result in declined
         * transactions due to checks against the account limit. This behavior differs from the
         * daily spend limit and the monthly spend limit.
         */
        @JsonProperty("lifetime_spend_limit") fun lifetimeSpendLimit(): Long? = lifetimeSpendLimit

        /**
         * Amount (in cents) for the account's monthly spend limit. By default the monthly spend
         * limit is set to $5,000.
         */
        @JsonProperty("monthly_spend_limit") fun monthlySpendLimit(): Long? = monthlySpendLimit

        /** Account states. */
        @JsonProperty("state") fun state(): State? = state

        /**
         * Address used during Address Verification Service (AVS) checks during transactions if
         * enabled via Auth Rules. This field is deprecated as AVS checks are no longer supported by
         * Authorization Rules. The field will be removed from the schema in a future release.
         */
        @JsonProperty("verification_address")
        fun verificationAddress(): VerificationAddress? = verificationAddress

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

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

        companion object {

            fun builder() = Builder()
        }

        class Builder {

            private var dailySpendLimit: Long? = null
            private var lifetimeSpendLimit: Long? = null
            private var monthlySpendLimit: Long? = null
            private var state: State? = null
            private var verificationAddress: VerificationAddress? = null
            private var additionalProperties: MutableMap = mutableMapOf()

            internal fun from(accountUpdateBody: AccountUpdateBody) = apply {
                this.dailySpendLimit = accountUpdateBody.dailySpendLimit
                this.lifetimeSpendLimit = accountUpdateBody.lifetimeSpendLimit
                this.monthlySpendLimit = accountUpdateBody.monthlySpendLimit
                this.state = accountUpdateBody.state
                this.verificationAddress = accountUpdateBody.verificationAddress
                additionalProperties(accountUpdateBody.additionalProperties)
            }

            /**
             * Amount (in cents) for the account's daily spend limit. By default the daily spend
             * limit is set to $1,250.
             */
            @JsonProperty("daily_spend_limit")
            fun dailySpendLimit(dailySpendLimit: Long) = apply {
                this.dailySpendLimit = dailySpendLimit
            }

            /**
             * Amount (in cents) for the account's lifetime spend limit. Once this limit is reached,
             * no transactions will be accepted on any card created for this account until the limit
             * is updated. Note that a spend limit of 0 is effectively no limit, and should only be
             * used to reset or remove a prior limit. Only a limit of 1 or above will result in
             * declined transactions due to checks against the account limit. This behavior differs
             * from the daily spend limit and the monthly spend limit.
             */
            @JsonProperty("lifetime_spend_limit")
            fun lifetimeSpendLimit(lifetimeSpendLimit: Long) = apply {
                this.lifetimeSpendLimit = lifetimeSpendLimit
            }

            /**
             * Amount (in cents) for the account's monthly spend limit. By default the monthly spend
             * limit is set to $5,000.
             */
            @JsonProperty("monthly_spend_limit")
            fun monthlySpendLimit(monthlySpendLimit: Long) = apply {
                this.monthlySpendLimit = monthlySpendLimit
            }

            /** Account states. */
            @JsonProperty("state") fun state(state: State) = apply { this.state = state }

            /**
             * Address used during Address Verification Service (AVS) checks during transactions if
             * enabled via Auth Rules. This field is deprecated as AVS checks are no longer
             * supported by Authorization Rules. The field will be removed from the schema in a
             * future release.
             */
            @JsonProperty("verification_address")
            fun verificationAddress(verificationAddress: VerificationAddress) = apply {
                this.verificationAddress = verificationAddress
            }

            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(): AccountUpdateBody =
                AccountUpdateBody(
                    dailySpendLimit,
                    lifetimeSpendLimit,
                    monthlySpendLimit,
                    state,
                    verificationAddress,
                    additionalProperties.toImmutable(),
                )
        }

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

            return /* spotless:off */ other is AccountUpdateBody && this.dailySpendLimit == other.dailySpendLimit && this.lifetimeSpendLimit == other.lifetimeSpendLimit && this.monthlySpendLimit == other.monthlySpendLimit && this.state == other.state && this.verificationAddress == other.verificationAddress && this.additionalProperties == other.additionalProperties /* spotless:on */
        }

        private var hashCode: Int = 0

        override fun hashCode(): Int {
            if (hashCode == 0) {
                hashCode = /* spotless:off */ Objects.hash(dailySpendLimit, lifetimeSpendLimit, monthlySpendLimit, state, verificationAddress, additionalProperties) /* spotless:on */
            }
            return hashCode
        }

        override fun toString() =
            "AccountUpdateBody{dailySpendLimit=$dailySpendLimit, lifetimeSpendLimit=$lifetimeSpendLimit, monthlySpendLimit=$monthlySpendLimit, state=$state, verificationAddress=$verificationAddress, additionalProperties=$additionalProperties}"
    }

    fun _additionalHeaders(): Headers = additionalHeaders

    fun _additionalQueryParams(): QueryParams = additionalQueryParams

    fun _additionalBodyProperties(): Map = additionalBodyProperties

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

        return /* spotless:off */ other is AccountUpdateParams && this.accountToken == other.accountToken && this.dailySpendLimit == other.dailySpendLimit && this.lifetimeSpendLimit == other.lifetimeSpendLimit && this.monthlySpendLimit == other.monthlySpendLimit && this.state == other.state && this.verificationAddress == other.verificationAddress && this.additionalHeaders == other.additionalHeaders && this.additionalQueryParams == other.additionalQueryParams && this.additionalBodyProperties == other.additionalBodyProperties /* spotless:on */
    }

    override fun hashCode(): Int {
        return /* spotless:off */ Objects.hash(accountToken, dailySpendLimit, lifetimeSpendLimit, monthlySpendLimit, state, verificationAddress, additionalHeaders, additionalQueryParams, additionalBodyProperties) /* spotless:on */
    }

    override fun toString() =
        "AccountUpdateParams{accountToken=$accountToken, dailySpendLimit=$dailySpendLimit, lifetimeSpendLimit=$lifetimeSpendLimit, monthlySpendLimit=$monthlySpendLimit, state=$state, verificationAddress=$verificationAddress, additionalHeaders=$additionalHeaders, additionalQueryParams=$additionalQueryParams, additionalBodyProperties=$additionalBodyProperties}"

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

    companion object {

        fun builder() = Builder()
    }

    @NoAutoDetect
    class Builder {

        private var accountToken: String? = null
        private var dailySpendLimit: Long? = null
        private var lifetimeSpendLimit: Long? = null
        private var monthlySpendLimit: Long? = null
        private var state: State? = null
        private var verificationAddress: VerificationAddress? = null
        private var additionalHeaders: Headers.Builder = Headers.builder()
        private var additionalQueryParams: QueryParams.Builder = QueryParams.builder()
        private var additionalBodyProperties: MutableMap = mutableMapOf()

        internal fun from(accountUpdateParams: AccountUpdateParams) = apply {
            this.accountToken = accountUpdateParams.accountToken
            this.dailySpendLimit = accountUpdateParams.dailySpendLimit
            this.lifetimeSpendLimit = accountUpdateParams.lifetimeSpendLimit
            this.monthlySpendLimit = accountUpdateParams.monthlySpendLimit
            this.state = accountUpdateParams.state
            this.verificationAddress = accountUpdateParams.verificationAddress
            additionalHeaders(accountUpdateParams.additionalHeaders)
            additionalQueryParams(accountUpdateParams.additionalQueryParams)
            additionalBodyProperties(accountUpdateParams.additionalBodyProperties)
        }

        fun accountToken(accountToken: String) = apply { this.accountToken = accountToken }

        /**
         * Amount (in cents) for the account's daily spend limit. By default the daily spend limit
         * is set to $1,250.
         */
        fun dailySpendLimit(dailySpendLimit: Long) = apply {
            this.dailySpendLimit = dailySpendLimit
        }

        /**
         * Amount (in cents) for the account's lifetime spend limit. Once this limit is reached, no
         * transactions will be accepted on any card created for this account until the limit is
         * updated. Note that a spend limit of 0 is effectively no limit, and should only be used to
         * reset or remove a prior limit. Only a limit of 1 or above will result in declined
         * transactions due to checks against the account limit. This behavior differs from the
         * daily spend limit and the monthly spend limit.
         */
        fun lifetimeSpendLimit(lifetimeSpendLimit: Long) = apply {
            this.lifetimeSpendLimit = lifetimeSpendLimit
        }

        /**
         * Amount (in cents) for the account's monthly spend limit. By default the monthly spend
         * limit is set to $5,000.
         */
        fun monthlySpendLimit(monthlySpendLimit: Long) = apply {
            this.monthlySpendLimit = monthlySpendLimit
        }

        /** Account states. */
        fun state(state: State) = apply { this.state = state }

        /**
         * Address used during Address Verification Service (AVS) checks during transactions if
         * enabled via Auth Rules. This field is deprecated as AVS checks are no longer supported by
         * Authorization Rules. The field will be removed from the schema in a future release.
         */
        fun verificationAddress(verificationAddress: VerificationAddress) = apply {
            this.verificationAddress = verificationAddress
        }

        fun additionalHeaders(additionalHeaders: Headers) = apply {
            this.additionalHeaders.clear()
            putAllAdditionalHeaders(additionalHeaders)
        }

        fun additionalHeaders(additionalHeaders: Map>) = apply {
            this.additionalHeaders.clear()
            putAllAdditionalHeaders(additionalHeaders)
        }

        fun putAdditionalHeader(name: String, value: String) = apply {
            additionalHeaders.put(name, value)
        }

        fun putAdditionalHeaders(name: String, values: Iterable) = apply {
            additionalHeaders.put(name, values)
        }

        fun putAllAdditionalHeaders(additionalHeaders: Headers) = apply {
            this.additionalHeaders.putAll(additionalHeaders)
        }

        fun putAllAdditionalHeaders(additionalHeaders: Map>) = apply {
            this.additionalHeaders.putAll(additionalHeaders)
        }

        fun replaceAdditionalHeaders(name: String, value: String) = apply {
            additionalHeaders.replace(name, value)
        }

        fun replaceAdditionalHeaders(name: String, values: Iterable) = apply {
            additionalHeaders.replace(name, values)
        }

        fun replaceAllAdditionalHeaders(additionalHeaders: Headers) = apply {
            this.additionalHeaders.replaceAll(additionalHeaders)
        }

        fun replaceAllAdditionalHeaders(additionalHeaders: Map>) = apply {
            this.additionalHeaders.replaceAll(additionalHeaders)
        }

        fun removeAdditionalHeaders(name: String) = apply { additionalHeaders.remove(name) }

        fun removeAllAdditionalHeaders(names: Set) = apply {
            additionalHeaders.removeAll(names)
        }

        fun additionalQueryParams(additionalQueryParams: QueryParams) = apply {
            this.additionalQueryParams.clear()
            putAllAdditionalQueryParams(additionalQueryParams)
        }

        fun additionalQueryParams(additionalQueryParams: Map>) = apply {
            this.additionalQueryParams.clear()
            putAllAdditionalQueryParams(additionalQueryParams)
        }

        fun putAdditionalQueryParam(key: String, value: String) = apply {
            additionalQueryParams.put(key, value)
        }

        fun putAdditionalQueryParams(key: String, values: Iterable) = apply {
            additionalQueryParams.put(key, values)
        }

        fun putAllAdditionalQueryParams(additionalQueryParams: QueryParams) = apply {
            this.additionalQueryParams.putAll(additionalQueryParams)
        }

        fun putAllAdditionalQueryParams(additionalQueryParams: Map>) =
            apply {
                this.additionalQueryParams.putAll(additionalQueryParams)
            }

        fun replaceAdditionalQueryParams(key: String, value: String) = apply {
            additionalQueryParams.replace(key, value)
        }

        fun replaceAdditionalQueryParams(key: String, values: Iterable) = apply {
            additionalQueryParams.replace(key, values)
        }

        fun replaceAllAdditionalQueryParams(additionalQueryParams: QueryParams) = apply {
            this.additionalQueryParams.replaceAll(additionalQueryParams)
        }

        fun replaceAllAdditionalQueryParams(additionalQueryParams: Map>) =
            apply {
                this.additionalQueryParams.replaceAll(additionalQueryParams)
            }

        fun removeAdditionalQueryParams(key: String) = apply { additionalQueryParams.remove(key) }

        fun removeAllAdditionalQueryParams(keys: Set) = apply {
            additionalQueryParams.removeAll(keys)
        }

        fun additionalBodyProperties(additionalBodyProperties: Map) = apply {
            this.additionalBodyProperties.clear()
            putAllAdditionalBodyProperties(additionalBodyProperties)
        }

        fun putAdditionalBodyProperty(key: String, value: JsonValue) = apply {
            additionalBodyProperties.put(key, value)
        }

        fun putAllAdditionalBodyProperties(additionalBodyProperties: Map) =
            apply {
                this.additionalBodyProperties.putAll(additionalBodyProperties)
            }

        fun removeAdditionalBodyProperty(key: String) = apply {
            additionalBodyProperties.remove(key)
        }

        fun removeAllAdditionalBodyProperties(keys: Set) = apply {
            keys.forEach(::removeAdditionalBodyProperty)
        }

        fun build(): AccountUpdateParams =
            AccountUpdateParams(
                checkNotNull(accountToken) { "`accountToken` is required but was not set" },
                dailySpendLimit,
                lifetimeSpendLimit,
                monthlySpendLimit,
                state,
                verificationAddress,
                additionalHeaders.build(),
                additionalQueryParams.build(),
                additionalBodyProperties.toImmutable(),
            )
    }

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

        override fun hashCode() = value.hashCode()

        override fun toString() = value.toString()

        companion object {

            val ACTIVE = State(JsonField.of("ACTIVE"))

            val PAUSED = State(JsonField.of("PAUSED"))

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

        enum class Known {
            ACTIVE,
            PAUSED,
        }

        enum class Value {
            ACTIVE,
            PAUSED,
            _UNKNOWN,
        }

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

        fun known(): Known =
            when (this) {
                ACTIVE -> Known.ACTIVE
                PAUSED -> Known.PAUSED
                else -> throw LithicInvalidDataException("Unknown State: $value")
            }

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

    /**
     * Address used during Address Verification Service (AVS) checks during transactions if enabled
     * via Auth Rules. This field is deprecated as AVS checks are no longer supported by
     * Authorization Rules. The field will be removed from the schema in a future release.
     */
    @JsonDeserialize(builder = VerificationAddress.Builder::class)
    @NoAutoDetect
    class VerificationAddress
    private constructor(
        private val address1: String?,
        private val address2: String?,
        private val city: String?,
        private val country: String?,
        private val postalCode: String?,
        private val state: String?,
        private val additionalProperties: Map,
    ) {

        @JsonProperty("address1") fun address1(): String? = address1

        @JsonProperty("address2") fun address2(): String? = address2

        @JsonProperty("city") fun city(): String? = city

        @JsonProperty("country") fun country(): String? = country

        @JsonProperty("postal_code") fun postalCode(): String? = postalCode

        @JsonProperty("state") fun state(): String? = state

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

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

        companion object {

            fun builder() = Builder()
        }

        class Builder {

            private var address1: String? = null
            private var address2: String? = null
            private var city: String? = null
            private var country: String? = null
            private var postalCode: String? = null
            private var state: String? = null
            private var additionalProperties: MutableMap = mutableMapOf()

            internal fun from(verificationAddress: VerificationAddress) = apply {
                this.address1 = verificationAddress.address1
                this.address2 = verificationAddress.address2
                this.city = verificationAddress.city
                this.country = verificationAddress.country
                this.postalCode = verificationAddress.postalCode
                this.state = verificationAddress.state
                additionalProperties(verificationAddress.additionalProperties)
            }

            @JsonProperty("address1")
            fun address1(address1: String) = apply { this.address1 = address1 }

            @JsonProperty("address2")
            fun address2(address2: String) = apply { this.address2 = address2 }

            @JsonProperty("city") fun city(city: String) = apply { this.city = city }

            @JsonProperty("country") fun country(country: String) = apply { this.country = country }

            @JsonProperty("postal_code")
            fun postalCode(postalCode: String) = apply { this.postalCode = postalCode }

            @JsonProperty("state") fun state(state: String) = apply { this.state = state }

            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(): VerificationAddress =
                VerificationAddress(
                    address1,
                    address2,
                    city,
                    country,
                    postalCode,
                    state,
                    additionalProperties.toImmutable(),
                )
        }

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

            return /* spotless:off */ other is VerificationAddress && this.address1 == other.address1 && this.address2 == other.address2 && this.city == other.city && this.country == other.country && this.postalCode == other.postalCode && this.state == other.state && this.additionalProperties == other.additionalProperties /* spotless:on */
        }

        private var hashCode: Int = 0

        override fun hashCode(): Int {
            if (hashCode == 0) {
                hashCode = /* spotless:off */ Objects.hash(address1, address2, city, country, postalCode, state, additionalProperties) /* spotless:on */
            }
            return hashCode
        }

        override fun toString() =
            "VerificationAddress{address1=$address1, address2=$address2, city=$city, country=$country, postalCode=$postalCode, state=$state, additionalProperties=$additionalProperties}"
    }
}