feat(api): api update

.stats.yml

@@ -1,3 +1,3 @@
 configured_endpoints: 255
-openapi_spec_hash: 31dbb51b621eeb3886e4e430fe825146
+openapi_spec_hash: 4e105ef004f4e45b77ab69e64165b710
 config_hash: de151ebd21a0bd391662389b310a8f49

increase-java-core/src/main/kotlin/com/increase/api/models/achtransfers/AchTransfer.kt

@@ -265,7 +265,9 @@ private constructor(
     fun cancellation(): Optional<Cancellation> = cancellation.getOptional("cancellation")
 
     /**
-     * The description of the date of the transfer.
+     * A description of the transfer date (typically `YYMMDD`), sent in the company batch header.
+     * This value is informational and does not affect funds movement, settlement timing, or
+     * returns.
      *
      * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
@@ -274,7 +276,8 @@ private constructor(
         companyDescriptiveDate.getOptional("company_descriptive_date")
 
     /**
-     * The data you chose to associate with the transfer.
+     * Custom data sent in the company batch header, meant as metadata for the originator. This
+     * value is informational and does not affect funds movement, settlement timing, or returns.
      *
      * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
@@ -283,7 +286,9 @@ private constructor(
         companyDiscretionaryData.getOptional("company_discretionary_data")
 
     /**
-     * The description of the transfer you set to be shown to the recipient.
+     * A short description sent in the company batch header, meant to provide the receiver with a
+     * reason for the transfer. Many receivers do not surface this data on the receiver's bank
+     * statement.
      *
      * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
@@ -292,7 +297,9 @@ private constructor(
         companyEntryDescription.getOptional("company_entry_description")
 
     /**
-     * The company ID associated with the transfer.
+     * The Company ID sent in the batch header, which identifies the originator to the receiving
+     * bank. Businesses use this value to allowlist the companies permitted to debit their accounts.
+     * This value is configured by Increase and will be the same for all your transfers.
      *
      * @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).
@@ -427,9 +434,8 @@ private constructor(
         pendingTransactionId.getOptional("pending_transaction_id")
 
     /**
-     * Configuration for how the effective date of the transfer will be set. This determines
-     * same-day vs future-dated settlement timing. If not set, defaults to a `settlement_schedule`
-     * of `same_day`. If set, exactly one of the child attributes must be set.
+     * Configuration for how the effective date of the transfer was set. This determines same-day vs
+     * future-dated settlement timing.
      *
      * @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).
@@ -475,10 +481,11 @@ private constructor(
     /**
      * The descriptor that will show on the recipient's bank statement.
      *
-     * @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).
+     * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if the
+     *   server responded with an unexpected value).
      */
-    fun statementDescriptor(): String = statementDescriptor.getRequired("statement_descriptor")
+    fun statementDescriptor(): Optional<String> =
+        statementDescriptor.getOptional("statement_descriptor")
 
     /**
      * The lifecycle status of the transfer.
@@ -1095,7 +1102,11 @@ private constructor(
             this.cancellation = cancellation
         }
 
-        /** The description of the date of the transfer. */
+        /**
+         * A description of the transfer date (typically `YYMMDD`), sent in the company batch
+         * header. This value is informational and does not affect funds movement, settlement
+         * timing, or returns.
+         */
         fun companyDescriptiveDate(companyDescriptiveDate: String?) =
             companyDescriptiveDate(JsonField.ofNullable(companyDescriptiveDate))
 
@@ -1117,7 +1128,10 @@ private constructor(
             this.companyDescriptiveDate = companyDescriptiveDate
         }
 
-        /** The data you chose to associate with the transfer. */
+        /**
+         * Custom data sent in the company batch header, meant as metadata for the originator. This
+         * value is informational and does not affect funds movement, settlement timing, or returns.
+         */
         fun companyDiscretionaryData(companyDiscretionaryData: String?) =
             companyDiscretionaryData(JsonField.ofNullable(companyDiscretionaryData))
 
@@ -1139,7 +1153,11 @@ private constructor(
             this.companyDiscretionaryData = companyDiscretionaryData
         }
 
-        /** The description of the transfer you set to be shown to the recipient. */
+        /**
+         * A short description sent in the company batch header, meant to provide the receiver with
+         * a reason for the transfer. Many receivers do not surface this data on the receiver's bank
+         * statement.
+         */
         fun companyEntryDescription(companyEntryDescription: String?) =
             companyEntryDescription(JsonField.ofNullable(companyEntryDescription))
 
@@ -1161,7 +1179,12 @@ private constructor(
             this.companyEntryDescription = companyEntryDescription
         }
 
-        /** The company ID associated with the transfer. */
+        /**
+         * The Company ID sent in the batch header, which identifies the originator to the receiving
+         * bank. Businesses use this value to allowlist the companies permitted to debit their
+         * accounts. This value is configured by Increase and will be the same for all your
+         * transfers.
+         */
         fun companyId(companyId: String) = companyId(JsonField.of(companyId))
 
         /**
@@ -1435,10 +1458,8 @@ private constructor(
         }
 
         /**
-         * Configuration for how the effective date of the transfer will be set. This determines
-         * same-day vs future-dated settlement timing. If not set, defaults to a
-         * `settlement_schedule` of `same_day`. If set, exactly one of the child attributes must be
-         * set.
+         * Configuration for how the effective date of the transfer was set. This determines
+         * same-day vs future-dated settlement timing.
          */
         fun preferredEffectiveDate(preferredEffectiveDate: PreferredEffectiveDate) =
             preferredEffectiveDate(JsonField.of(preferredEffectiveDate))
@@ -1524,8 +1545,14 @@ private constructor(
             }
 
         /** The descriptor that will show on the recipient's bank statement. */
-        fun statementDescriptor(statementDescriptor: String) =
-            statementDescriptor(JsonField.of(statementDescriptor))
+        fun statementDescriptor(statementDescriptor: String?) =
+            statementDescriptor(JsonField.ofNullable(statementDescriptor))
+
+        /**
+         * Alias for calling [Builder.statementDescriptor] with `statementDescriptor.orElse(null)`.
+         */
+        fun statementDescriptor(statementDescriptor: Optional<String>) =
+            statementDescriptor(statementDescriptor.getOrNull())
 
         /**
          * Sets [Builder.statementDescriptor] to an arbitrary JSON value.
@@ -7340,9 +7367,8 @@ private constructor(
     }
 
     /**
-     * Configuration for how the effective date of the transfer will be set. This determines
-     * same-day vs future-dated settlement timing. If not set, defaults to a `settlement_schedule`
-     * of `same_day`. If set, exactly one of the child attributes must be set.
+     * Configuration for how the effective date of the transfer was set. This determines same-day vs
+     * future-dated settlement timing.
      */
     class PreferredEffectiveDate
     @JsonCreator(mode = JsonCreator.Mode.DISABLED)

increase-java-core/src/main/kotlin/com/increase/api/models/transactions/Transaction.kt

@@ -5253,12 +5253,11 @@ private constructor(
             /**
              * A description set when the ACH Transfer was created.
              *
-             * @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).
+             * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g.
+             *   if the server responded with an unexpected value).
              */
-            fun statementDescriptor(): String =
-                statementDescriptor.getRequired("statement_descriptor")
+            fun statementDescriptor(): Optional<String> =
+                statementDescriptor.getOptional("statement_descriptor")
 
             /**
              * The identifier of the ACH Transfer that led to this Transaction.
@@ -5414,8 +5413,15 @@ private constructor(
                 }
 
                 /** A description set when the ACH Transfer was created. */
-                fun statementDescriptor(statementDescriptor: String) =
-                    statementDescriptor(JsonField.of(statementDescriptor))
+                fun statementDescriptor(statementDescriptor: String?) =
+                    statementDescriptor(JsonField.ofNullable(statementDescriptor))
+
+                /**
+                 * Alias for calling [Builder.statementDescriptor] with
+                 * `statementDescriptor.orElse(null)`.
+                 */
+                fun statementDescriptor(statementDescriptor: Optional<String>) =
+                    statementDescriptor(statementDescriptor.getOrNull())
 
                 /**
                  * Sets [Builder.statementDescriptor] to an arbitrary JSON value.

increase-java-core/src/test/kotlin/com/increase/api/models/achtransfers/AchTransferTest.kt

@@ -307,7 +307,7 @@ internal class AchTransferTest {
             )
         assertThat(achTransfer.standardEntryClassCode())
             .isEqualTo(AchTransfer.StandardEntryClassCode.CORPORATE_CREDIT_OR_DEBIT)
-        assertThat(achTransfer.statementDescriptor()).isEqualTo("Statement descriptor")
+        assertThat(achTransfer.statementDescriptor()).contains("Statement descriptor")
         assertThat(achTransfer.status()).isEqualTo(AchTransfer.Status.RETURNED)
         assertThat(achTransfer.submission())
             .contains(