com.lithic.api.models.Address.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.JsonProperty
import com.fasterxml.jackson.databind.annotation.JsonDeserialize
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 java.util.Objects

@JsonDeserialize(builder = Address.Builder::class)
@NoAutoDetect
class Address
private constructor(
    private val address1: JsonField,
    private val address2: JsonField,
    private val city: JsonField,
    private val country: JsonField,
    private val postalCode: JsonField,
    private val state: JsonField,
    private val additionalProperties: Map,
) {

    private var validated: Boolean = false

    /** Valid deliverable address (no PO boxes). */
    fun address1(): String = address1.getRequired("address1")

    /** Unit or apartment number (if applicable). */
    fun address2(): String? = address2.getNullable("address2")

    /** Name of city. */
    fun city(): String = city.getRequired("city")

    /**
     * Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character format. Only USA
     * is currently supported for all workflows. KYC_EXEMPT supports CAN additionally.
     */
    fun country(): String = country.getRequired("country")

    /**
     * Valid postal code. USA postal codes (ZIP codes) are supported, entered as a five-digit postal
     * code or nine-digit postal code (ZIP+4) using the format 12345-1234. KYC_EXEMPT supports
     * Canadian postal codes.
     */
    fun postalCode(): String = postalCode.getRequired("postal_code")

    /**
     * Valid state code. USA state codes are supported, entered in uppercase ISO 3166-2
     * two-character format. KYC_EXEMPT supports Canadian province codes.
     */
    fun state(): String = state.getRequired("state")

    /** Valid deliverable address (no PO boxes). */
    @JsonProperty("address1") @ExcludeMissing fun _address1() = address1

    /** Unit or apartment number (if applicable). */
    @JsonProperty("address2") @ExcludeMissing fun _address2() = address2

    /** Name of city. */
    @JsonProperty("city") @ExcludeMissing fun _city() = city

    /**
     * Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character format. Only USA
     * is currently supported for all workflows. KYC_EXEMPT supports CAN additionally.
     */
    @JsonProperty("country") @ExcludeMissing fun _country() = country

    /**
     * Valid postal code. USA postal codes (ZIP codes) are supported, entered as a five-digit postal
     * code or nine-digit postal code (ZIP+4) using the format 12345-1234. KYC_EXEMPT supports
     * Canadian postal codes.
     */
    @JsonProperty("postal_code") @ExcludeMissing fun _postalCode() = postalCode

    /**
     * Valid state code. USA state codes are supported, entered in uppercase ISO 3166-2
     * two-character format. KYC_EXEMPT supports Canadian province codes.
     */
    @JsonProperty("state") @ExcludeMissing fun _state() = state

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

    fun validate(): Address = apply {
        if (!validated) {
            address1()
            address2()
            city()
            country()
            postalCode()
            state()
            validated = true
        }
    }

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

    companion object {

        fun builder() = Builder()
    }

    class Builder {

        private var address1: JsonField = JsonMissing.of()
        private var address2: JsonField = JsonMissing.of()
        private var city: JsonField = JsonMissing.of()
        private var country: JsonField = JsonMissing.of()
        private var postalCode: JsonField = JsonMissing.of()
        private var state: JsonField = JsonMissing.of()
        private var additionalProperties: MutableMap = mutableMapOf()

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

        /** Valid deliverable address (no PO boxes). */
        fun address1(address1: String) = address1(JsonField.of(address1))

        /** Valid deliverable address (no PO boxes). */
        @JsonProperty("address1")
        @ExcludeMissing
        fun address1(address1: JsonField) = apply { this.address1 = address1 }

        /** Unit or apartment number (if applicable). */
        fun address2(address2: String) = address2(JsonField.of(address2))

        /** Unit or apartment number (if applicable). */
        @JsonProperty("address2")
        @ExcludeMissing
        fun address2(address2: JsonField) = apply { this.address2 = address2 }

        /** Name of city. */
        fun city(city: String) = city(JsonField.of(city))

        /** Name of city. */
        @JsonProperty("city")
        @ExcludeMissing
        fun city(city: JsonField) = apply { this.city = city }

        /**
         * Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character format. Only
         * USA is currently supported for all workflows. KYC_EXEMPT supports CAN additionally.
         */
        fun country(country: String) = country(JsonField.of(country))

        /**
         * Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character format. Only
         * USA is currently supported for all workflows. KYC_EXEMPT supports CAN additionally.
         */
        @JsonProperty("country")
        @ExcludeMissing
        fun country(country: JsonField) = apply { this.country = country }

        /**
         * Valid postal code. USA postal codes (ZIP codes) are supported, entered as a five-digit
         * postal code or nine-digit postal code (ZIP+4) using the format 12345-1234. KYC_EXEMPT
         * supports Canadian postal codes.
         */
        fun postalCode(postalCode: String) = postalCode(JsonField.of(postalCode))

        /**
         * Valid postal code. USA postal codes (ZIP codes) are supported, entered as a five-digit
         * postal code or nine-digit postal code (ZIP+4) using the format 12345-1234. KYC_EXEMPT
         * supports Canadian postal codes.
         */
        @JsonProperty("postal_code")
        @ExcludeMissing
        fun postalCode(postalCode: JsonField) = apply { this.postalCode = postalCode }

        /**
         * Valid state code. USA state codes are supported, entered in uppercase ISO 3166-2
         * two-character format. KYC_EXEMPT supports Canadian province codes.
         */
        fun state(state: String) = state(JsonField.of(state))

        /**
         * Valid state code. USA state codes are supported, entered in uppercase ISO 3166-2
         * two-character format. KYC_EXEMPT supports Canadian province codes.
         */
        @JsonProperty("state")
        @ExcludeMissing
        fun state(state: JsonField) = 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(): Address =
            Address(
                address1,
                address2,
                city,
                country,
                postalCode,
                state,
                additionalProperties.toImmutable(),
            )
    }

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

        return /* spotless:off */ other is Address && 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() =
        "Address{address1=$address1, address2=$address2, city=$city, country=$country, postalCode=$postalCode, state=$state, additionalProperties=$additionalProperties}"
}