docs: add more documentation (#450)

Author: stainless-app[bot]

buildSrc/src/main/kotlin/lithic.kotlin.gradle.kts

@@ -21,8 +21,12 @@ configure<SpotlessExtension> {
 
 tasks.withType<KotlinCompile>().configureEach {
     kotlinOptions {
-        allWarningsAsErrors = true
-        freeCompilerArgs = listOf("-Xjvm-default=all", "-Xjdk-release=1.8")
+        freeCompilerArgs = listOf(
+          "-Xjvm-default=all",
+          "-Xjdk-release=1.8",
+          // Suppress deprecation warnings because we may still reference and test deprecated members.
+          "-Xsuppress-warning=DEPRECATION"
+        )
         jvmTarget = "1.8"
     }
 }

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

@@ -88,13 +88,15 @@ private constructor(
      * removed from the schema in a future release. Use the `/auth_rules` endpoints to fetch Auth
      * Rule information instead.
      */
+    @Deprecated("deprecated")
     fun authRuleTokens(): Optional<List<String>> =
         Optional.ofNullable(authRuleTokens.getNullable("auth_rule_tokens"))
 
     /** 3-digit alphabetic ISO 4217 code for the currency of the cardholder. */
     fun cardholderCurrency(): Optional<String> =
         Optional.ofNullable(cardholderCurrency.getNullable("cardholder_currency"))
 
+    @Deprecated("deprecated")
     fun verificationAddress(): Optional<VerificationAddress> =
         Optional.ofNullable(verificationAddress.getNullable("verification_address"))
 
@@ -142,6 +144,7 @@ private constructor(
      * removed from the schema in a future release. Use the `/auth_rules` endpoints to fetch Auth
      * Rule information instead.
      */
+    @Deprecated("deprecated")
     @JsonProperty("auth_rule_tokens")
     @ExcludeMissing
     fun _authRuleTokens(): JsonField<List<String>> = authRuleTokens
@@ -151,6 +154,7 @@ private constructor(
     @ExcludeMissing
     fun _cardholderCurrency(): JsonField<String> = cardholderCurrency
 
+    @Deprecated("deprecated")
     @JsonProperty("verification_address")
     @ExcludeMissing
     fun _verificationAddress(): JsonField<VerificationAddress> = verificationAddress
@@ -293,6 +297,7 @@ private constructor(
          * be removed from the schema in a future release. Use the `/auth_rules` endpoints to fetch
          * Auth Rule information instead.
          */
+        @Deprecated("deprecated")
         fun authRuleTokens(authRuleTokens: List<String>) =
             authRuleTokens(JsonField.of(authRuleTokens))
 
@@ -302,6 +307,7 @@ private constructor(
          * be removed from the schema in a future release. Use the `/auth_rules` endpoints to fetch
          * Auth Rule information instead.
          */
+        @Deprecated("deprecated")
         fun authRuleTokens(authRuleTokens: JsonField<List<String>>) = apply {
             this.authRuleTokens = authRuleTokens.map { it.toMutableList() }
         }
@@ -312,6 +318,7 @@ private constructor(
          * be removed from the schema in a future release. Use the `/auth_rules` endpoints to fetch
          * Auth Rule information instead.
          */
+        @Deprecated("deprecated")
         fun addAuthRuleToken(authRuleToken: String) = apply {
             authRuleTokens =
                 (authRuleTokens ?: JsonField.of(mutableListOf())).apply {
@@ -334,9 +341,11 @@ private constructor(
             this.cardholderCurrency = cardholderCurrency
         }
 
+        @Deprecated("deprecated")
         fun verificationAddress(verificationAddress: VerificationAddress) =
             verificationAddress(JsonField.of(verificationAddress))
 
+        @Deprecated("deprecated")
         fun verificationAddress(verificationAddress: JsonField<VerificationAddress>) = apply {
             this.verificationAddress = verificationAddress
         }
@@ -518,6 +527,16 @@ private constructor(
             "SpendLimit{daily=$daily, lifetime=$lifetime, monthly=$monthly, additionalProperties=$additionalProperties}"
     }
 
+    /**
+     * Account state:
+     * - `ACTIVE` - Account is able to transact and create new cards.
+     * - `PAUSED` - Account will not be able to transact or create new cards. It can be set back to
+     *   `ACTIVE`.
+     * - `CLOSED` - Account will not be able to transact or create new cards. `CLOSED` accounts are
+     *   also unable to be transitioned to `ACTIVE` or `PAUSED` states. `CLOSED` accounts result
+     *   from failing to pass KYB/KYC or Lithic closing for risk/compliance reasons. Please contact
+     *   [support@lithic.com](mailto:support@lithic.com) if you believe this was in error.
+     */
     class State
     @JsonCreator
     private constructor(
@@ -764,6 +783,7 @@ private constructor(
             "AccountHolder{token=$token, businessAccountToken=$businessAccountToken, email=$email, phoneNumber=$phoneNumber, additionalProperties=$additionalProperties}"
     }
 
+    @Deprecated("deprecated")
     @NoAutoDetect
     class VerificationAddress
     @JsonCreator

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

@@ -7,6 +7,7 @@ import com.lithic.api.core.Enum
 import com.lithic.api.core.JsonField
 import com.lithic.api.errors.LithicInvalidDataException
 
+/** Type of account financial account */
 class AccountFinancialAccountType
 @JsonCreator
 private constructor(

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

@@ -1349,6 +1349,7 @@ private constructor(
             "AccountHolderIndividualResponse{address=$address, dob=$dob, email=$email, entityToken=$entityToken, firstName=$firstName, lastName=$lastName, phoneNumber=$phoneNumber, additionalProperties=$additionalProperties}"
     }
 
+    /** The type of KYC exemption for a KYC-Exempt Account Holder. */
     class ExemptionType
     @JsonCreator
     private constructor(
@@ -1406,6 +1407,14 @@ private constructor(
         override fun toString() = value.toString()
     }
 
+    /**
+     * <Deprecated. Use verification_application.status instead>
+     *
+     * KYC and KYB evaluation states.
+     *
+     * Note:
+     * - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
+     */
     class Status
     @JsonCreator
     private constructor(
@@ -1592,6 +1601,12 @@ private constructor(
         override fun toString() = value.toString()
     }
 
+    /**
+     * The type of Account Holder. If the type is "INDIVIDUAL", the "individual" attribute will be
+     * present. If the type is "BUSINESS" then the "business_entity", "control_person",
+     * "beneficial_owner_individuals", "beneficial_owner_entities", "nature_of_business", and
+     * "website_url" attributes will be present.
+     */
     class UserType
     @JsonCreator
     private constructor(
@@ -1835,6 +1850,12 @@ private constructor(
                 )
         }
 
+        /**
+         * KYC and KYB evaluation states.
+         *
+         * Note:
+         * - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
+         */
         class Status
         @JsonCreator
         private constructor(

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

@@ -304,6 +304,12 @@ private constructor(
             )
     }
 
+    /**
+     * KYC and KYB evaluation states.
+     *
+     * Note:
+     * - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
+     */
     class Status
     @JsonCreator
     private constructor(
@@ -379,6 +385,7 @@ private constructor(
         override fun toString() = value.toString()
     }
 
+    /** Status Reasons for KYC/KYB enrollment states */
     class StatusReasons
     @JsonCreator
     private constructor(

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

@@ -19,6 +19,7 @@ import java.util.Optional
 import java.util.stream.Stream
 import java.util.stream.StreamSupport
 
+/** Get a list of individual or business account holders and their KYC or KYB evaluation status. */
 class AccountHolderListPage
 private constructor(
     private val accountHoldersService: AccountHolderService,

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

@@ -20,6 +20,7 @@ import java.util.concurrent.CompletableFuture
 import java.util.concurrent.Executor
 import java.util.function.Predicate
 
+/** Get a list of individual or business account holders and their KYC or KYB evaluation status. */
 class AccountHolderListPageAsync
 private constructor(
     private val accountHoldersService: AccountHolderServiceAsync,

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

@@ -485,6 +485,7 @@ constructor(
             )
     }
 
+    /** An account holder document's upload status for use within the simulation. */
     class Status
     @JsonCreator
     private constructor(
@@ -554,6 +555,10 @@ constructor(
         override fun toString() = value.toString()
     }
 
+    /**
+     * Status reason that will be associated with the simulated account holder status. Only required
+     * for a `REJECTED` status or `PARTIAL_APPROVAL` status.
+     */
     class DocumentUploadStatusReasons
     @JsonCreator
     private constructor(

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

@@ -443,6 +443,7 @@ constructor(
             )
     }
 
+    /** An account holder's status for use within the simulation. */
     class Status
     @JsonCreator
     private constructor(

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

@@ -1886,6 +1886,10 @@ private constructor(
             "Individual{address=$address, dob=$dob, email=$email, firstName=$firstName, governmentId=$governmentId, lastName=$lastName, phoneNumber=$phoneNumber, additionalProperties=$additionalProperties}"
     }
 
+    /**
+     * The type of KYC exemption for a KYC-Exempt Account Holder. "None" if the account holder is
+     * not KYC-Exempt.
+     */
     class ExemptionType
     @JsonCreator
     private constructor(
@@ -1943,6 +1947,14 @@ private constructor(
         override fun toString() = value.toString()
     }
 
+    /**
+     * <Deprecated. Use verification_application.status instead>
+     *
+     * KYC and KYB evaluation states.
+     *
+     * Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the `ADVANCED`
+     * workflow.
+     */
     class Status
     @JsonCreator
     private constructor(
@@ -2012,6 +2024,7 @@ private constructor(
         override fun toString() = value.toString()
     }
 
+    /** Status Reasons for KYC/KYB enrollment states */
     class StatusReasons
     @JsonCreator
     private constructor(
@@ -2250,6 +2263,15 @@ private constructor(
         override fun toString() = value.toString()
     }
 
+    /**
+     * The type of Account Holder. If the type is "INDIVIDUAL", the "individual" attribute will be
+     * present.
+     *
+     * If the type is "BUSINESS" then the "business_entity", "control_person",
+     * "beneficial_owner_individuals", "beneficial_owner_entities",
+     *
+     * "nature_of_business", and "website_url" attributes will be present.
+     */
     class UserType
     @JsonCreator
     private constructor(
@@ -2486,6 +2508,12 @@ private constructor(
                 )
         }
 
+        /**
+         * KYC and KYB evaluation states.
+         *
+         * Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the `ADVANCED`
+         * workflow.
+         */
         class Status
         @JsonCreator
         private constructor(
@@ -2555,6 +2583,7 @@ private constructor(
             override fun toString() = value.toString()
         }
 
+        /** Status Reasons for KYC/KYB enrollment states */
         class StatusReasons
         @JsonCreator
         private constructor(