feat(api): add pending_reviewing check transfer status

.stats.yml

@@ -1,3 +1,3 @@
 configured_endpoints: 238
-openapi_spec_hash: a3c78cac10e5975eabebfb290f14b814
+openapi_spec_hash: f0bad5120513d7de237614c51d7b56e8
 config_hash: 2ae0d8aaecf01b38cbf9f9e112822c23

increase-java-core/src/main/kotlin/com/increase/api/models/beneficialowners/BeneficialOwnerCreateParams.kt

@@ -33,7 +33,8 @@ private constructor(
 ) : Params {
 
     /**
-     * The identifier of the Entity to associate with the new Beneficial Owner.
+     * The identifier of the Entity to associate with the new Beneficial Owner. Only `corporation`
+     * entities have beneficial owners.
      *
      * @throws IncreaseInvalidDataException if the JSON field has an unexpected type or is
      *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
@@ -144,7 +145,10 @@ private constructor(
          */
         fun body(body: Body) = apply { this.body = body.toBuilder() }
 
-        /** The identifier of the Entity to associate with the new Beneficial Owner. */
+        /**
+         * The identifier of the Entity to associate with the new Beneficial Owner. Only
+         * `corporation` entities have beneficial owners.
+         */
         fun entityId(entityId: String) = apply { body.entityId(entityId) }
 
         /**
@@ -376,7 +380,8 @@ private constructor(
         ) : this(entityId, individual, prongs, companyTitle, mutableMapOf())
 
         /**
-         * The identifier of the Entity to associate with the new Beneficial Owner.
+         * The identifier of the Entity to associate with the new Beneficial Owner. Only
+         * `corporation` entities have beneficial owners.
          *
          * @throws IncreaseInvalidDataException if the JSON field has an unexpected type or is
          *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
@@ -487,7 +492,10 @@ private constructor(
                 additionalProperties = body.additionalProperties.toMutableMap()
             }
 
-            /** The identifier of the Entity to associate with the new Beneficial Owner. */
+            /**
+             * The identifier of the Entity to associate with the new Beneficial Owner. Only
+             * `corporation` entities have beneficial owners.
+             */
             fun entityId(entityId: String) = entityId(JsonField.of(entityId))
 
             /**

increase-java-core/src/main/kotlin/com/increase/api/models/checktransfers/CheckTransfer.kt

@@ -6052,6 +6052,9 @@ private constructor(
             /** The transfer is pending submission. */
             @JvmField val PENDING_SUBMISSION = of("pending_submission")
 
+            /** The transfer is pending review by Increase. */
+            @JvmField val PENDING_REVIEWING = of("pending_reviewing")
+
             /** The transfer requires attention from an Increase operator. */
             @JvmField val REQUIRES_ATTENTION = of("requires_attention")
 
@@ -6084,6 +6087,8 @@ private constructor(
             CANCELED,
             /** The transfer is pending submission. */
             PENDING_SUBMISSION,
+            /** The transfer is pending review by Increase. */
+            PENDING_REVIEWING,
             /** The transfer requires attention from an Increase operator. */
             REQUIRES_ATTENTION,
             /** The transfer has been rejected. */
@@ -6116,6 +6121,8 @@ private constructor(
             CANCELED,
             /** The transfer is pending submission. */
             PENDING_SUBMISSION,
+            /** The transfer is pending review by Increase. */
+            PENDING_REVIEWING,
             /** The transfer requires attention from an Increase operator. */
             REQUIRES_ATTENTION,
             /** The transfer has been rejected. */
@@ -6146,6 +6153,7 @@ private constructor(
                 PENDING_APPROVAL -> Value.PENDING_APPROVAL
                 CANCELED -> Value.CANCELED
                 PENDING_SUBMISSION -> Value.PENDING_SUBMISSION
+                PENDING_REVIEWING -> Value.PENDING_REVIEWING
                 REQUIRES_ATTENTION -> Value.REQUIRES_ATTENTION
                 REJECTED -> Value.REJECTED
                 PENDING_MAILING -> Value.PENDING_MAILING
@@ -6170,6 +6178,7 @@ private constructor(
                 PENDING_APPROVAL -> Known.PENDING_APPROVAL
                 CANCELED -> Known.CANCELED
                 PENDING_SUBMISSION -> Known.PENDING_SUBMISSION
+                PENDING_REVIEWING -> Known.PENDING_REVIEWING
                 REQUIRES_ATTENTION -> Known.REQUIRES_ATTENTION
                 REJECTED -> Known.REJECTED
                 PENDING_MAILING -> Known.PENDING_MAILING

increase-java-core/src/main/kotlin/com/increase/api/models/checktransfers/CheckTransferListParams.kt

@@ -608,6 +608,9 @@ private constructor(
                 /** The transfer is pending submission. */
                 @JvmField val PENDING_SUBMISSION = of("pending_submission")
 
+                /** The transfer is pending review by Increase. */
+                @JvmField val PENDING_REVIEWING = of("pending_reviewing")
+
                 /** The transfer requires attention from an Increase operator. */
                 @JvmField val REQUIRES_ATTENTION = of("requires_attention")
 
@@ -640,6 +643,8 @@ private constructor(
                 CANCELED,
                 /** The transfer is pending submission. */
                 PENDING_SUBMISSION,
+                /** The transfer is pending review by Increase. */
+                PENDING_REVIEWING,
                 /** The transfer requires attention from an Increase operator. */
                 REQUIRES_ATTENTION,
                 /** The transfer has been rejected. */
@@ -672,6 +677,8 @@ private constructor(
                 CANCELED,
                 /** The transfer is pending submission. */
                 PENDING_SUBMISSION,
+                /** The transfer is pending review by Increase. */
+                PENDING_REVIEWING,
                 /** The transfer requires attention from an Increase operator. */
                 REQUIRES_ATTENTION,
                 /** The transfer has been rejected. */
@@ -702,6 +709,7 @@ private constructor(
                     PENDING_APPROVAL -> Value.PENDING_APPROVAL
                     CANCELED -> Value.CANCELED
                     PENDING_SUBMISSION -> Value.PENDING_SUBMISSION
+                    PENDING_REVIEWING -> Value.PENDING_REVIEWING
                     REQUIRES_ATTENTION -> Value.REQUIRES_ATTENTION
                     REJECTED -> Value.REJECTED
                     PENDING_MAILING -> Value.PENDING_MAILING
@@ -726,6 +734,7 @@ private constructor(
                     PENDING_APPROVAL -> Known.PENDING_APPROVAL
                     CANCELED -> Known.CANCELED
                     PENDING_SUBMISSION -> Known.PENDING_SUBMISSION
+                    PENDING_REVIEWING -> Known.PENDING_REVIEWING
                     REQUIRES_ATTENTION -> Known.REQUIRES_ATTENTION
                     REJECTED -> Known.REJECTED
                     PENDING_MAILING -> Known.PENDING_MAILING

increase-java-core/src/main/kotlin/com/increase/api/models/entities/Entity.kt

@@ -24,8 +24,8 @@ import java.util.Optional
 import kotlin.jvm.optionals.getOrNull
 
 /**
- * Entities are the legal entities that own accounts. They can be people, corporations,
- * partnerships, government authorities, or trusts. To learn more, see
+ * Entities are the legal entities that own accounts. They can be people, corporations, joint
+ * accounts, trusts, or government authorities. To learn more, see
  * [Entities](/documentation/entities).
  */
 class Entity
@@ -1174,7 +1174,7 @@ private constructor(
         fun industryCode(): Optional<String> = industryCode.getOptional("industry_code")
 
         /**
-         * The legal identifier of the corporation.
+         * The legal identifier of the corporation, like an Employer Identification Number (EIN).
          *
          * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if
          *   the server responded with an unexpected value).
@@ -1476,7 +1476,10 @@ private constructor(
                 this.industryCode = industryCode
             }
 
-            /** The legal identifier of the corporation. */
+            /**
+             * The legal identifier of the corporation, like an Employer Identification Number
+             * (EIN).
+             */
             fun legalIdentifier(legalIdentifier: LegalIdentifier?) =
                 legalIdentifier(JsonField.ofNullable(legalIdentifier))
 
@@ -3819,7 +3822,9 @@ private constructor(
             override fun toString() = value.toString()
         }
 
-        /** The legal identifier of the corporation. */
+        /**
+         * The legal identifier of the corporation, like an Employer Identification Number (EIN).
+         */
         class LegalIdentifier
         @JsonCreator(mode = JsonCreator.Mode.DISABLED)
         private constructor(
@@ -3846,7 +3851,7 @@ private constructor(
             fun category(): Category = category.getRequired("category")
 
             /**
-             * The identifier of the legal identifier.
+             * The legal identifier itself.
              *
              * @throws IncreaseInvalidDataException if the JSON field has an unexpected type or is
              *   unexpectedly missing or null (e.g. if the server responded with an unexpected
@@ -3923,7 +3928,7 @@ private constructor(
                  */
                 fun category(category: JsonField<Category>) = apply { this.category = category }
 
-                /** The identifier of the legal identifier. */
+                /** The legal identifier itself. */
                 fun value(value: String) = value(JsonField.of(value))
 
                 /**

increase-java-core/src/main/kotlin/com/increase/api/models/entities/EntityCreateParams.kt

@@ -5165,8 +5165,8 @@ private constructor(
             ) : this(value, category, mutableMapOf())
 
             /**
-             * The legal identifier. For US Employer Identification Numbers, submit nine digits with
-             * no dashes or other separators. When testing in sandbox, use one of our
+             * The legal identifier itself. For US Employer Identification Numbers, submit nine
+             * digits with no dashes or other separators. When testing in sandbox, use one of our
              * [sandbox test values](https://increase.com/documentation/sandbox-test-values).
              *
              * @throws IncreaseInvalidDataException if the JSON field has an unexpected type or is
@@ -5241,8 +5241,9 @@ private constructor(
                 }
 
                 /**
-                 * The legal identifier. For US Employer Identification Numbers, submit nine digits
-                 * with no dashes or other separators. When testing in sandbox, use one of our
+                 * The legal identifier itself. For US Employer Identification Numbers, submit nine
+                 * digits with no dashes or other separators. When testing in sandbox, use one of
+                 * our
                  * [sandbox test values](https://increase.com/documentation/sandbox-test-values).
                  */
                 fun value(value: String) = value(JsonField.of(value))

increase-java-core/src/main/kotlin/com/increase/api/models/entities/EntityUpdateParams.kt

@@ -1838,8 +1838,8 @@ private constructor(
             ) : this(value, category, mutableMapOf())
 
             /**
-             * The identifier of the legal identifier. For US Employer Identification Numbers,
-             * submit nine digits with no dashes or other separators.
+             * The legal identifier itself. For US Employer Identification Numbers, submit nine
+             * digits with no dashes or other separators.
              *
              * @throws IncreaseInvalidDataException if the JSON field has an unexpected type or is
              *   unexpectedly missing or null (e.g. if the server responded with an unexpected
@@ -1912,8 +1912,8 @@ private constructor(
                 }
 
                 /**
-                 * The identifier of the legal identifier. For US Employer Identification Numbers,
-                 * submit nine digits with no dashes or other separators.
+                 * The legal identifier itself. For US Employer Identification Numbers, submit nine
+                 * digits with no dashes or other separators.
                  */
                 fun value(value: String) = value(JsonField.of(value))
 

increase-java-core/src/main/kotlin/com/increase/api/models/supplementaldocuments/EntitySupplementalDocument.kt

@@ -19,7 +19,10 @@ import java.util.Objects
 import java.util.Optional
 import kotlin.jvm.optionals.getOrNull
 
-/** Supplemental Documents are uploaded files connected to an Entity during onboarding. */
+/**
+ * Supplemental Documents are uploaded files connected to an Entity during onboarding. Not all
+ * programs require supplemental documents.
+ */
 class EntitySupplementalDocument
 @JsonCreator(mode = JsonCreator.Mode.DISABLED)
 private constructor(