com.increase.api.models.IntrafiBalance.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of increase-java-core Show documentation
Show all versions of increase-java-core Show documentation
An SDK library for increase
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.LocalDate
import java.util.Objects
import java.util.Optional
/**
* When using IntraFi, each account's balance over the standard FDIC insurance amount are swept to
* various other institutions. Funds are rebalanced across banks as needed once per business day.
*/
@JsonDeserialize(builder = IntrafiBalance.Builder::class)
@NoAutoDetect
class IntrafiBalance
private constructor(
private val balances: JsonField>,
private val currency: JsonField,
private val effectiveDate: JsonField,
private val id: JsonField,
private val totalBalance: JsonField,
private val type: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/**
* Each entry represents a balance held at a different bank. IntraFi separates the total balance
* across many participating banks in the network.
*/
fun balances(): List = balances.getRequired("balances")
/** The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the account currency. */
fun currency(): Currency = currency.getRequired("currency")
/** The date this balance reflects. */
fun effectiveDate(): LocalDate = effectiveDate.getRequired("effective_date")
/** The identifier of this balance. */
fun id(): String = id.getRequired("id")
/**
* The total balance, in minor units of `currency`. Increase reports this balance to IntraFi
* daily.
*/
fun totalBalance(): Long = totalBalance.getRequired("total_balance")
/**
* A constant representing the object's type. For this resource it will always be
* `intrafi_balance`.
*/
fun type(): Type = type.getRequired("type")
/**
* Each entry represents a balance held at a different bank. IntraFi separates the total balance
* across many participating banks in the network.
*/
@JsonProperty("balances") @ExcludeMissing fun _balances() = balances
/** The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the account currency. */
@JsonProperty("currency") @ExcludeMissing fun _currency() = currency
/** The date this balance reflects. */
@JsonProperty("effective_date") @ExcludeMissing fun _effectiveDate() = effectiveDate
/** The identifier of this balance. */
@JsonProperty("id") @ExcludeMissing fun _id() = id
/**
* The total balance, in minor units of `currency`. Increase reports this balance to IntraFi
* daily.
*/
@JsonProperty("total_balance") @ExcludeMissing fun _totalBalance() = totalBalance
/**
* A constant representing the object's type. For this resource it will always be
* `intrafi_balance`.
*/
@JsonProperty("type") @ExcludeMissing fun _type() = type
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): IntrafiBalance = apply {
if (!validated) {
balances().forEach { it.validate() }
currency()
effectiveDate()
id()
totalBalance()
type()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is IntrafiBalance &&
this.balances == other.balances &&
this.currency == other.currency &&
this.effectiveDate == other.effectiveDate &&
this.id == other.id &&
this.totalBalance == other.totalBalance &&
this.type == other.type &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
balances,
currency,
effectiveDate,
id,
totalBalance,
type,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"IntrafiBalance{balances=$balances, currency=$currency, effectiveDate=$effectiveDate, id=$id, totalBalance=$totalBalance, type=$type, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var balances: JsonField> = JsonMissing.of()
private var currency: JsonField = JsonMissing.of()
private var effectiveDate: JsonField = JsonMissing.of()
private var id: JsonField = JsonMissing.of()
private var totalBalance: JsonField = JsonMissing.of()
private var type: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(intrafiBalance: IntrafiBalance) = apply {
this.balances = intrafiBalance.balances
this.currency = intrafiBalance.currency
this.effectiveDate = intrafiBalance.effectiveDate
this.id = intrafiBalance.id
this.totalBalance = intrafiBalance.totalBalance
this.type = intrafiBalance.type
additionalProperties(intrafiBalance.additionalProperties)
}
/**
* Each entry represents a balance held at a different bank. IntraFi separates the total
* balance across many participating banks in the network.
*/
fun balances(balances: List) = balances(JsonField.of(balances))
/**
* Each entry represents a balance held at a different bank. IntraFi separates the total
* balance across many participating banks in the network.
*/
@JsonProperty("balances")
@ExcludeMissing
fun balances(balances: JsonField>) = apply { this.balances = balances }
/** The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the account currency. */
fun currency(currency: Currency) = currency(JsonField.of(currency))
/** The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the account currency. */
@JsonProperty("currency")
@ExcludeMissing
fun currency(currency: JsonField) = apply { this.currency = currency }
/** The date this balance reflects. */
fun effectiveDate(effectiveDate: LocalDate) = effectiveDate(JsonField.of(effectiveDate))
/** The date this balance reflects. */
@JsonProperty("effective_date")
@ExcludeMissing
fun effectiveDate(effectiveDate: JsonField) = apply {
this.effectiveDate = effectiveDate
}
/** The identifier of this balance. */
fun id(id: String) = id(JsonField.of(id))
/** The identifier of this balance. */
@JsonProperty("id") @ExcludeMissing fun id(id: JsonField) = apply { this.id = id }
/**
* The total balance, in minor units of `currency`. Increase reports this balance to IntraFi
* daily.
*/
fun totalBalance(totalBalance: Long) = totalBalance(JsonField.of(totalBalance))
/**
* The total balance, in minor units of `currency`. Increase reports this balance to IntraFi
* daily.
*/
@JsonProperty("total_balance")
@ExcludeMissing
fun totalBalance(totalBalance: JsonField) = apply { this.totalBalance = totalBalance }
/**
* A constant representing the object's type. For this resource it will always be
* `intrafi_balance`.
*/
fun type(type: Type) = type(JsonField.of(type))
/**
* A constant representing the object's type. For this resource it will always be
* `intrafi_balance`.
*/
@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(): IntrafiBalance =
IntrafiBalance(
balances.map { it.toUnmodifiable() },
currency,
effectiveDate,
id,
totalBalance,
type,
additionalProperties.toUnmodifiable(),
)
}
@JsonDeserialize(builder = Balance.Builder::class)
@NoAutoDetect
class Balance
private constructor(
private val balance: JsonField,
private val bank: JsonField,
private val bankLocation: JsonField,
private val fdicCertificateNumber: JsonField,
private val id: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/** The balance, in minor units of `currency`, held with this bank. */
fun balance(): Long = balance.getRequired("balance")
/** The name of the bank holding these funds. */
fun bank(): String = bank.getRequired("bank")
/** The primary location of the bank. */
fun bankLocation(): Optional =
Optional.ofNullable(bankLocation.getNullable("bank_location"))
/**
* The Federal Deposit Insurance Corporation (FDIC) certificate number of the bank. Because
* many banks have the same or similar names, this can be used to uniquely identify the
* institution.
*/
fun fdicCertificateNumber(): String =
fdicCertificateNumber.getRequired("fdic_certificate_number")
/** The identifier of this balance. */
fun id(): String = id.getRequired("id")
/** The balance, in minor units of `currency`, held with this bank. */
@JsonProperty("balance") @ExcludeMissing fun _balance() = balance
/** The name of the bank holding these funds. */
@JsonProperty("bank") @ExcludeMissing fun _bank() = bank
/** The primary location of the bank. */
@JsonProperty("bank_location") @ExcludeMissing fun _bankLocation() = bankLocation
/**
* The Federal Deposit Insurance Corporation (FDIC) certificate number of the bank. Because
* many banks have the same or similar names, this can be used to uniquely identify the
* institution.
*/
@JsonProperty("fdic_certificate_number")
@ExcludeMissing
fun _fdicCertificateNumber() = fdicCertificateNumber
/** The identifier of this balance. */
@JsonProperty("id") @ExcludeMissing fun _id() = id
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): Balance = apply {
if (!validated) {
balance()
bank()
bankLocation().map { it.validate() }
fdicCertificateNumber()
id()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Balance &&
this.balance == other.balance &&
this.bank == other.bank &&
this.bankLocation == other.bankLocation &&
this.fdicCertificateNumber == other.fdicCertificateNumber &&
this.id == other.id &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
balance,
bank,
bankLocation,
fdicCertificateNumber,
id,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Balance{balance=$balance, bank=$bank, bankLocation=$bankLocation, fdicCertificateNumber=$fdicCertificateNumber, id=$id, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var balance: JsonField = JsonMissing.of()
private var bank: JsonField = JsonMissing.of()
private var bankLocation: JsonField = JsonMissing.of()
private var fdicCertificateNumber: JsonField = JsonMissing.of()
private var id: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(balance: Balance) = apply {
this.balance = balance.balance
this.bank = balance.bank
this.bankLocation = balance.bankLocation
this.fdicCertificateNumber = balance.fdicCertificateNumber
this.id = balance.id
additionalProperties(balance.additionalProperties)
}
/** The balance, in minor units of `currency`, held with this bank. */
fun balance(balance: Long) = balance(JsonField.of(balance))
/** The balance, in minor units of `currency`, held with this bank. */
@JsonProperty("balance")
@ExcludeMissing
fun balance(balance: JsonField) = apply { this.balance = balance }
/** The name of the bank holding these funds. */
fun bank(bank: String) = bank(JsonField.of(bank))
/** The name of the bank holding these funds. */
@JsonProperty("bank")
@ExcludeMissing
fun bank(bank: JsonField) = apply { this.bank = bank }
/** The primary location of the bank. */
fun bankLocation(bankLocation: BankLocation) = bankLocation(JsonField.of(bankLocation))
/** The primary location of the bank. */
@JsonProperty("bank_location")
@ExcludeMissing
fun bankLocation(bankLocation: JsonField) = apply {
this.bankLocation = bankLocation
}
/**
* The Federal Deposit Insurance Corporation (FDIC) certificate number of the bank.
* Because many banks have the same or similar names, this can be used to uniquely
* identify the institution.
*/
fun fdicCertificateNumber(fdicCertificateNumber: String) =
fdicCertificateNumber(JsonField.of(fdicCertificateNumber))
/**
* The Federal Deposit Insurance Corporation (FDIC) certificate number of the bank.
* Because many banks have the same or similar names, this can be used to uniquely
* identify the institution.
*/
@JsonProperty("fdic_certificate_number")
@ExcludeMissing
fun fdicCertificateNumber(fdicCertificateNumber: JsonField) = apply {
this.fdicCertificateNumber = fdicCertificateNumber
}
/** The identifier of this balance. */
fun id(id: String) = id(JsonField.of(id))
/** The identifier of this balance. */
@JsonProperty("id")
@ExcludeMissing
fun id(id: JsonField) = apply { this.id = id }
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(): Balance =
Balance(
balance,
bank,
bankLocation,
fdicCertificateNumber,
id,
additionalProperties.toUnmodifiable(),
)
}
/** The primary location of the bank. */
@JsonDeserialize(builder = BankLocation.Builder::class)
@NoAutoDetect
class BankLocation
private constructor(
private val city: JsonField,
private val state: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/** The bank's city. */
fun city(): String = city.getRequired("city")
/** The bank's state. */
fun state(): String = state.getRequired("state")
/** The bank's city. */
@JsonProperty("city") @ExcludeMissing fun _city() = city
/** The bank's state. */
@JsonProperty("state") @ExcludeMissing fun _state() = state
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): BankLocation = apply {
if (!validated) {
city()
state()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is BankLocation &&
this.city == other.city &&
this.state == other.state &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
city,
state,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"BankLocation{city=$city, state=$state, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var city: JsonField = JsonMissing.of()
private var state: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(bankLocation: BankLocation) = apply {
this.city = bankLocation.city
this.state = bankLocation.state
additionalProperties(bankLocation.additionalProperties)
}
/** The bank's city. */
fun city(city: String) = city(JsonField.of(city))
/** The bank's city. */
@JsonProperty("city")
@ExcludeMissing
fun city(city: JsonField) = apply { this.city = city }
/** The bank's state. */
fun state(state: String) = state(JsonField.of(state))
/** The bank's state. */
@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(): BankLocation =
BankLocation(
city,
state,
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 {
@JvmField val CAD = Currency(JsonField.of("CAD"))
@JvmField val CHF = Currency(JsonField.of("CHF"))
@JvmField val EUR = Currency(JsonField.of("EUR"))
@JvmField val GBP = Currency(JsonField.of("GBP"))
@JvmField val JPY = Currency(JsonField.of("JPY"))
@JvmField val USD = Currency(JsonField.of("USD"))
@JvmStatic 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 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 {
@JvmField val INTRAFI_BALANCE = Type(JsonField.of("intrafi_balance"))
@JvmStatic fun of(value: String) = Type(JsonField.of(value))
}
enum class Known {
INTRAFI_BALANCE,
}
enum class Value {
INTRAFI_BALANCE,
_UNKNOWN,
}
fun value(): Value =
when (this) {
INTRAFI_BALANCE -> Value.INTRAFI_BALANCE
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
INTRAFI_BALANCE -> Known.INTRAFI_BALANCE
else -> throw IncreaseInvalidDataException("Unknown Type: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
}