feat(api): add interest rate plan events and new fields

.stats.yml

@@ -1,3 +1,3 @@
 configured_endpoints: 239
-openapi_spec_hash: ec98ee98f7777d5d0f87bcb178e47d8d
+openapi_spec_hash: f8d2bbed3081c9ffc1547d28f89a8a34
 config_hash: 1ca082e374ef7000e2a5971e8da740e0

increase-java-core/src/main/kotlin/com/increase/api/models/accountnumbers/AccountNumberListParams.kt

@@ -47,7 +47,11 @@ private constructor(
      */
     fun idempotencyKey(): Optional<String> = Optional.ofNullable(idempotencyKey)
 
-    /** Limit the size of the list that is returned. The default (and maximum) is 100 objects. */
+    /**
+     * Limit the size of the list that is returned. The default (and maximum) is 100 objects.
+     *
+     * Defaults to `100`.
+     */
     fun limit(): Optional<Long> = Optional.ofNullable(limit)
 
     fun status(): Optional<Status> = Optional.ofNullable(status)
@@ -133,6 +137,8 @@ private constructor(
 
         /**
          * Limit the size of the list that is returned. The default (and maximum) is 100 objects.
+         *
+         * Defaults to `100`.
          */
         fun limit(limit: Long?) = apply { this.limit = limit }
 

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

@@ -840,6 +840,9 @@ private constructor(
             /** Grasshopper Bank */
             @JvmField val GRASSHOPPER_BANK = of("grasshopper_bank")
 
+            /** Increase Bank */
+            @JvmField val INCREASE_BANK = of("increase_bank")
+
             @JvmStatic fun of(value: String) = Bank(JsonField.of(value))
         }
 
@@ -851,6 +854,8 @@ private constructor(
             FIRST_INTERNET_BANK,
             /** Grasshopper Bank */
             GRASSHOPPER_BANK,
+            /** Increase Bank */
+            INCREASE_BANK,
         }
 
         /**
@@ -869,6 +874,8 @@ private constructor(
             FIRST_INTERNET_BANK,
             /** Grasshopper Bank */
             GRASSHOPPER_BANK,
+            /** Increase Bank */
+            INCREASE_BANK,
             /** An enum member indicating that [Bank] was instantiated with an unknown value. */
             _UNKNOWN,
         }
@@ -885,6 +892,7 @@ private constructor(
                 CORE_BANK -> Value.CORE_BANK
                 FIRST_INTERNET_BANK -> Value.FIRST_INTERNET_BANK
                 GRASSHOPPER_BANK -> Value.GRASSHOPPER_BANK
+                INCREASE_BANK -> Value.INCREASE_BANK
                 else -> Value._UNKNOWN
             }
 
@@ -902,6 +910,7 @@ private constructor(
                 CORE_BANK -> Known.CORE_BANK
                 FIRST_INTERNET_BANK -> Known.FIRST_INTERNET_BANK
                 GRASSHOPPER_BANK -> Known.GRASSHOPPER_BANK
+                INCREASE_BANK -> Known.INCREASE_BANK
                 else -> throw IncreaseInvalidDataException("Unknown Bank: $value")
             }
 

increase-java-core/src/main/kotlin/com/increase/api/models/accounts/AccountListParams.kt

@@ -49,7 +49,11 @@ private constructor(
     /** Filter Accounts for those belonging to the specified Entity as informational. */
     fun informationalEntityId(): Optional<String> = Optional.ofNullable(informationalEntityId)
 
-    /** Limit the size of the list that is returned. The default (and maximum) is 100 objects. */
+    /**
+     * Limit the size of the list that is returned. The default (and maximum) is 100 objects.
+     *
+     * Defaults to `100`.
+     */
     fun limit(): Optional<Long> = Optional.ofNullable(limit)
 
     /** Filter Accounts for those in a specific Program. */
@@ -144,6 +148,8 @@ private constructor(
 
         /**
          * Limit the size of the list that is returned. The default (and maximum) is 100 objects.
+         *
+         * Defaults to `100`.
          */
         fun limit(limit: Long?) = apply { this.limit = limit }
 

increase-java-core/src/main/kotlin/com/increase/api/models/accountstatements/AccountStatementListParams.kt

@@ -28,7 +28,11 @@ private constructor(
     /** Return the page of entries after this one. */
     fun cursor(): Optional<String> = Optional.ofNullable(cursor)
 
-    /** Limit the size of the list that is returned. The default (and maximum) is 100 objects. */
+    /**
+     * Limit the size of the list that is returned. The default (and maximum) is 100 objects.
+     *
+     * Defaults to `100`.
+     */
     fun limit(): Optional<Long> = Optional.ofNullable(limit)
 
     fun statementPeriodStart(): Optional<StatementPeriodStart> =
@@ -86,6 +90,8 @@ private constructor(
 
         /**
          * Limit the size of the list that is returned. The default (and maximum) is 100 objects.
+         *
+         * Defaults to `100`.
          */
         fun limit(limit: Long?) = apply { this.limit = limit }
 

increase-java-core/src/main/kotlin/com/increase/api/models/accounttransfers/AccountTransferListParams.kt

@@ -38,7 +38,11 @@ private constructor(
      */
     fun idempotencyKey(): Optional<String> = Optional.ofNullable(idempotencyKey)
 
-    /** Limit the size of the list that is returned. The default (and maximum) is 100 objects. */
+    /**
+     * Limit the size of the list that is returned. The default (and maximum) is 100 objects.
+     *
+     * Defaults to `100`.
+     */
     fun limit(): Optional<Long> = Optional.ofNullable(limit)
 
     /** Additional headers to send with the request. */
@@ -112,6 +116,8 @@ private constructor(
 
         /**
          * Limit the size of the list that is returned. The default (and maximum) is 100 objects.
+         *
+         * Defaults to `100`.
          */
         fun limit(limit: Long?) = apply { this.limit = limit }
 

increase-java-core/src/main/kotlin/com/increase/api/models/achprenotifications/AchPrenotificationCreateParams.kt

@@ -98,6 +98,8 @@ private constructor(
     /**
      * Whether the Prenotification is for a future debit or credit.
      *
+     * Defaults to `debit`.
+     *
      * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
      */
@@ -133,6 +135,8 @@ private constructor(
      * The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to use
      * for the ACH Prenotification.
      *
+     * Defaults to `corporate_credit_or_debit`.
+     *
      * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
      */
@@ -403,7 +407,11 @@ private constructor(
          */
         fun companyName(companyName: JsonField<String>) = apply { body.companyName(companyName) }
 
-        /** Whether the Prenotification is for a future debit or credit. */
+        /**
+         * Whether the Prenotification is for a future debit or credit.
+         *
+         * Defaults to `debit`.
+         */
         fun creditDebitIndicator(creditDebitIndicator: CreditDebitIndicator) = apply {
             body.creditDebitIndicator(creditDebitIndicator)
         }
@@ -470,6 +478,8 @@ private constructor(
         /**
          * The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to
          * use for the ACH Prenotification.
+         *
+         * Defaults to `corporate_credit_or_debit`.
          */
         fun standardEntryClassCode(standardEntryClassCode: StandardEntryClassCode) = apply {
             body.standardEntryClassCode(standardEntryClassCode)
@@ -780,6 +790,8 @@ private constructor(
         /**
          * Whether the Prenotification is for a future debit or credit.
          *
+         * Defaults to `debit`.
+         *
          * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if
          *   the server responded with an unexpected value).
          */
@@ -816,6 +828,8 @@ private constructor(
          * The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to
          * use for the ACH Prenotification.
          *
+         * Defaults to `corporate_credit_or_debit`.
+         *
          * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if
          *   the server responded with an unexpected value).
          */
@@ -1122,7 +1136,11 @@ private constructor(
                 this.companyName = companyName
             }
 
-            /** Whether the Prenotification is for a future debit or credit. */
+            /**
+             * Whether the Prenotification is for a future debit or credit.
+             *
+             * Defaults to `debit`.
+             */
             fun creditDebitIndicator(creditDebitIndicator: CreditDebitIndicator) =
                 creditDebitIndicator(JsonField.of(creditDebitIndicator))
 
@@ -1190,6 +1208,8 @@ private constructor(
             /**
              * The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
              * to use for the ACH Prenotification.
+             *
+             * Defaults to `corporate_credit_or_debit`.
              */
             fun standardEntryClassCode(standardEntryClassCode: StandardEntryClassCode) =
                 standardEntryClassCode(JsonField.of(standardEntryClassCode))

increase-java-core/src/main/kotlin/com/increase/api/models/achprenotifications/AchPrenotificationListParams.kt

@@ -34,7 +34,11 @@ private constructor(
      */
     fun idempotencyKey(): Optional<String> = Optional.ofNullable(idempotencyKey)
 
-    /** Limit the size of the list that is returned. The default (and maximum) is 100 objects. */
+    /**
+     * Limit the size of the list that is returned. The default (and maximum) is 100 objects.
+     *
+     * Defaults to `100`.
+     */
     fun limit(): Optional<Long> = Optional.ofNullable(limit)
 
     /** Additional headers to send with the request. */
@@ -100,6 +104,8 @@ private constructor(
 
         /**
          * Limit the size of the list that is returned. The default (and maximum) is 100 objects.
+         *
+         * Defaults to `100`.
          */
         fun limit(limit: Long?) = apply { this.limit = limit }
 

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

@@ -145,6 +145,8 @@ private constructor(
     /**
      * The type of the receiver's bank account.
      *
+     * Defaults to `checking`.
+     *
      * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
      */
@@ -605,7 +607,11 @@ private constructor(
             body.externalAccountId(externalAccountId)
         }
 
-        /** The type of the receiver's bank account. */
+        /**
+         * The type of the receiver's bank account.
+         *
+         * Defaults to `checking`.
+         */
         fun funding(funding: Funding) = apply { body.funding(funding) }
 
         /**
@@ -1105,6 +1111,8 @@ private constructor(
         /**
          * The type of the receiver's bank account.
          *
+         * Defaults to `checking`.
+         *
          * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if
          *   the server responded with an unexpected value).
          */
@@ -1625,7 +1633,11 @@ private constructor(
                 this.externalAccountId = externalAccountId
             }
 
-            /** The type of the receiver's bank account. */
+            /**
+             * The type of the receiver's bank account.
+             *
+             * Defaults to `checking`.
+             */
             fun funding(funding: Funding) = funding(JsonField.of(funding))
 
             /**

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

@@ -48,7 +48,11 @@ private constructor(
      */
     fun idempotencyKey(): Optional<String> = Optional.ofNullable(idempotencyKey)
 
-    /** Limit the size of the list that is returned. The default (and maximum) is 100 objects. */
+    /**
+     * Limit the size of the list that is returned. The default (and maximum) is 100 objects.
+     *
+     * Defaults to `100`.
+     */
     fun limit(): Optional<Long> = Optional.ofNullable(limit)
 
     fun status(): Optional<Status> = Optional.ofNullable(status)
@@ -135,6 +139,8 @@ private constructor(
 
         /**
          * Limit the size of the list that is returned. The default (and maximum) is 100 objects.
+         *
+         * Defaults to `100`.
          */
         fun limit(limit: Long?) = apply { this.limit = limit }
 

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

@@ -1043,6 +1043,8 @@ private constructor(
             /**
              * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
              *
+             * Defaults to `US`.
+             *
              * @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).
@@ -1186,7 +1188,11 @@ private constructor(
                  */
                 fun city(city: JsonField<String>) = apply { this.city = city }
 
-                /** The two-letter ISO 3166-1 alpha-2 code for the country of the address. */
+                /**
+                 * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+                 *
+                 * Defaults to `US`.
+                 */
                 fun country(country: String) = country(JsonField.of(country))
 
                 /**
@@ -1403,6 +1409,8 @@ private constructor(
             /**
              * A method that can be used to verify the individual's identity.
              *
+             * Defaults to `social_security_number`.
+             *
              * @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).
@@ -1537,7 +1545,11 @@ private constructor(
                     additionalProperties = identification.additionalProperties.toMutableMap()
                 }
 
-                /** A method that can be used to verify the individual's identity. */
+                /**
+                 * A method that can be used to verify the individual's identity.
+                 *
+                 * Defaults to `social_security_number`.
+                 */
                 fun method(method: Method) = method(JsonField.of(method))
 
                 /**

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

@@ -37,7 +37,11 @@ private constructor(
      */
     fun idempotencyKey(): Optional<String> = Optional.ofNullable(idempotencyKey)
 
-    /** Limit the size of the list that is returned. The default (and maximum) is 100 objects. */
+    /**
+     * Limit the size of the list that is returned. The default (and maximum) is 100 objects.
+     *
+     * Defaults to `100`.
+     */
     fun limit(): Optional<Long> = Optional.ofNullable(limit)
 
     /** Additional headers to send with the request. */
@@ -107,6 +111,8 @@ private constructor(
 
         /**
          * Limit the size of the list that is returned. The default (and maximum) is 100 objects.
+         *
+         * Defaults to `100`.
          */
         fun limit(limit: Long?) = apply { this.limit = limit }