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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lithic-java-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.JsonValue
import com.lithic.api.core.NoAutoDetect
import com.lithic.api.core.toImmutable
import com.lithic.api.models.*
import java.time.OffsetDateTime
import java.util.Objects
import java.util.Optional

class CardGetEmbedHtmlParams
constructor(
    private val token: String,
    private val css: String?,
    private val expiration: OffsetDateTime?,
    private val targetOrigin: String?,
    private val additionalQueryParams: Map>,
    private val additionalHeaders: Map>,
    private val additionalBodyProperties: Map,
) {

    fun token(): String = token

    fun css(): Optional = Optional.ofNullable(css)

    fun expiration(): Optional = Optional.ofNullable(expiration)

    fun targetOrigin(): Optional = Optional.ofNullable(targetOrigin)

    @JvmSynthetic
    internal fun getBody(): CardGetEmbedHtmlBody {
        return CardGetEmbedHtmlBody(
            token,
            css,
            expiration,
            targetOrigin,
            additionalBodyProperties,
        )
    }

    @JvmSynthetic internal fun getQueryParams(): Map> = additionalQueryParams

    @JvmSynthetic internal fun getHeaders(): Map> = additionalHeaders

    @JsonDeserialize(builder = CardGetEmbedHtmlBody.Builder::class)
    @NoAutoDetect
    class CardGetEmbedHtmlBody
    internal constructor(
        private val token: String?,
        private val css: String?,
        private val expiration: OffsetDateTime?,
        private val targetOrigin: String?,
        private val additionalProperties: Map,
    ) {

        private var hashCode: Int = 0

        /** Globally unique identifier for the card to be displayed. */
        @JsonProperty("token") fun token(): String? = token

        /**
         * A publicly available URI, so the white-labeled card element can be styled with the
         * client's branding.
         */
        @JsonProperty("css") fun css(): String? = css

        /**
         * An RFC 3339 timestamp for when the request should expire. UTC time zone.
         *
         * If no timezone is specified, UTC will be used. If payload does not contain an expiration,
         * the request will never expire.
         *
         * Using an `expiration` reduces the risk of a
         * [replay attack](https://en.wikipedia.org/wiki/Replay_attack). Without supplying the
         * `expiration`, in the event that a malicious user gets a copy of your request in transit,
         * they will be able to obtain the response data indefinitely.
         */
        @JsonProperty("expiration") fun expiration(): OffsetDateTime? = expiration

        /**
         * Required if you want to post the element clicked to the parent iframe.
         *
         * If you supply this param, you can also capture click events in the parent iframe by
         * adding an event listener.
         */
        @JsonProperty("target_origin") fun targetOrigin(): String? = targetOrigin

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

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

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

            return other is CardGetEmbedHtmlBody &&
                this.token == other.token &&
                this.css == other.css &&
                this.expiration == other.expiration &&
                this.targetOrigin == other.targetOrigin &&
                this.additionalProperties == other.additionalProperties
        }

        override fun hashCode(): Int {
            if (hashCode == 0) {
                hashCode =
                    Objects.hash(
                        token,
                        css,
                        expiration,
                        targetOrigin,
                        additionalProperties,
                    )
            }
            return hashCode
        }

        override fun toString() =
            "CardGetEmbedHtmlBody{token=$token, css=$css, expiration=$expiration, targetOrigin=$targetOrigin, additionalProperties=$additionalProperties}"

        companion object {

            @JvmStatic fun builder() = Builder()
        }

        class Builder {

            private var token: String? = null
            private var css: String? = null
            private var expiration: OffsetDateTime? = null
            private var targetOrigin: String? = null
            private var additionalProperties: MutableMap = mutableMapOf()

            @JvmSynthetic
            internal fun from(cardGetEmbedHtmlBody: CardGetEmbedHtmlBody) = apply {
                this.token = cardGetEmbedHtmlBody.token
                this.css = cardGetEmbedHtmlBody.css
                this.expiration = cardGetEmbedHtmlBody.expiration
                this.targetOrigin = cardGetEmbedHtmlBody.targetOrigin
                additionalProperties(cardGetEmbedHtmlBody.additionalProperties)
            }

            /** Globally unique identifier for the card to be displayed. */
            @JsonProperty("token") fun token(token: String) = apply { this.token = token }

            /**
             * A publicly available URI, so the white-labeled card element can be styled with the
             * client's branding.
             */
            @JsonProperty("css") fun css(css: String) = apply { this.css = css }

            /**
             * An RFC 3339 timestamp for when the request should expire. UTC time zone.
             *
             * If no timezone is specified, UTC will be used. If payload does not contain an
             * expiration, the request will never expire.
             *
             * Using an `expiration` reduces the risk of a
             * [replay attack](https://en.wikipedia.org/wiki/Replay_attack). Without supplying the
             * `expiration`, in the event that a malicious user gets a copy of your request in
             * transit, they will be able to obtain the response data indefinitely.
             */
            @JsonProperty("expiration")
            fun expiration(expiration: OffsetDateTime) = apply { this.expiration = expiration }

            /**
             * Required if you want to post the element clicked to the parent iframe.
             *
             * If you supply this param, you can also capture click events in the parent iframe by
             * adding an event listener.
             */
            @JsonProperty("target_origin")
            fun targetOrigin(targetOrigin: String) = apply { this.targetOrigin = targetOrigin }

            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(): CardGetEmbedHtmlBody =
                CardGetEmbedHtmlBody(
                    checkNotNull(token) { "`token` is required but was not set" },
                    css,
                    expiration,
                    targetOrigin,
                    additionalProperties.toImmutable(),
                )
        }
    }

    fun _additionalQueryParams(): Map> = additionalQueryParams

    fun _additionalHeaders(): Map> = additionalHeaders

    fun _additionalBodyProperties(): Map = additionalBodyProperties

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

        return other is CardGetEmbedHtmlParams &&
            this.token == other.token &&
            this.css == other.css &&
            this.expiration == other.expiration &&
            this.targetOrigin == other.targetOrigin &&
            this.additionalQueryParams == other.additionalQueryParams &&
            this.additionalHeaders == other.additionalHeaders &&
            this.additionalBodyProperties == other.additionalBodyProperties
    }

    override fun hashCode(): Int {
        return Objects.hash(
            token,
            css,
            expiration,
            targetOrigin,
            additionalQueryParams,
            additionalHeaders,
            additionalBodyProperties,
        )
    }

    override fun toString() =
        "CardGetEmbedHtmlParams{token=$token, css=$css, expiration=$expiration, targetOrigin=$targetOrigin, additionalQueryParams=$additionalQueryParams, additionalHeaders=$additionalHeaders, additionalBodyProperties=$additionalBodyProperties}"

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

    companion object {

        @JvmStatic fun builder() = Builder()
    }

    @NoAutoDetect
    class Builder {

        private var token: String? = null
        private var css: String? = null
        private var expiration: OffsetDateTime? = null
        private var targetOrigin: String? = null
        private var additionalQueryParams: MutableMap> = mutableMapOf()
        private var additionalHeaders: MutableMap> = mutableMapOf()
        private var additionalBodyProperties: MutableMap = mutableMapOf()

        @JvmSynthetic
        internal fun from(cardGetEmbedHtmlParams: CardGetEmbedHtmlParams) = apply {
            this.token = cardGetEmbedHtmlParams.token
            this.css = cardGetEmbedHtmlParams.css
            this.expiration = cardGetEmbedHtmlParams.expiration
            this.targetOrigin = cardGetEmbedHtmlParams.targetOrigin
            additionalQueryParams(cardGetEmbedHtmlParams.additionalQueryParams)
            additionalHeaders(cardGetEmbedHtmlParams.additionalHeaders)
            additionalBodyProperties(cardGetEmbedHtmlParams.additionalBodyProperties)
        }

        /** Globally unique identifier for the card to be displayed. */
        fun token(token: String) = apply { this.token = token }

        /**
         * A publicly available URI, so the white-labeled card element can be styled with the
         * client's branding.
         */
        fun css(css: String) = apply { this.css = css }

        /**
         * An RFC 3339 timestamp for when the request should expire. UTC time zone.
         *
         * If no timezone is specified, UTC will be used. If payload does not contain an expiration,
         * the request will never expire.
         *
         * Using an `expiration` reduces the risk of a
         * [replay attack](https://en.wikipedia.org/wiki/Replay_attack). Without supplying the
         * `expiration`, in the event that a malicious user gets a copy of your request in transit,
         * they will be able to obtain the response data indefinitely.
         */
        fun expiration(expiration: OffsetDateTime) = apply { this.expiration = expiration }

        /**
         * Required if you want to post the element clicked to the parent iframe.
         *
         * If you supply this param, you can also capture click events in the parent iframe by
         * adding an event listener.
         */
        fun targetOrigin(targetOrigin: String) = apply { this.targetOrigin = targetOrigin }

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

        fun putQueryParam(name: String, value: String) = apply {
            this.additionalQueryParams.getOrPut(name) { mutableListOf() }.add(value)
        }

        fun putQueryParams(name: String, values: Iterable) = apply {
            this.additionalQueryParams.getOrPut(name) { mutableListOf() }.addAll(values)
        }

        fun putAllQueryParams(additionalQueryParams: Map>) = apply {
            additionalQueryParams.forEach(this::putQueryParams)
        }

        fun removeQueryParam(name: String) = apply {
            this.additionalQueryParams.put(name, mutableListOf())
        }

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

        fun putHeader(name: String, value: String) = apply {
            this.additionalHeaders.getOrPut(name) { mutableListOf() }.add(value)
        }

        fun putHeaders(name: String, values: Iterable) = apply {
            this.additionalHeaders.getOrPut(name) { mutableListOf() }.addAll(values)
        }

        fun putAllHeaders(additionalHeaders: Map>) = apply {
            additionalHeaders.forEach(this::putHeaders)
        }

        fun removeHeader(name: String) = apply { this.additionalHeaders.put(name, mutableListOf()) }

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

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

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

        fun build(): CardGetEmbedHtmlParams =
            CardGetEmbedHtmlParams(
                checkNotNull(token) { "`token` is required but was not set" },
                css,
                expiration,
                targetOrigin,
                additionalQueryParams.mapValues { it.value.toImmutable() }.toImmutable(),
                additionalHeaders.mapValues { it.value.toImmutable() }.toImmutable(),
                additionalBodyProperties.toImmutable(),
            )
    }
}