com.lithic.api.models.CardUpdateParams.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
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.
// 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.toUnmodifiable
import com.lithic.api.errors.LithicInvalidDataException
import com.lithic.api.models.*
import java.util.Objects
class CardUpdateParams
constructor(
private val cardToken: String,
private val digitalCardArtToken: String?,
private val memo: String?,
private val pin: String?,
private val pinStatus: PinStatus?,
private val spendLimit: Long?,
private val spendLimitDuration: SpendLimitDuration?,
private val state: State?,
private val additionalQueryParams: Map>,
private val additionalHeaders: Map>,
private val additionalBodyProperties: Map,
) {
fun cardToken(): String = cardToken
fun digitalCardArtToken(): String? = digitalCardArtToken
fun memo(): String? = memo
fun pin(): String? = pin
fun pinStatus(): PinStatus? = pinStatus
fun spendLimit(): Long? = spendLimit
fun spendLimitDuration(): SpendLimitDuration? = spendLimitDuration
fun state(): State? = state
internal fun getBody(): CardUpdateBody {
return CardUpdateBody(
digitalCardArtToken,
memo,
pin,
pinStatus,
spendLimit,
spendLimitDuration,
state,
additionalBodyProperties,
)
}
internal fun getQueryParams(): Map> = additionalQueryParams
internal fun getHeaders(): Map> = additionalHeaders
fun getPathParam(index: Int): String {
return when (index) {
0 -> cardToken
else -> ""
}
}
@JsonDeserialize(builder = CardUpdateBody.Builder::class)
@NoAutoDetect
class CardUpdateBody
internal constructor(
private val digitalCardArtToken: String?,
private val memo: String?,
private val pin: String?,
private val pinStatus: PinStatus?,
private val spendLimit: Long?,
private val spendLimitDuration: SpendLimitDuration?,
private val state: State?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/**
* Specifies the digital card art to be displayed in the user’s digital wallet after
* tokenization. This artwork must be approved by Mastercard and configured by Lithic to
* use. See
* [Flexible Card Art Guide](https://docs.lithic.com/docs/about-digital-wallets#flexible-card-art).
*/
@JsonProperty("digital_card_art_token")
fun digitalCardArtToken(): String? = digitalCardArtToken
/**
* Friendly name to identify the card. We recommend against using this field to store JSON
* data as it can cause unexpected behavior.
*/
@JsonProperty("memo") fun memo(): String? = memo
/**
* Encrypted PIN block (in base64). Only applies to cards of type `PHYSICAL` and `VIRTUAL`.
* Changing PIN also resets PIN status to `OK`. See
* [Encrypted PIN Block](https://docs.lithic.com/docs/cards#encrypted-pin-block).
*/
@JsonProperty("pin") fun pin(): String? = pin
/**
* Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
* attempts). Can only be set to `OK` to unblock a card.
*/
@JsonProperty("pin_status") fun pinStatus(): PinStatus? = pinStatus
/**
* Amount (in cents) to limit approved authorizations. Transaction requests above the spend
* limit will be declined. 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 card limit.
*/
@JsonProperty("spend_limit") fun spendLimit(): Long? = spendLimit
/**
* Spend limit duration values:
* - `ANNUALLY` - Card will authorize transactions up to spend limit for the trailing year.
* - `FOREVER` - Card will authorize only up to spend limit for the entire lifetime of the
* card.
* - `MONTHLY` - Card will authorize transactions up to spend limit for the trailing month.
* To support recurring monthly payments, which can occur on different day every month,
* the time window we consider for monthly velocity starts 6 days after the current
* calendar date one month prior.
* - `TRANSACTION` - Card will authorize multiple transactions if each individual
* transaction is under the spend limit.
*/
@JsonProperty("spend_limit_duration")
fun spendLimitDuration(): SpendLimitDuration? = spendLimitDuration
/**
* Card state values:
* - `CLOSED` - Card will no longer approve authorizations. Closing a card cannot be undone.
* - `OPEN` - Card will approve authorizations (if they match card and account parameters).
* - `PAUSED` - Card will decline authorizations, but can be resumed at a later time.
*/
@JsonProperty("state") fun state(): State? = state
@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 CardUpdateBody &&
this.digitalCardArtToken == other.digitalCardArtToken &&
this.memo == other.memo &&
this.pin == other.pin &&
this.pinStatus == other.pinStatus &&
this.spendLimit == other.spendLimit &&
this.spendLimitDuration == other.spendLimitDuration &&
this.state == other.state &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
digitalCardArtToken,
memo,
pin,
pinStatus,
spendLimit,
spendLimitDuration,
state,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"CardUpdateBody{digitalCardArtToken=$digitalCardArtToken, memo=$memo, pin=$pin, pinStatus=$pinStatus, spendLimit=$spendLimit, spendLimitDuration=$spendLimitDuration, state=$state, additionalProperties=$additionalProperties}"
companion object {
fun builder() = Builder()
}
class Builder {
private var digitalCardArtToken: String? = null
private var memo: String? = null
private var pin: String? = null
private var pinStatus: PinStatus? = null
private var spendLimit: Long? = null
private var spendLimitDuration: SpendLimitDuration? = null
private var state: State? = null
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(cardUpdateBody: CardUpdateBody) = apply {
this.digitalCardArtToken = cardUpdateBody.digitalCardArtToken
this.memo = cardUpdateBody.memo
this.pin = cardUpdateBody.pin
this.pinStatus = cardUpdateBody.pinStatus
this.spendLimit = cardUpdateBody.spendLimit
this.spendLimitDuration = cardUpdateBody.spendLimitDuration
this.state = cardUpdateBody.state
additionalProperties(cardUpdateBody.additionalProperties)
}
/**
* Specifies the digital card art to be displayed in the user’s digital wallet after
* tokenization. This artwork must be approved by Mastercard and configured by Lithic to
* use. See
* [Flexible Card Art Guide](https://docs.lithic.com/docs/about-digital-wallets#flexible-card-art).
*/
@JsonProperty("digital_card_art_token")
fun digitalCardArtToken(digitalCardArtToken: String) = apply {
this.digitalCardArtToken = digitalCardArtToken
}
/**
* Friendly name to identify the card. We recommend against using this field to store
* JSON data as it can cause unexpected behavior.
*/
@JsonProperty("memo") fun memo(memo: String) = apply { this.memo = memo }
/**
* Encrypted PIN block (in base64). Only applies to cards of type `PHYSICAL` and
* `VIRTUAL`. Changing PIN also resets PIN status to `OK`. See
* [Encrypted PIN Block](https://docs.lithic.com/docs/cards#encrypted-pin-block).
*/
@JsonProperty("pin") fun pin(pin: String) = apply { this.pin = pin }
/**
* Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
* attempts). Can only be set to `OK` to unblock a card.
*/
@JsonProperty("pin_status")
fun pinStatus(pinStatus: PinStatus) = apply { this.pinStatus = pinStatus }
/**
* Amount (in cents) to limit approved authorizations. Transaction requests above the
* spend limit will be declined. 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 card limit.
*/
@JsonProperty("spend_limit")
fun spendLimit(spendLimit: Long) = apply { this.spendLimit = spendLimit }
/**
* Spend limit duration values:
* - `ANNUALLY` - Card will authorize transactions up to spend limit for the trailing
* year.
* - `FOREVER` - Card will authorize only up to spend limit for the entire lifetime of
* the card.
* - `MONTHLY` - Card will authorize transactions up to spend limit for the trailing
* month. To support recurring monthly payments, which can occur on different day
* every month, the time window we consider for monthly velocity starts 6 days after
* the current calendar date one month prior.
* - `TRANSACTION` - Card will authorize multiple transactions if each individual
* transaction is under the spend limit.
*/
@JsonProperty("spend_limit_duration")
fun spendLimitDuration(spendLimitDuration: SpendLimitDuration) = apply {
this.spendLimitDuration = spendLimitDuration
}
/**
* Card state values:
* - `CLOSED` - Card will no longer approve authorizations. Closing a card cannot be
* undone.
* - `OPEN` - Card will approve authorizations (if they match card and account
* parameters).
* - `PAUSED` - Card will decline authorizations, but can be resumed at a later time.
*/
@JsonProperty("state") fun state(state: State) = 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(): CardUpdateBody =
CardUpdateBody(
digitalCardArtToken,
memo,
pin,
pinStatus,
spendLimit,
spendLimitDuration,
state,
additionalProperties.toUnmodifiable(),
)
}
}
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 CardUpdateParams &&
this.cardToken == other.cardToken &&
this.digitalCardArtToken == other.digitalCardArtToken &&
this.memo == other.memo &&
this.pin == other.pin &&
this.pinStatus == other.pinStatus &&
this.spendLimit == other.spendLimit &&
this.spendLimitDuration == other.spendLimitDuration &&
this.state == other.state &&
this.additionalQueryParams == other.additionalQueryParams &&
this.additionalHeaders == other.additionalHeaders &&
this.additionalBodyProperties == other.additionalBodyProperties
}
override fun hashCode(): Int {
return Objects.hash(
cardToken,
digitalCardArtToken,
memo,
pin,
pinStatus,
spendLimit,
spendLimitDuration,
state,
additionalQueryParams,
additionalHeaders,
additionalBodyProperties,
)
}
override fun toString() =
"CardUpdateParams{cardToken=$cardToken, digitalCardArtToken=$digitalCardArtToken, memo=$memo, pin=$pin, pinStatus=$pinStatus, spendLimit=$spendLimit, spendLimitDuration=$spendLimitDuration, state=$state, additionalQueryParams=$additionalQueryParams, additionalHeaders=$additionalHeaders, additionalBodyProperties=$additionalBodyProperties}"
fun toBuilder() = Builder().from(this)
companion object {
fun builder() = Builder()
}
@NoAutoDetect
class Builder {
private var cardToken: String? = null
private var digitalCardArtToken: String? = null
private var memo: String? = null
private var pin: String? = null
private var pinStatus: PinStatus? = null
private var spendLimit: Long? = null
private var spendLimitDuration: SpendLimitDuration? = null
private var state: State? = null
private var additionalQueryParams: MutableMap> = mutableMapOf()
private var additionalHeaders: MutableMap> = mutableMapOf()
private var additionalBodyProperties: MutableMap = mutableMapOf()
internal fun from(cardUpdateParams: CardUpdateParams) = apply {
this.cardToken = cardUpdateParams.cardToken
this.digitalCardArtToken = cardUpdateParams.digitalCardArtToken
this.memo = cardUpdateParams.memo
this.pin = cardUpdateParams.pin
this.pinStatus = cardUpdateParams.pinStatus
this.spendLimit = cardUpdateParams.spendLimit
this.spendLimitDuration = cardUpdateParams.spendLimitDuration
this.state = cardUpdateParams.state
additionalQueryParams(cardUpdateParams.additionalQueryParams)
additionalHeaders(cardUpdateParams.additionalHeaders)
additionalBodyProperties(cardUpdateParams.additionalBodyProperties)
}
fun cardToken(cardToken: String) = apply { this.cardToken = cardToken }
/**
* Specifies the digital card art to be displayed in the user’s digital wallet after
* tokenization. This artwork must be approved by Mastercard and configured by Lithic to
* use. See
* [Flexible Card Art Guide](https://docs.lithic.com/docs/about-digital-wallets#flexible-card-art).
*/
fun digitalCardArtToken(digitalCardArtToken: String) = apply {
this.digitalCardArtToken = digitalCardArtToken
}
/**
* Friendly name to identify the card. We recommend against using this field to store JSON
* data as it can cause unexpected behavior.
*/
fun memo(memo: String) = apply { this.memo = memo }
/**
* Encrypted PIN block (in base64). Only applies to cards of type `PHYSICAL` and `VIRTUAL`.
* Changing PIN also resets PIN status to `OK`. See
* [Encrypted PIN Block](https://docs.lithic.com/docs/cards#encrypted-pin-block).
*/
fun pin(pin: String) = apply { this.pin = pin }
/**
* Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
* attempts). Can only be set to `OK` to unblock a card.
*/
fun pinStatus(pinStatus: PinStatus) = apply { this.pinStatus = pinStatus }
/**
* Amount (in cents) to limit approved authorizations. Transaction requests above the spend
* limit will be declined. 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 card limit.
*/
fun spendLimit(spendLimit: Long) = apply { this.spendLimit = spendLimit }
/**
* Spend limit duration values:
* - `ANNUALLY` - Card will authorize transactions up to spend limit for the trailing year.
* - `FOREVER` - Card will authorize only up to spend limit for the entire lifetime of the
* card.
* - `MONTHLY` - Card will authorize transactions up to spend limit for the trailing month.
* To support recurring monthly payments, which can occur on different day every month,
* the time window we consider for monthly velocity starts 6 days after the current
* calendar date one month prior.
* - `TRANSACTION` - Card will authorize multiple transactions if each individual
* transaction is under the spend limit.
*/
fun spendLimitDuration(spendLimitDuration: SpendLimitDuration) = apply {
this.spendLimitDuration = spendLimitDuration
}
/**
* Card state values:
* - `CLOSED` - Card will no longer approve authorizations. Closing a card cannot be undone.
* - `OPEN` - Card will approve authorizations (if they match card and account parameters).
* - `PAUSED` - Card will decline authorizations, but can be resumed at a later time.
*/
fun state(state: State) = apply { this.state = state }
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(): CardUpdateParams =
CardUpdateParams(
checkNotNull(cardToken) { "`cardToken` is required but was not set" },
digitalCardArtToken,
memo,
pin,
pinStatus,
spendLimit,
spendLimitDuration,
state,
additionalQueryParams.mapValues { it.value.toUnmodifiable() }.toUnmodifiable(),
additionalHeaders.mapValues { it.value.toUnmodifiable() }.toUnmodifiable(),
additionalBodyProperties.toUnmodifiable(),
)
}
class PinStatus
@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 PinStatus && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
val OK = PinStatus(JsonField.of("OK"))
fun of(value: String) = PinStatus(JsonField.of(value))
}
enum class Known {
OK,
}
enum class Value {
OK,
_UNKNOWN,
}
fun value(): Value =
when (this) {
OK -> Value.OK
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
OK -> Known.OK
else -> throw LithicInvalidDataException("Unknown PinStatus: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
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 other is State && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
val CLOSED = State(JsonField.of("CLOSED"))
val OPEN = State(JsonField.of("OPEN"))
val PAUSED = State(JsonField.of("PAUSED"))
fun of(value: String) = State(JsonField.of(value))
}
enum class Known {
CLOSED,
OPEN,
PAUSED,
}
enum class Value {
CLOSED,
OPEN,
PAUSED,
_UNKNOWN,
}
fun value(): Value =
when (this) {
CLOSED -> Value.CLOSED
OPEN -> Value.OPEN
PAUSED -> Value.PAUSED
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
CLOSED -> Known.CLOSED
OPEN -> Known.OPEN
PAUSED -> Known.PAUSED
else -> throw LithicInvalidDataException("Unknown State: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
}