chore(api): small updates to verification addresses and Statement and LoanTape fields (#324)

- mark `verification_address` as deprecated when updating an Account
- add `statement_type` to Statements
- add `ending_balance` and `available_credit` to LoanTapes

Author: stainless-app[bot]

lithic-java-core/src/main/kotlin/com/lithic/api/models/AccountUpdateParams.kt

@@ -106,7 +106,8 @@ constructor(
 
         /**
          * Address used during Address Verification Service (AVS) checks during transactions if
-         * enabled via Auth Rules.
+         * enabled via Auth Rules. This field is deprecated as AVS checks are no longer supported by
+         * Authorization Rules. The field will be removed from the schema in a future release.
          */
         @JsonProperty("verification_address")
         fun verificationAddress(): VerificationAddress? = verificationAddress
@@ -177,7 +178,9 @@ constructor(
 
             /**
              * Address used during Address Verification Service (AVS) checks during transactions if
-             * enabled via Auth Rules.
+             * enabled via Auth Rules. This field is deprecated as AVS checks are no longer
+             * supported by Authorization Rules. The field will be removed from the schema in a
+             * future release.
              */
             @JsonProperty("verification_address")
             fun verificationAddress(verificationAddress: VerificationAddress) = apply {
@@ -352,7 +355,8 @@ constructor(
 
         /**
          * Address used during Address Verification Service (AVS) checks during transactions if
-         * enabled via Auth Rules.
+         * enabled via Auth Rules. This field is deprecated as AVS checks are no longer supported by
+         * Authorization Rules. The field will be removed from the schema in a future release.
          */
         fun verificationAddress(verificationAddress: VerificationAddress) = apply {
             this.verificationAddress = verificationAddress
@@ -485,7 +489,8 @@ constructor(
 
     /**
      * Address used during Address Verification Service (AVS) checks during transactions if enabled
-     * via Auth Rules.
+     * via Auth Rules. This field is deprecated as AVS checks are no longer supported by
+     * Authorization Rules. The field will be removed from the schema in a future release.
      */
     @JsonDeserialize(builder = VerificationAddress.Builder::class)
     @NoAutoDetect

lithic-java-core/src/main/kotlin/com/lithic/api/models/LoanTape.kt

@@ -36,7 +36,9 @@ private constructor(
     private val balancePastDue: JsonField<CategoryBalances>,
     private val balanceDue: JsonField<CategoryBalances>,
     private val balanceNextDue: JsonField<CategoryBalances>,
+    private val endingBalance: JsonField<Long>,
     private val creditLimit: JsonField<Long>,
+    private val availableCredit: JsonField<Long>,
     private val excessCredits: JsonField<Long>,
     private val accountStanding: JsonField<AccountStanding>,
     private val creditProductToken: JsonField<String>,
@@ -89,12 +91,18 @@ private constructor(
      */
     fun balanceNextDue(): CategoryBalances = balanceNextDue.getRequired("balance_next_due")
 
+    /** Balance at the end of the day */
+    fun endingBalance(): Long = endingBalance.getRequired("ending_balance")
+
     /**
      * For prepay accounts, this is the minimum prepay balance that must be maintained. For charge
      * card accounts, this is the maximum credit balance extended by a lender
      */
     fun creditLimit(): Long = creditLimit.getRequired("credit_limit")
 
+    /** Amount of credit available to spend in cents */
+    fun availableCredit(): Long = availableCredit.getRequired("available_credit")
+
     /**
      * Excess credits in the form of provisional credits, payments, or purchase refunds. If
      * positive, the account is in net credit state with no outstanding balances. An overpayment
@@ -159,12 +167,18 @@ private constructor(
      */
     @JsonProperty("balance_next_due") @ExcludeMissing fun _balanceNextDue() = balanceNextDue
 
+    /** Balance at the end of the day */
+    @JsonProperty("ending_balance") @ExcludeMissing fun _endingBalance() = endingBalance
+
     /**
      * For prepay accounts, this is the minimum prepay balance that must be maintained. For charge
      * card accounts, this is the maximum credit balance extended by a lender
      */
     @JsonProperty("credit_limit") @ExcludeMissing fun _creditLimit() = creditLimit
 
+    /** Amount of credit available to spend in cents */
+    @JsonProperty("available_credit") @ExcludeMissing fun _availableCredit() = availableCredit
+
     /**
      * Excess credits in the form of provisional credits, payments, or purchase refunds. If
      * positive, the account is in net credit state with no outstanding balances. An overpayment
@@ -210,7 +224,9 @@ private constructor(
             balancePastDue().validate()
             balanceDue().validate()
             balanceNextDue().validate()
+            endingBalance()
             creditLimit()
+            availableCredit()
             excessCredits()
             accountStanding().validate()
             creditProductToken()
@@ -243,7 +259,9 @@ private constructor(
         private var balancePastDue: JsonField<CategoryBalances> = JsonMissing.of()
         private var balanceDue: JsonField<CategoryBalances> = JsonMissing.of()
         private var balanceNextDue: JsonField<CategoryBalances> = JsonMissing.of()
+        private var endingBalance: JsonField<Long> = JsonMissing.of()
         private var creditLimit: JsonField<Long> = JsonMissing.of()
+        private var availableCredit: JsonField<Long> = JsonMissing.of()
         private var excessCredits: JsonField<Long> = JsonMissing.of()
         private var accountStanding: JsonField<AccountStanding> = JsonMissing.of()
         private var creditProductToken: JsonField<String> = JsonMissing.of()
@@ -267,7 +285,9 @@ private constructor(
             this.balancePastDue = loanTape.balancePastDue
             this.balanceDue = loanTape.balanceDue
             this.balanceNextDue = loanTape.balanceNextDue
+            this.endingBalance = loanTape.endingBalance
             this.creditLimit = loanTape.creditLimit
+            this.availableCredit = loanTape.availableCredit
             this.excessCredits = loanTape.excessCredits
             this.accountStanding = loanTape.accountStanding
             this.creditProductToken = loanTape.creditProductToken
@@ -393,6 +413,16 @@ private constructor(
             this.balanceNextDue = balanceNextDue
         }
 
+        /** Balance at the end of the day */
+        fun endingBalance(endingBalance: Long) = endingBalance(JsonField.of(endingBalance))
+
+        /** Balance at the end of the day */
+        @JsonProperty("ending_balance")
+        @ExcludeMissing
+        fun endingBalance(endingBalance: JsonField<Long>) = apply {
+            this.endingBalance = endingBalance
+        }
+
         /**
          * For prepay accounts, this is the minimum prepay balance that must be maintained. For
          * charge card accounts, this is the maximum credit balance extended by a lender
@@ -407,6 +437,16 @@ private constructor(
         @ExcludeMissing
         fun creditLimit(creditLimit: JsonField<Long>) = apply { this.creditLimit = creditLimit }
 
+        /** Amount of credit available to spend in cents */
+        fun availableCredit(availableCredit: Long) = availableCredit(JsonField.of(availableCredit))
+
+        /** Amount of credit available to spend in cents */
+        @JsonProperty("available_credit")
+        @ExcludeMissing
+        fun availableCredit(availableCredit: JsonField<Long>) = apply {
+            this.availableCredit = availableCredit
+        }
+
         /**
          * Excess credits in the form of provisional credits, payments, or purchase refunds. If
          * positive, the account is in net credit state with no outstanding balances. An overpayment
@@ -508,7 +548,9 @@ private constructor(
                 balancePastDue,
                 balanceDue,
                 balanceNextDue,
+                endingBalance,
                 creditLimit,
+                availableCredit,
                 excessCredits,
                 accountStanding,
                 creditProductToken,
@@ -1341,7 +1383,9 @@ private constructor(
             this.balancePastDue == other.balancePastDue &&
             this.balanceDue == other.balanceDue &&
             this.balanceNextDue == other.balanceNextDue &&
+            this.endingBalance == other.endingBalance &&
             this.creditLimit == other.creditLimit &&
+            this.availableCredit == other.availableCredit &&
             this.excessCredits == other.excessCredits &&
             this.accountStanding == other.accountStanding &&
             this.creditProductToken == other.creditProductToken &&
@@ -1370,7 +1414,9 @@ private constructor(
                     balancePastDue,
                     balanceDue,
                     balanceNextDue,
+                    endingBalance,
                     creditLimit,
+                    availableCredit,
                     excessCredits,
                     accountStanding,
                     creditProductToken,
@@ -1385,5 +1431,5 @@ private constructor(
     }
 
     override fun toString() =
-        "LoanTape{token=$token, financialAccountToken=$financialAccountToken, date=$date, created=$created, updated=$updated, version=$version, ytdTotals=$ytdTotals, periodTotals=$periodTotals, dayTotals=$dayTotals, balancePastDue=$balancePastDue, balanceDue=$balanceDue, balanceNextDue=$balanceNextDue, creditLimit=$creditLimit, excessCredits=$excessCredits, accountStanding=$accountStanding, creditProductToken=$creditProductToken, tier=$tier, paymentAllocation=$paymentAllocation, minimumPaymentBalance=$minimumPaymentBalance, previousStatementBalance=$previousStatementBalance, additionalProperties=$additionalProperties}"
+        "LoanTape{token=$token, financialAccountToken=$financialAccountToken, date=$date, created=$created, updated=$updated, version=$version, ytdTotals=$ytdTotals, periodTotals=$periodTotals, dayTotals=$dayTotals, balancePastDue=$balancePastDue, balanceDue=$balanceDue, balanceNextDue=$balanceNextDue, endingBalance=$endingBalance, creditLimit=$creditLimit, availableCredit=$availableCredit, excessCredits=$excessCredits, accountStanding=$accountStanding, creditProductToken=$creditProductToken, tier=$tier, paymentAllocation=$paymentAllocation, minimumPaymentBalance=$minimumPaymentBalance, previousStatementBalance=$previousStatementBalance, additionalProperties=$additionalProperties}"
 }

lithic-java-core/src/main/kotlin/com/lithic/api/models/Statement.kt

@@ -44,6 +44,7 @@ private constructor(
     private val accountStanding: JsonField<AccountStanding>,
     private val amountDue: JsonField<AmountDue>,
     private val interestDetails: JsonField<InterestDetails>,
+    private val statementType: JsonField<StatementType>,
     private val additionalProperties: Map<String, JsonValue>,
 ) {
 
@@ -111,6 +112,8 @@ private constructor(
     fun interestDetails(): Optional<InterestDetails> =
         Optional.ofNullable(interestDetails.getNullable("interest_details"))
 
+    fun statementType(): StatementType = statementType.getRequired("statement_type")
+
     /** Globally unique identifier for a statement */
     @JsonProperty("token") @ExcludeMissing fun _token() = token
 
@@ -181,6 +184,8 @@ private constructor(
 
     @JsonProperty("interest_details") @ExcludeMissing fun _interestDetails() = interestDetails
 
+    @JsonProperty("statement_type") @ExcludeMissing fun _statementType() = statementType
+
     @JsonAnyGetter
     @ExcludeMissing
     fun _additionalProperties(): Map<String, JsonValue> = additionalProperties
@@ -207,6 +212,7 @@ private constructor(
             accountStanding().validate()
             amountDue().validate()
             interestDetails().map { it.validate() }
+            statementType()
             validated = true
         }
     }
@@ -240,6 +246,7 @@ private constructor(
         private var accountStanding: JsonField<AccountStanding> = JsonMissing.of()
         private var amountDue: JsonField<AmountDue> = JsonMissing.of()
         private var interestDetails: JsonField<InterestDetails> = JsonMissing.of()
+        private var statementType: JsonField<StatementType> = JsonMissing.of()
         private var additionalProperties: MutableMap<String, JsonValue> = mutableMapOf()
 
         @JvmSynthetic
@@ -264,6 +271,7 @@ private constructor(
             this.accountStanding = statement.accountStanding
             this.amountDue = statement.amountDue
             this.interestDetails = statement.interestDetails
+            this.statementType = statement.statementType
             additionalProperties(statement.additionalProperties)
         }
 
@@ -460,6 +468,14 @@ private constructor(
             this.interestDetails = interestDetails
         }
 
+        fun statementType(statementType: StatementType) = statementType(JsonField.of(statementType))
+
+        @JsonProperty("statement_type")
+        @ExcludeMissing
+        fun statementType(statementType: JsonField<StatementType>) = apply {
+            this.statementType = statementType
+        }
+
         fun additionalProperties(additionalProperties: Map<String, JsonValue>) = apply {
             this.additionalProperties.clear()
             this.additionalProperties.putAll(additionalProperties)
@@ -496,6 +512,7 @@ private constructor(
                 accountStanding,
                 amountDue,
                 interestDetails,
+                statementType,
                 additionalProperties.toUnmodifiable(),
             )
     }
@@ -1196,6 +1213,63 @@ private constructor(
             "StatementTotals{payments=$payments, purchases=$purchases, fees=$fees, credits=$credits, interest=$interest, cashAdvances=$cashAdvances, balanceTransfers=$balanceTransfers, additionalProperties=$additionalProperties}"
     }
 
+    class StatementType
+    @JsonCreator
+    private constructor(
+        private val value: JsonField<String>,
+    ) : Enum {
+
+        @com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField<String> = value
+
+        override fun equals(other: Any?): Boolean {
+            if (this === other) {
+                return true
+            }
+
+            return other is StatementType && this.value == other.value
+        }
+
+        override fun hashCode() = value.hashCode()
+
+        override fun toString() = value.toString()
+
+        companion object {
+
+            @JvmField val INITIAL = StatementType(JsonField.of("INITIAL"))
+
+            @JvmField val PERIOD_END = StatementType(JsonField.of("PERIOD_END"))
+
+            @JvmStatic fun of(value: String) = StatementType(JsonField.of(value))
+        }
+
+        enum class Known {
+            INITIAL,
+            PERIOD_END,
+        }
+
+        enum class Value {
+            INITIAL,
+            PERIOD_END,
+            _UNKNOWN,
+        }
+
+        fun value(): Value =
+            when (this) {
+                INITIAL -> Value.INITIAL
+                PERIOD_END -> Value.PERIOD_END
+                else -> Value._UNKNOWN
+            }
+
+        fun known(): Known =
+            when (this) {
+                INITIAL -> Known.INITIAL
+                PERIOD_END -> Known.PERIOD_END
+                else -> throw LithicInvalidDataException("Unknown StatementType: $value")
+            }
+
+        fun asString(): String = _value().asStringOrThrow()
+    }
+
     @JsonDeserialize(builder = InterestDetails.Builder::class)
     @NoAutoDetect
     class InterestDetails
@@ -1655,6 +1729,7 @@ private constructor(
             this.accountStanding == other.accountStanding &&
             this.amountDue == other.amountDue &&
             this.interestDetails == other.interestDetails &&
+            this.statementType == other.statementType &&
             this.additionalProperties == other.additionalProperties
     }
 
@@ -1684,12 +1759,13 @@ private constructor(
                     accountStanding,
                     amountDue,
                     interestDetails,
+                    statementType,
                     additionalProperties,
                 )
         }
         return hashCode
     }
 
     override fun toString() =
-        "Statement{token=$token, financialAccountToken=$financialAccountToken, statementStartDate=$statementStartDate, statementEndDate=$statementEndDate, nextStatementEndDate=$nextStatementEndDate, paymentDueDate=$paymentDueDate, nextPaymentDueDate=$nextPaymentDueDate, daysInBillingCycle=$daysInBillingCycle, creditLimit=$creditLimit, availableCredit=$availableCredit, startingBalance=$startingBalance, endingBalance=$endingBalance, periodTotals=$periodTotals, ytdTotals=$ytdTotals, created=$created, updated=$updated, creditProductToken=$creditProductToken, accountStanding=$accountStanding, amountDue=$amountDue, interestDetails=$interestDetails, additionalProperties=$additionalProperties}"
+        "Statement{token=$token, financialAccountToken=$financialAccountToken, statementStartDate=$statementStartDate, statementEndDate=$statementEndDate, nextStatementEndDate=$nextStatementEndDate, paymentDueDate=$paymentDueDate, nextPaymentDueDate=$nextPaymentDueDate, daysInBillingCycle=$daysInBillingCycle, creditLimit=$creditLimit, availableCredit=$availableCredit, startingBalance=$startingBalance, endingBalance=$endingBalance, periodTotals=$periodTotals, ytdTotals=$ytdTotals, created=$created, updated=$updated, creditProductToken=$creditProductToken, accountStanding=$accountStanding, amountDue=$amountDue, interestDetails=$interestDetails, statementType=$statementType, additionalProperties=$additionalProperties}"
 }

lithic-java-core/src/main/kotlin/com/lithic/api/services/async/AccountServiceAsync.kt

@@ -24,10 +24,9 @@ interface AccountServiceAsync {
     ): CompletableFuture<Account>
 
     /**
-     * Update account configuration such as spend limits and verification address. Can only be run
-     * on accounts that are part of the program managed by this API key.
-     *
-     * Accounts that are in the `PAUSED` state will not be able to transact or create new cards.
+     * Update account configuration such as state or spend limits. Can only be run on accounts that
+     * are part of the program managed by this API key. Accounts that are in the `PAUSED` state will
+     * not be able to transact or create new cards.
      */
     @JvmOverloads
     fun update(

lithic-java-core/src/main/kotlin/com/lithic/api/services/async/AccountServiceAsyncImpl.kt

@@ -61,10 +61,9 @@ constructor(
         jsonHandler<Account>(clientOptions.jsonMapper).withErrorHandler(errorHandler)
 
     /**
-     * Update account configuration such as spend limits and verification address. Can only be run
-     * on accounts that are part of the program managed by this API key.
-     *
-     * Accounts that are in the `PAUSED` state will not be able to transact or create new cards.
+     * Update account configuration such as state or spend limits. Can only be run on accounts that
+     * are part of the program managed by this API key. Accounts that are in the `PAUSED` state will
+     * not be able to transact or create new cards.
      */
     override fun update(
         params: AccountUpdateParams,

lithic-java-core/src/main/kotlin/com/lithic/api/services/blocking/AccountService.kt

@@ -23,10 +23,9 @@ interface AccountService {
     ): Account
 
     /**
-     * Update account configuration such as spend limits and verification address. Can only be run
-     * on accounts that are part of the program managed by this API key.
-     *
-     * Accounts that are in the `PAUSED` state will not be able to transact or create new cards.
+     * Update account configuration such as state or spend limits. Can only be run on accounts that
+     * are part of the program managed by this API key. Accounts that are in the `PAUSED` state will
+     * not be able to transact or create new cards.
      */
     @JvmOverloads
     fun update(