feat(api): api update

.stats.yml

@@ -1,3 +1,3 @@
 configured_endpoints: 254
-openapi_spec_hash: 55fb271eb29805e8a49ed72fb5ed8843
+openapi_spec_hash: 2b66fef6a633fac7bacfd412e51ddfdb
 config_hash: f0e1844d06c76a9e145f7986d993dda6

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

@@ -135,7 +135,8 @@ private constructor(
     /**
      * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end of the
      * period the Account Statement covers. The statement covers all transactions up to, but not
-     * including this timestamp. Usually, this is the beginning of the following month.
+     * including this timestamp. Statement periods are measured in UTC days, so this is usually
+     * midnight UTC on the first day of the following month.
      *
      * @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).
@@ -146,7 +147,8 @@ private constructor(
     /**
      * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the start of the
      * period the Account Statement covers. This is the first moment of the statement period and is
-     * inclusive. Usually, this is the beginning of the month this statement covers.
+     * inclusive. Statement periods are measured in UTC days, so this is usually midnight UTC on the
+     * first day of the month this statement covers.
      *
      * @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).
@@ -403,7 +405,8 @@ private constructor(
         /**
          * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end of the
          * period the Account Statement covers. The statement covers all transactions up to, but not
-         * including this timestamp. Usually, this is the beginning of the following month.
+         * including this timestamp. Statement periods are measured in UTC days, so this is usually
+         * midnight UTC on the first day of the following month.
          */
         fun statementPeriodEnd(statementPeriodEnd: OffsetDateTime) =
             statementPeriodEnd(JsonField.of(statementPeriodEnd))
@@ -422,7 +425,8 @@ private constructor(
         /**
          * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the start of the
          * period the Account Statement covers. This is the first moment of the statement period and
-         * is inclusive. Usually, this is the beginning of the month this statement covers.
+         * is inclusive. Statement periods are measured in UTC days, so this is usually midnight UTC
+         * on the first day of the month this statement covers.
          */
         fun statementPeriodStart(statementPeriodStart: OffsetDateTime) =
             statementPeriodStart(JsonField.of(statementPeriodStart))

increase-java-core/src/main/kotlin/com/increase/api/models/exports/Export.kt

@@ -1255,7 +1255,7 @@ private constructor(
         fun accountId(): Optional<String> = accountId.getOptional("account_id")
 
         /**
-         * The date for which to retrieve the balance.
+         * The UTC date for which to retrieve the balance.
          *
          * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if
          *   the server responded with an unexpected value).
@@ -1352,7 +1352,7 @@ private constructor(
              */
             fun accountId(accountId: JsonField<String>) = apply { this.accountId = accountId }
 
-            /** The date for which to retrieve the balance. */
+            /** The UTC date for which to retrieve the balance. */
             fun effectiveDate(effectiveDate: LocalDate?) =
                 effectiveDate(JsonField.ofNullable(effectiveDate))
 
@@ -1978,7 +1978,7 @@ private constructor(
         fun accountNumberId(): String = accountNumberId.getRequired("account_number_id")
 
         /**
-         * The date of the balance to include in the letter.
+         * The UTC date of the balance to include in the letter.
          *
          * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if
          *   the server responded with an unexpected value).
@@ -2060,7 +2060,7 @@ private constructor(
                 this.accountNumberId = accountNumberId
             }
 
-            /** The date of the balance to include in the letter. */
+            /** The UTC date of the balance to include in the letter. */
             fun balanceDate(balanceDate: LocalDate?) =
                 balanceDate(JsonField.ofNullable(balanceDate))
 
@@ -2664,15 +2664,15 @@ private constructor(
             bookkeepingAccountId.getOptional("bookkeeping_account_id")
 
         /**
-         * Filter balances to those on or after this date.
+         * Filter balances to those on or after this UTC date.
          *
          * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if
          *   the server responded with an unexpected value).
          */
         fun onOrAfterDate(): Optional<LocalDate> = onOrAfterDate.getOptional("on_or_after_date")
 
         /**
-         * Filter balances to those on or before this date.
+         * Filter balances to those on or before this UTC date.
          *
          * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if
          *   the server responded with an unexpected value).
@@ -2776,7 +2776,7 @@ private constructor(
                 this.bookkeepingAccountId = bookkeepingAccountId
             }
 
-            /** Filter balances to those on or after this date. */
+            /** Filter balances to those on or after this UTC date. */
             fun onOrAfterDate(onOrAfterDate: LocalDate?) =
                 onOrAfterDate(JsonField.ofNullable(onOrAfterDate))
 
@@ -2795,7 +2795,7 @@ private constructor(
                 this.onOrAfterDate = onOrAfterDate
             }
 
-            /** Filter balances to those on or before this date. */
+            /** Filter balances to those on or before this UTC date. */
             fun onOrBeforeDate(onOrBeforeDate: LocalDate?) =
                 onOrBeforeDate(JsonField.ofNullable(onOrBeforeDate))
 
@@ -3272,15 +3272,15 @@ private constructor(
         fun accountId(): Optional<String> = accountId.getOptional("account_id")
 
         /**
-         * Filter balances on or after this date.
+         * Filter balances on or after this UTC date.
          *
          * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if
          *   the server responded with an unexpected value).
          */
         fun onOrAfterDate(): Optional<LocalDate> = onOrAfterDate.getOptional("on_or_after_date")
 
         /**
-         * Filter balances on or before this date.
+         * Filter balances on or before this UTC date.
          *
          * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if
          *   the server responded with an unexpected value).
@@ -3372,7 +3372,7 @@ private constructor(
              */
             fun accountId(accountId: JsonField<String>) = apply { this.accountId = accountId }
 
-            /** Filter balances on or after this date. */
+            /** Filter balances on or after this UTC date. */
             fun onOrAfterDate(onOrAfterDate: LocalDate?) =
                 onOrAfterDate(JsonField.ofNullable(onOrAfterDate))
 
@@ -3391,7 +3391,7 @@ private constructor(
                 this.onOrAfterDate = onOrAfterDate
             }
 
-            /** Filter balances on or before this date. */
+            /** Filter balances on or before this UTC date. */
             fun onOrBeforeDate(onOrBeforeDate: LocalDate?) =
                 onOrBeforeDate(JsonField.ofNullable(onOrBeforeDate))
 

increase-java-core/src/main/kotlin/com/increase/api/models/exports/ExportCreateParams.kt

@@ -1627,9 +1627,9 @@ private constructor(
         fun accountId(): Optional<String> = accountId.getOptional("account_id")
 
         /**
-         * The date to create a BAI2 report for. If not provided, the current date will be used. The
-         * timezone is UTC. If the current date is used, the report will include intraday balances,
-         * otherwise it will include end-of-day balances for the provided date.
+         * The UTC date to create a BAI2 report for. If not provided, the current date will be used.
+         * If the current date is used, the report will include intraday balances, otherwise it will
+         * include end-of-day balances for the provided date.
          *
          * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if
          *   the server responded with an unexpected value).
@@ -1719,9 +1719,9 @@ private constructor(
             fun accountId(accountId: JsonField<String>) = apply { this.accountId = accountId }
 
             /**
-             * The date to create a BAI2 report for. If not provided, the current date will be used.
-             * The timezone is UTC. If the current date is used, the report will include intraday
-             * balances, otherwise it will include end-of-day balances for the provided date.
+             * The UTC date to create a BAI2 report for. If not provided, the current date will be
+             * used. If the current date is used, the report will include intraday balances,
+             * otherwise it will include end-of-day balances for the provided date.
              */
             fun effectiveDate(effectiveDate: LocalDate) = effectiveDate(JsonField.of(effectiveDate))
 
@@ -2300,7 +2300,7 @@ private constructor(
         fun accountNumberId(): String = accountNumberId.getRequired("account_number_id")
 
         /**
-         * The date of the balance to include in the letter. Defaults to the current date.
+         * The UTC date of the balance to include in the letter. Defaults to the current date.
          *
          * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if
          *   the server responded with an unexpected value).
@@ -2381,7 +2381,9 @@ private constructor(
                 this.accountNumberId = accountNumberId
             }
 
-            /** The date of the balance to include in the letter. Defaults to the current date. */
+            /**
+             * The UTC date of the balance to include in the letter. Defaults to the current date.
+             */
             fun balanceDate(balanceDate: LocalDate) = balanceDate(JsonField.of(balanceDate))
 
             /**
@@ -2531,15 +2533,15 @@ private constructor(
             bookkeepingAccountId.getOptional("bookkeeping_account_id")
 
         /**
-         * Filter exported Balances to those on or after this date.
+         * Filter exported Balances to those on or after this UTC date.
          *
          * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if
          *   the server responded with an unexpected value).
          */
         fun onOrAfterDate(): Optional<LocalDate> = onOrAfterDate.getOptional("on_or_after_date")
 
         /**
-         * Filter exported Balances to those on or before this date.
+         * Filter exported Balances to those on or before this UTC date.
          *
          * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if
          *   the server responded with an unexpected value).
@@ -2631,7 +2633,7 @@ private constructor(
                 this.bookkeepingAccountId = bookkeepingAccountId
             }
 
-            /** Filter exported Balances to those on or after this date. */
+            /** Filter exported Balances to those on or after this UTC date. */
             fun onOrAfterDate(onOrAfterDate: LocalDate) = onOrAfterDate(JsonField.of(onOrAfterDate))
 
             /**
@@ -2645,7 +2647,7 @@ private constructor(
                 this.onOrAfterDate = onOrAfterDate
             }
 
-            /** Filter exported Balances to those on or before this date. */
+            /** Filter exported Balances to those on or before this UTC date. */
             fun onOrBeforeDate(onOrBeforeDate: LocalDate) =
                 onOrBeforeDate(JsonField.of(onOrBeforeDate))
 
@@ -2792,15 +2794,15 @@ private constructor(
         fun accountId(): Optional<String> = accountId.getOptional("account_id")
 
         /**
-         * Filter exported Balances to those on or after this date.
+         * Filter exported Balances to those on or after this UTC date.
          *
          * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if
          *   the server responded with an unexpected value).
          */
         fun onOrAfterDate(): Optional<LocalDate> = onOrAfterDate.getOptional("on_or_after_date")
 
         /**
-         * Filter exported Balances to those on or before this date.
+         * Filter exported Balances to those on or before this UTC date.
          *
          * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if
          *   the server responded with an unexpected value).
@@ -2882,7 +2884,7 @@ private constructor(
              */
             fun accountId(accountId: JsonField<String>) = apply { this.accountId = accountId }
 
-            /** Filter exported Balances to those on or after this date. */
+            /** Filter exported Balances to those on or after this UTC date. */
             fun onOrAfterDate(onOrAfterDate: LocalDate) = onOrAfterDate(JsonField.of(onOrAfterDate))
 
             /**
@@ -2896,7 +2898,7 @@ private constructor(
                 this.onOrAfterDate = onOrAfterDate
             }
 
-            /** Filter exported Balances to those on or before this date. */
+            /** Filter exported Balances to those on or before this UTC date. */
             fun onOrBeforeDate(onOrBeforeDate: LocalDate) =
                 onOrBeforeDate(JsonField.of(onOrBeforeDate))
 

increase-java-core/src/main/kotlin/com/increase/api/models/files/FileRetrieveParams.kt

@@ -9,7 +9,10 @@ import java.util.Objects
 import java.util.Optional
 import kotlin.jvm.optionals.getOrNull
 
-/** Retrieve a File */
+/**
+ * Fetch metadata about a File, like its `purpose` and MIME type. To access the content, use the
+ * [Get File contents](/documentation/api/files#get-file-contents) API.
+ */
 class FileRetrieveParams
 private constructor(
     private val fileId: String?,

increase-java-core/src/main/kotlin/com/increase/api/services/async/FileServiceAsync.kt

@@ -43,7 +43,10 @@ interface FileServiceAsync {
         requestOptions: RequestOptions = RequestOptions.none(),
     ): CompletableFuture<File>
 
-    /** Retrieve a File */
+    /**
+     * Fetch metadata about a File, like its `purpose` and MIME type. To access the content, use the
+     * [Get File contents](/documentation/api/files#get-file-contents) API.
+     */
     fun retrieve(fileId: String): CompletableFuture<File> =
         retrieve(fileId, FileRetrieveParams.none())
 

increase-java-core/src/main/kotlin/com/increase/api/services/blocking/FileService.kt

@@ -42,7 +42,10 @@ interface FileService {
         requestOptions: RequestOptions = RequestOptions.none(),
     ): File
 
-    /** Retrieve a File */
+    /**
+     * Fetch metadata about a File, like its `purpose` and MIME type. To access the content, use the
+     * [Get File contents](/documentation/api/files#get-file-contents) API.
+     */
     fun retrieve(fileId: String): File = retrieve(fileId, FileRetrieveParams.none())
 
     /** @see retrieve */