com.increase.api.models.SimulationInboundFundsHoldReleaseResponse.kt Maven / Gradle / Ivy
The newest version!
// File generated from our OpenAPI spec by Stainless.
package com.increase.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.increase.api.core.Enum
import com.increase.api.core.ExcludeMissing
import com.increase.api.core.JsonField
import com.increase.api.core.JsonMissing
import com.increase.api.core.JsonValue
import com.increase.api.core.NoAutoDetect
import com.increase.api.core.toUnmodifiable
import com.increase.api.errors.IncreaseInvalidDataException
import java.time.OffsetDateTime
import java.util.Objects
/**
* We hold funds for certain transaction types to account for return windows where funds might still
* be clawed back by the sending institution.
*/
@JsonDeserialize(builder = SimulationInboundFundsHoldReleaseResponse.Builder::class)
@NoAutoDetect
class SimulationInboundFundsHoldReleaseResponse
private constructor(
private val amount: JsonField,
private val automaticallyReleasesAt: JsonField,
private val createdAt: JsonField,
private val currency: JsonField,
private val heldTransactionId: JsonField,
private val id: JsonField,
private val pendingTransactionId: JsonField,
private val releasedAt: JsonField,
private val status: JsonField,
private val type: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/**
* The held amount in the minor unit of the account's currency. For dollars, for example, this
* is cents.
*/
fun amount(): Long = amount.getRequired("amount")
/**
* When the hold will be released automatically. Certain conditions may cause it to be released
* before this time.
*/
fun automaticallyReleasesAt(): OffsetDateTime =
automaticallyReleasesAt.getRequired("automatically_releases_at")
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold was created.
*/
fun createdAt(): OffsetDateTime = createdAt.getRequired("created_at")
/** The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's currency. */
fun currency(): Currency = currency.getRequired("currency")
/** The ID of the Transaction for which funds were held. */
fun heldTransactionId(): String? = heldTransactionId.getNullable("held_transaction_id")
/** The Inbound Funds Hold identifier. */
fun id(): String = id.getRequired("id")
/** The ID of the Pending Transaction representing the held funds. */
fun pendingTransactionId(): String? = pendingTransactionId.getNullable("pending_transaction_id")
/** When the hold was released (if it has been released). */
fun releasedAt(): OffsetDateTime? = releasedAt.getNullable("released_at")
/** The status of the hold. */
fun status(): Status = status.getRequired("status")
/**
* A constant representing the object's type. For this resource it will always be
* `inbound_funds_hold`.
*/
fun type(): Type = type.getRequired("type")
/**
* The held amount in the minor unit of the account's currency. For dollars, for example, this
* is cents.
*/
@JsonProperty("amount") @ExcludeMissing fun _amount() = amount
/**
* When the hold will be released automatically. Certain conditions may cause it to be released
* before this time.
*/
@JsonProperty("automatically_releases_at")
@ExcludeMissing
fun _automaticallyReleasesAt() = automaticallyReleasesAt
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold was created.
*/
@JsonProperty("created_at") @ExcludeMissing fun _createdAt() = createdAt
/** The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's currency. */
@JsonProperty("currency") @ExcludeMissing fun _currency() = currency
/** The ID of the Transaction for which funds were held. */
@JsonProperty("held_transaction_id")
@ExcludeMissing
fun _heldTransactionId() = heldTransactionId
/** The Inbound Funds Hold identifier. */
@JsonProperty("id") @ExcludeMissing fun _id() = id
/** The ID of the Pending Transaction representing the held funds. */
@JsonProperty("pending_transaction_id")
@ExcludeMissing
fun _pendingTransactionId() = pendingTransactionId
/** When the hold was released (if it has been released). */
@JsonProperty("released_at") @ExcludeMissing fun _releasedAt() = releasedAt
/** The status of the hold. */
@JsonProperty("status") @ExcludeMissing fun _status() = status
/**
* A constant representing the object's type. For this resource it will always be
* `inbound_funds_hold`.
*/
@JsonProperty("type") @ExcludeMissing fun _type() = type
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): SimulationInboundFundsHoldReleaseResponse = apply {
if (!validated) {
amount()
automaticallyReleasesAt()
createdAt()
currency()
heldTransactionId()
id()
pendingTransactionId()
releasedAt()
status()
type()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is SimulationInboundFundsHoldReleaseResponse &&
this.amount == other.amount &&
this.automaticallyReleasesAt == other.automaticallyReleasesAt &&
this.createdAt == other.createdAt &&
this.currency == other.currency &&
this.heldTransactionId == other.heldTransactionId &&
this.id == other.id &&
this.pendingTransactionId == other.pendingTransactionId &&
this.releasedAt == other.releasedAt &&
this.status == other.status &&
this.type == other.type &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
amount,
automaticallyReleasesAt,
createdAt,
currency,
heldTransactionId,
id,
pendingTransactionId,
releasedAt,
status,
type,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"SimulationInboundFundsHoldReleaseResponse{amount=$amount, automaticallyReleasesAt=$automaticallyReleasesAt, createdAt=$createdAt, currency=$currency, heldTransactionId=$heldTransactionId, id=$id, pendingTransactionId=$pendingTransactionId, releasedAt=$releasedAt, status=$status, type=$type, additionalProperties=$additionalProperties}"
companion object {
fun builder() = Builder()
}
class Builder {
private var amount: JsonField = JsonMissing.of()
private var automaticallyReleasesAt: JsonField = JsonMissing.of()
private var createdAt: JsonField = JsonMissing.of()
private var currency: JsonField = JsonMissing.of()
private var heldTransactionId: JsonField = JsonMissing.of()
private var id: JsonField = JsonMissing.of()
private var pendingTransactionId: JsonField = JsonMissing.of()
private var releasedAt: JsonField = JsonMissing.of()
private var status: JsonField = JsonMissing.of()
private var type: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(
simulationInboundFundsHoldReleaseResponse: SimulationInboundFundsHoldReleaseResponse
) = apply {
this.amount = simulationInboundFundsHoldReleaseResponse.amount
this.automaticallyReleasesAt =
simulationInboundFundsHoldReleaseResponse.automaticallyReleasesAt
this.createdAt = simulationInboundFundsHoldReleaseResponse.createdAt
this.currency = simulationInboundFundsHoldReleaseResponse.currency
this.heldTransactionId = simulationInboundFundsHoldReleaseResponse.heldTransactionId
this.id = simulationInboundFundsHoldReleaseResponse.id
this.pendingTransactionId =
simulationInboundFundsHoldReleaseResponse.pendingTransactionId
this.releasedAt = simulationInboundFundsHoldReleaseResponse.releasedAt
this.status = simulationInboundFundsHoldReleaseResponse.status
this.type = simulationInboundFundsHoldReleaseResponse.type
additionalProperties(simulationInboundFundsHoldReleaseResponse.additionalProperties)
}
/**
* The held amount in the minor unit of the account's currency. For dollars, for example,
* this is cents.
*/
fun amount(amount: Long) = amount(JsonField.of(amount))
/**
* The held amount in the minor unit of the account's currency. For dollars, for example,
* this is cents.
*/
@JsonProperty("amount")
@ExcludeMissing
fun amount(amount: JsonField) = apply { this.amount = amount }
/**
* When the hold will be released automatically. Certain conditions may cause it to be
* released before this time.
*/
fun automaticallyReleasesAt(automaticallyReleasesAt: OffsetDateTime) =
automaticallyReleasesAt(JsonField.of(automaticallyReleasesAt))
/**
* When the hold will be released automatically. Certain conditions may cause it to be
* released before this time.
*/
@JsonProperty("automatically_releases_at")
@ExcludeMissing
fun automaticallyReleasesAt(automaticallyReleasesAt: JsonField) = apply {
this.automaticallyReleasesAt = automaticallyReleasesAt
}
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold was
* created.
*/
fun createdAt(createdAt: OffsetDateTime) = createdAt(JsonField.of(createdAt))
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold was
* created.
*/
@JsonProperty("created_at")
@ExcludeMissing
fun createdAt(createdAt: JsonField) = apply { this.createdAt = createdAt }
/** The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's currency. */
fun currency(currency: Currency) = currency(JsonField.of(currency))
/** The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's currency. */
@JsonProperty("currency")
@ExcludeMissing
fun currency(currency: JsonField) = apply { this.currency = currency }
/** The ID of the Transaction for which funds were held. */
fun heldTransactionId(heldTransactionId: String) =
heldTransactionId(JsonField.of(heldTransactionId))
/** The ID of the Transaction for which funds were held. */
@JsonProperty("held_transaction_id")
@ExcludeMissing
fun heldTransactionId(heldTransactionId: JsonField) = apply {
this.heldTransactionId = heldTransactionId
}
/** The Inbound Funds Hold identifier. */
fun id(id: String) = id(JsonField.of(id))
/** The Inbound Funds Hold identifier. */
@JsonProperty("id") @ExcludeMissing fun id(id: JsonField) = apply { this.id = id }
/** The ID of the Pending Transaction representing the held funds. */
fun pendingTransactionId(pendingTransactionId: String) =
pendingTransactionId(JsonField.of(pendingTransactionId))
/** The ID of the Pending Transaction representing the held funds. */
@JsonProperty("pending_transaction_id")
@ExcludeMissing
fun pendingTransactionId(pendingTransactionId: JsonField) = apply {
this.pendingTransactionId = pendingTransactionId
}
/** When the hold was released (if it has been released). */
fun releasedAt(releasedAt: OffsetDateTime) = releasedAt(JsonField.of(releasedAt))
/** When the hold was released (if it has been released). */
@JsonProperty("released_at")
@ExcludeMissing
fun releasedAt(releasedAt: JsonField) = apply {
this.releasedAt = releasedAt
}
/** The status of the hold. */
fun status(status: Status) = status(JsonField.of(status))
/** The status of the hold. */
@JsonProperty("status")
@ExcludeMissing
fun status(status: JsonField) = apply { this.status = status }
/**
* A constant representing the object's type. For this resource it will always be
* `inbound_funds_hold`.
*/
fun type(type: Type) = type(JsonField.of(type))
/**
* A constant representing the object's type. For this resource it will always be
* `inbound_funds_hold`.
*/
@JsonProperty("type")
@ExcludeMissing
fun type(type: JsonField) = apply { this.type = type }
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(): SimulationInboundFundsHoldReleaseResponse =
SimulationInboundFundsHoldReleaseResponse(
amount,
automaticallyReleasesAt,
createdAt,
currency,
heldTransactionId,
id,
pendingTransactionId,
releasedAt,
status,
type,
additionalProperties.toUnmodifiable(),
)
}
class Currency
@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 Currency && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
val CAD = Currency(JsonField.of("CAD"))
val CHF = Currency(JsonField.of("CHF"))
val EUR = Currency(JsonField.of("EUR"))
val GBP = Currency(JsonField.of("GBP"))
val JPY = Currency(JsonField.of("JPY"))
val USD = Currency(JsonField.of("USD"))
fun of(value: String) = Currency(JsonField.of(value))
}
enum class Known {
CAD,
CHF,
EUR,
GBP,
JPY,
USD,
}
enum class Value {
CAD,
CHF,
EUR,
GBP,
JPY,
USD,
_UNKNOWN,
}
fun value(): Value =
when (this) {
CAD -> Value.CAD
CHF -> Value.CHF
EUR -> Value.EUR
GBP -> Value.GBP
JPY -> Value.JPY
USD -> Value.USD
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
CAD -> Known.CAD
CHF -> Known.CHF
EUR -> Known.EUR
GBP -> Known.GBP
JPY -> Known.JPY
USD -> Known.USD
else -> throw IncreaseInvalidDataException("Unknown Currency: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
class Status
@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 Status && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
val HELD = Status(JsonField.of("held"))
val COMPLETE = Status(JsonField.of("complete"))
fun of(value: String) = Status(JsonField.of(value))
}
enum class Known {
HELD,
COMPLETE,
}
enum class Value {
HELD,
COMPLETE,
_UNKNOWN,
}
fun value(): Value =
when (this) {
HELD -> Value.HELD
COMPLETE -> Value.COMPLETE
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
HELD -> Known.HELD
COMPLETE -> Known.COMPLETE
else -> throw IncreaseInvalidDataException("Unknown Status: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
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 other is Type && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
val INBOUND_FUNDS_HOLD = Type(JsonField.of("inbound_funds_hold"))
fun of(value: String) = Type(JsonField.of(value))
}
enum class Known {
INBOUND_FUNDS_HOLD,
}
enum class Value {
INBOUND_FUNDS_HOLD,
_UNKNOWN,
}
fun value(): Value =
when (this) {
INBOUND_FUNDS_HOLD -> Value.INBOUND_FUNDS_HOLD
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
INBOUND_FUNDS_HOLD -> Known.INBOUND_FUNDS_HOLD
else -> throw IncreaseInvalidDataException("Unknown Type: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
}