chore(api): updates to documentation and additional filter for status on Transactions (#440)

- updates to documentation for Accounts & AccountHolders
- adds status filter to Transactions

Author: stainless-app[bot]

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

@@ -21,11 +21,12 @@ import java.util.Objects
 import java.util.Optional
 
 /**
- * Run an individual or business's information through the Customer Identification Program (CIP).
- * All calls to this endpoint will return an immediate response - though in some cases, the response
- * may indicate the enrollment is under review or further action will be needed to complete the
- * account enrollment process. This endpoint can only be used on accounts that are part of the
- * program that the calling API key manages.
+ * Create an account holder and initiate the appropriate onboarding workflow. Account holders and
+ * accounts have a 1:1 relationship. When an account holder is successfully created an associated
+ * account is also created. All calls to this endpoint will return an immediate response - though in
+ * some cases, the response may indicate the enrollment is under review or further action will be
+ * needed to complete the account enrollment process. This endpoint can only be used on accounts
+ * that are part of the program that the calling API key manages.
  */
 class AccountHolderCreateParams
 constructor(

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

@@ -425,6 +425,8 @@ constructor(
 
             @JvmField val ITIN_LETTER = of("ITIN_LETTER")
 
+            @JvmField val FINCEN_BOI_REPORT = of("FINCEN_BOI_REPORT")
+
             @JvmStatic fun of(value: String) = DocumentType(JsonField.of(value))
         }
 
@@ -447,6 +449,7 @@ constructor(
             UTILITY_BILL_STATEMENT,
             SSN_CARD,
             ITIN_LETTER,
+            FINCEN_BOI_REPORT,
         }
 
         enum class Value {
@@ -468,6 +471,7 @@ constructor(
             UTILITY_BILL_STATEMENT,
             SSN_CARD,
             ITIN_LETTER,
+            FINCEN_BOI_REPORT,
             _UNKNOWN,
         }
 
@@ -491,6 +495,7 @@ constructor(
                 UTILITY_BILL_STATEMENT -> Value.UTILITY_BILL_STATEMENT
                 SSN_CARD -> Value.SSN_CARD
                 ITIN_LETTER -> Value.ITIN_LETTER
+                FINCEN_BOI_REPORT -> Value.FINCEN_BOI_REPORT
                 else -> Value._UNKNOWN
             }
 
@@ -514,6 +519,7 @@ constructor(
                 UTILITY_BILL_STATEMENT -> Known.UTILITY_BILL_STATEMENT
                 SSN_CARD -> Known.SSN_CARD
                 ITIN_LETTER -> Known.ITIN_LETTER
+                FINCEN_BOI_REPORT -> Known.FINCEN_BOI_REPORT
                 else -> throw LithicInvalidDataException("Unknown DocumentType: $value")
             }
 

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

@@ -158,7 +158,7 @@ private constructor(
 
         /**
          * The available spend limit (in cents) relative to the daily limit configured on the
-         * Account.
+         * Account (e.g. 100000 would be a $1,000 limit).
          */
         fun daily(): Optional<Long> = Optional.ofNullable(daily.getNullable("daily"))
 
@@ -176,7 +176,7 @@ private constructor(
 
         /**
          * The available spend limit (in cents) relative to the daily limit configured on the
-         * Account.
+         * Account (e.g. 100000 would be a $1,000 limit).
          */
         @JsonProperty("daily") @ExcludeMissing fun _daily(): JsonField<Long> = daily
 
@@ -233,13 +233,13 @@ private constructor(
 
             /**
              * The available spend limit (in cents) relative to the daily limit configured on the
-             * Account.
+             * Account (e.g. 100000 would be a $1,000 limit).
              */
             fun daily(daily: Long) = daily(JsonField.of(daily))
 
             /**
              * The available spend limit (in cents) relative to the daily limit configured on the
-             * Account.
+             * Account (e.g. 100000 would be a $1,000 limit).
              */
             fun daily(daily: JsonField<Long>) = apply { this.daily = daily }
 

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

@@ -107,8 +107,8 @@ private constructor(
     fun pinStatus(): PinStatus = pinStatus.getRequired("pin_status")
 
     /**
-     * Amount (in cents) to limit approved authorizations. Transaction requests above the spend
-     * limit will be declined.
+     * Amount (in cents) to limit approved authorizations (e.g. 100000 would be a $1,000 limit).
+     * Transaction requests above the spend limit will be declined.
      */
     fun spendLimit(): Long = spendLimit.getRequired("spend_limit")
 
@@ -255,8 +255,8 @@ private constructor(
     @JsonProperty("pin_status") @ExcludeMissing fun _pinStatus(): JsonField<PinStatus> = pinStatus
 
     /**
-     * Amount (in cents) to limit approved authorizations. Transaction requests above the spend
-     * limit will be declined.
+     * Amount (in cents) to limit approved authorizations (e.g. 100000 would be a $1,000 limit).
+     * Transaction requests above the spend limit will be declined.
      */
     @JsonProperty("spend_limit") @ExcludeMissing fun _spendLimit(): JsonField<Long> = spendLimit
 
@@ -534,14 +534,14 @@ private constructor(
         fun pinStatus(pinStatus: JsonField<PinStatus>) = apply { this.pinStatus = pinStatus }
 
         /**
-         * Amount (in cents) to limit approved authorizations. Transaction requests above the spend
-         * limit will be declined.
+         * Amount (in cents) to limit approved authorizations (e.g. 100000 would be a $1,000 limit).
+         * Transaction requests above the spend limit will be declined.
          */
         fun spendLimit(spendLimit: Long) = spendLimit(JsonField.of(spendLimit))
 
         /**
-         * Amount (in cents) to limit approved authorizations. Transaction requests above the spend
-         * limit will be declined.
+         * Amount (in cents) to limit approved authorizations (e.g. 100000 would be a $1,000 limit).
+         * Transaction requests above the spend limit will be declined.
          */
         fun spendLimit(spendLimit: JsonField<Long>) = apply { this.spendLimit = spendLimit }
 

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

@@ -26,9 +26,9 @@ import java.util.Optional
  * `shipping_address`. The card token will be unchanged. The card's type will be altered to
  * `PHYSICAL`. The card will be set to state `PENDING_FULFILLMENT` and fulfilled at next fulfillment
  * cycle. Virtual cards created on card programs which do not support physical cards cannot be
- * converted. The card program cannot be changed as part of the conversion. Cards must be in a state
- * of either `OPEN` or `PAUSED` to be converted. Only applies to cards of type `VIRTUAL` (or
- * existing cards with deprecated types of `DIGITAL_WALLET` and `UNLOCKED`).
+ * converted. The card program cannot be changed as part of the conversion. Cards must be in an
+ * `OPEN` state to be converted. Only applies to cards of type `VIRTUAL` (or existing cards with
+ * deprecated types of `DIGITAL_WALLET` and `UNLOCKED`).
  */
 class CardConvertPhysicalParams
 constructor(

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

@@ -133,10 +133,10 @@ constructor(
     fun shippingMethod(): Optional<ShippingMethod> = body.shippingMethod()
 
     /**
-     * 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.
+     * Amount (in cents) to limit approved authorizations (e.g. 100000 would be a $1,000 limit).
+     * 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(): Optional<Long> = body.spendLimit()
 
@@ -262,10 +262,10 @@ constructor(
     fun _shippingMethod(): JsonField<ShippingMethod> = body._shippingMethod()
 
     /**
-     * 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.
+     * Amount (in cents) to limit approved authorizations (e.g. 100000 would be a $1,000 limit).
+     * 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(): JsonField<Long> = body._spendLimit()
 
@@ -467,10 +467,11 @@ constructor(
             Optional.ofNullable(shippingMethod.getNullable("shipping_method"))
 
         /**
-         * 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.
+         * Amount (in cents) to limit approved authorizations (e.g. 100000 would be a $1,000 limit).
+         * 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(): Optional<Long> =
             Optional.ofNullable(spendLimit.getNullable("spend_limit"))
@@ -615,10 +616,11 @@ constructor(
         fun _shippingMethod(): JsonField<ShippingMethod> = shippingMethod
 
         /**
-         * 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.
+         * Amount (in cents) to limit approved authorizations (e.g. 100000 would be a $1,000 limit).
+         * 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") @ExcludeMissing fun _spendLimit(): JsonField<Long> = spendLimit
 
@@ -957,18 +959,20 @@ constructor(
             }
 
             /**
-             * 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.
+             * Amount (in cents) to limit approved authorizations (e.g. 100000 would be a $1,000
+             * limit). 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) = spendLimit(JsonField.of(spendLimit))
 
             /**
-             * 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.
+             * Amount (in cents) to limit approved authorizations (e.g. 100000 would be a $1,000
+             * limit). 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: JsonField<Long>) = apply { this.spendLimit = spendLimit }
 
@@ -1333,18 +1337,20 @@ constructor(
         }
 
         /**
-         * 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.
+         * Amount (in cents) to limit approved authorizations (e.g. 100000 would be a $1,000 limit).
+         * 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 { body.spendLimit(spendLimit) }
 
         /**
-         * 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.
+         * Amount (in cents) to limit approved authorizations (e.g. 100000 would be a $1,000 limit).
+         * 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: JsonField<Long>) = apply { body.spendLimit(spendLimit) }
 

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

@@ -157,7 +157,8 @@ private constructor(
     ) {
 
         /**
-         * The available spend limit (in cents) relative to the annual limit configured on the Card.
+         * The available spend limit (in cents) relative to the annual limit configured on the Card
+         * (e.g. 100000 would be a $1,000 limit).
          */
         fun annually(): Optional<Long> = Optional.ofNullable(annually.getNullable("annually"))
 
@@ -174,7 +175,8 @@ private constructor(
         fun monthly(): Optional<Long> = Optional.ofNullable(monthly.getNullable("monthly"))
 
         /**
-         * The available spend limit (in cents) relative to the annual limit configured on the Card.
+         * The available spend limit (in cents) relative to the annual limit configured on the Card
+         * (e.g. 100000 would be a $1,000 limit).
          */
         @JsonProperty("annually") @ExcludeMissing fun _annually(): JsonField<Long> = annually
 
@@ -231,13 +233,13 @@ private constructor(
 
             /**
              * The available spend limit (in cents) relative to the annual limit configured on the
-             * Card.
+             * Card (e.g. 100000 would be a $1,000 limit).
              */
             fun annually(annually: Long) = annually(JsonField.of(annually))
 
             /**
              * The available spend limit (in cents) relative to the annual limit configured on the
-             * Card.
+             * Card (e.g. 100000 would be a $1,000 limit).
              */
             fun annually(annually: JsonField<Long>) = apply { this.annually = annually }