feat(api): add UETR field to inbound FedNow transfers

.github/workflows/release.yml

@@ -11,12 +11,12 @@ jobs:
     permissions:
       contents: read
     steps:
-      - uses: actions/create-github-app-token@v3
+      - uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
         id: app-token
         with:
           client-id: ${{ vars.INCREASE_RELEASES_CLIENT_ID }}
           private-key: ${{ secrets.INCREASE_RELEASES_PRIVATE_KEY }}
-      - uses: actions/checkout@v6
-      - uses: Increase/release-please@v1
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - uses: Increase/release-please@a9c58f256d7c7443d63d4b42d16f9ee6a04616e2 # v1.0.0
         with:
           token: ${{ steps.app-token.outputs.token }}

.stats.yml

@@ -1,3 +1,3 @@
 configured_endpoints: 238
-openapi_spec_hash: 97592a4f24ae885bcf0c7408a3f3eac3
+openapi_spec_hash: ed21325b0e3f886a49c45d2decc4f5d0
 config_hash: 2ae0d8aaecf01b38cbf9f9e112822c23

increase-java-core/src/main/kotlin/com/increase/api/models/inboundfednowtransfers/InboundFednowTransfer.kt

@@ -40,6 +40,7 @@ private constructor(
     private val status: JsonField<Status>,
     private val transactionId: JsonField<String>,
     private val type: JsonField<Type>,
+    private val uniqueEndToEndTransactionReference: JsonField<String>,
     private val unstructuredRemittanceInformation: JsonField<String>,
     private val additionalProperties: MutableMap<String, JsonValue>,
 ) {
@@ -77,6 +78,9 @@ private constructor(
         @ExcludeMissing
         transactionId: JsonField<String> = JsonMissing.of(),
         @JsonProperty("type") @ExcludeMissing type: JsonField<Type> = JsonMissing.of(),
+        @JsonProperty("unique_end_to_end_transaction_reference")
+        @ExcludeMissing
+        uniqueEndToEndTransactionReference: JsonField<String> = JsonMissing.of(),
         @JsonProperty("unstructured_remittance_information")
         @ExcludeMissing
         unstructuredRemittanceInformation: JsonField<String> = JsonMissing.of(),
@@ -96,6 +100,7 @@ private constructor(
         status,
         transactionId,
         type,
+        uniqueEndToEndTransactionReference,
         unstructuredRemittanceInformation,
         mutableMapOf(),
     )
@@ -223,6 +228,17 @@ private constructor(
      */
     fun type(): Type = type.getRequired("type")
 
+    /**
+     * The Unique End-to-end Transaction Reference
+     * ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr)) of
+     * the transfer.
+     *
+     * @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if the
+     *   server responded with an unexpected value).
+     */
+    fun uniqueEndToEndTransactionReference(): Optional<String> =
+        uniqueEndToEndTransactionReference.getOptional("unique_end_to_end_transaction_reference")
+
     /**
      * Additional information included with the transfer.
      *
@@ -353,6 +369,17 @@ private constructor(
      */
     @JsonProperty("type") @ExcludeMissing fun _type(): JsonField<Type> = type
 
+    /**
+     * Returns the raw JSON value of [uniqueEndToEndTransactionReference].
+     *
+     * Unlike [uniqueEndToEndTransactionReference], this method doesn't throw if the JSON field has
+     * an unexpected type.
+     */
+    @JsonProperty("unique_end_to_end_transaction_reference")
+    @ExcludeMissing
+    fun _uniqueEndToEndTransactionReference(): JsonField<String> =
+        uniqueEndToEndTransactionReference
+
     /**
      * Returns the raw JSON value of [unstructuredRemittanceInformation].
      *
@@ -397,6 +424,7 @@ private constructor(
          * .status()
          * .transactionId()
          * .type()
+         * .uniqueEndToEndTransactionReference()
          * .unstructuredRemittanceInformation()
          * ```
          */
@@ -421,6 +449,7 @@ private constructor(
         private var status: JsonField<Status>? = null
         private var transactionId: JsonField<String>? = null
         private var type: JsonField<Type>? = null
+        private var uniqueEndToEndTransactionReference: JsonField<String>? = null
         private var unstructuredRemittanceInformation: JsonField<String>? = null
         private var additionalProperties: MutableMap<String, JsonValue> = mutableMapOf()
 
@@ -441,6 +470,8 @@ private constructor(
             status = inboundFednowTransfer.status
             transactionId = inboundFednowTransfer.transactionId
             type = inboundFednowTransfer.type
+            uniqueEndToEndTransactionReference =
+                inboundFednowTransfer.uniqueEndToEndTransactionReference
             unstructuredRemittanceInformation =
                 inboundFednowTransfer.unstructuredRemittanceInformation
             additionalProperties = inboundFednowTransfer.additionalProperties.toMutableMap()
@@ -658,6 +689,35 @@ private constructor(
          */
         fun type(type: JsonField<Type>) = apply { this.type = type }
 
+        /**
+         * The Unique End-to-end Transaction Reference
+         * ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
+         * of the transfer.
+         */
+        fun uniqueEndToEndTransactionReference(uniqueEndToEndTransactionReference: String?) =
+            uniqueEndToEndTransactionReference(
+                JsonField.ofNullable(uniqueEndToEndTransactionReference)
+            )
+
+        /**
+         * Alias for calling [Builder.uniqueEndToEndTransactionReference] with
+         * `uniqueEndToEndTransactionReference.orElse(null)`.
+         */
+        fun uniqueEndToEndTransactionReference(
+            uniqueEndToEndTransactionReference: Optional<String>
+        ) = uniqueEndToEndTransactionReference(uniqueEndToEndTransactionReference.getOrNull())
+
+        /**
+         * Sets [Builder.uniqueEndToEndTransactionReference] to an arbitrary JSON value.
+         *
+         * You should usually call [Builder.uniqueEndToEndTransactionReference] with a well-typed
+         * [String] value instead. This method is primarily for setting the field to an undocumented
+         * or not yet supported value.
+         */
+        fun uniqueEndToEndTransactionReference(
+            uniqueEndToEndTransactionReference: JsonField<String>
+        ) = apply { this.uniqueEndToEndTransactionReference = uniqueEndToEndTransactionReference }
+
         /** Additional information included with the transfer. */
         fun unstructuredRemittanceInformation(unstructuredRemittanceInformation: String?) =
             unstructuredRemittanceInformation(
@@ -723,6 +783,7 @@ private constructor(
          * .status()
          * .transactionId()
          * .type()
+         * .uniqueEndToEndTransactionReference()
          * .unstructuredRemittanceInformation()
          * ```
          *
@@ -745,6 +806,10 @@ private constructor(
                 checkRequired("status", status),
                 checkRequired("transactionId", transactionId),
                 checkRequired("type", type),
+                checkRequired(
+                    "uniqueEndToEndTransactionReference",
+                    uniqueEndToEndTransactionReference,
+                ),
                 checkRequired(
                     "unstructuredRemittanceInformation",
                     unstructuredRemittanceInformation,
@@ -783,6 +848,7 @@ private constructor(
         status().validate()
         transactionId()
         type().validate()
+        uniqueEndToEndTransactionReference()
         unstructuredRemittanceInformation()
         validated = true
     }
@@ -817,6 +883,7 @@ private constructor(
             (status.asKnown().getOrNull()?.validity() ?: 0) +
             (if (transactionId.asKnown().isPresent) 1 else 0) +
             (type.asKnown().getOrNull()?.validity() ?: 0) +
+            (if (uniqueEndToEndTransactionReference.asKnown().isPresent) 1 else 0) +
             (if (unstructuredRemittanceInformation.asKnown().isPresent) 1 else 0)
 
     /** If your transfer is confirmed, this will contain details of the confirmation. */
@@ -1848,6 +1915,7 @@ private constructor(
             status == other.status &&
             transactionId == other.transactionId &&
             type == other.type &&
+            uniqueEndToEndTransactionReference == other.uniqueEndToEndTransactionReference &&
             unstructuredRemittanceInformation == other.unstructuredRemittanceInformation &&
             additionalProperties == other.additionalProperties
     }
@@ -1869,6 +1937,7 @@ private constructor(
             status,
             transactionId,
             type,
+            uniqueEndToEndTransactionReference,
             unstructuredRemittanceInformation,
             additionalProperties,
         )
@@ -1877,5 +1946,5 @@ private constructor(
     override fun hashCode(): Int = hashCode
 
     override fun toString() =
-        "InboundFednowTransfer{id=$id, accountId=$accountId, accountNumberId=$accountNumberId, amount=$amount, confirmation=$confirmation, createdAt=$createdAt, creditorName=$creditorName, currency=$currency, debtorAccountNumber=$debtorAccountNumber, debtorName=$debtorName, debtorRoutingNumber=$debtorRoutingNumber, decline=$decline, status=$status, transactionId=$transactionId, type=$type, unstructuredRemittanceInformation=$unstructuredRemittanceInformation, additionalProperties=$additionalProperties}"
+        "InboundFednowTransfer{id=$id, accountId=$accountId, accountNumberId=$accountNumberId, amount=$amount, confirmation=$confirmation, createdAt=$createdAt, creditorName=$creditorName, currency=$currency, debtorAccountNumber=$debtorAccountNumber, debtorName=$debtorName, debtorRoutingNumber=$debtorRoutingNumber, decline=$decline, status=$status, transactionId=$transactionId, type=$type, uniqueEndToEndTransactionReference=$uniqueEndToEndTransactionReference, unstructuredRemittanceInformation=$unstructuredRemittanceInformation, additionalProperties=$additionalProperties}"
 }

increase-java-core/src/test/kotlin/com/increase/api/models/inboundfednowtransfers/InboundFednowTransferListPageResponseTest.kt

@@ -42,6 +42,7 @@ internal class InboundFednowTransferListPageResponseTest {
                         .status(InboundFednowTransfer.Status.CONFIRMED)
                         .transactionId("transaction_uyrp7fld2ium70oa7oi")
                         .type(InboundFednowTransfer.Type.INBOUND_FEDNOW_TRANSFER)
+                        .uniqueEndToEndTransactionReference("9a21e10a-7600-4a24-8ff3-2cbc5943c27a")
                         .unstructuredRemittanceInformation("Invoice 29582")
                         .build()
                 )
@@ -75,6 +76,7 @@ internal class InboundFednowTransferListPageResponseTest {
                     .status(InboundFednowTransfer.Status.CONFIRMED)
                     .transactionId("transaction_uyrp7fld2ium70oa7oi")
                     .type(InboundFednowTransfer.Type.INBOUND_FEDNOW_TRANSFER)
+                    .uniqueEndToEndTransactionReference("9a21e10a-7600-4a24-8ff3-2cbc5943c27a")
                     .unstructuredRemittanceInformation("Invoice 29582")
                     .build()
             )
@@ -114,6 +116,7 @@ internal class InboundFednowTransferListPageResponseTest {
                         .status(InboundFednowTransfer.Status.CONFIRMED)
                         .transactionId("transaction_uyrp7fld2ium70oa7oi")
                         .type(InboundFednowTransfer.Type.INBOUND_FEDNOW_TRANSFER)
+                        .uniqueEndToEndTransactionReference("9a21e10a-7600-4a24-8ff3-2cbc5943c27a")
                         .unstructuredRemittanceInformation("Invoice 29582")
                         .build()
                 )

increase-java-core/src/test/kotlin/com/increase/api/models/inboundfednowtransfers/InboundFednowTransferTest.kt

@@ -38,6 +38,7 @@ internal class InboundFednowTransferTest {
                 .status(InboundFednowTransfer.Status.CONFIRMED)
                 .transactionId("transaction_uyrp7fld2ium70oa7oi")
                 .type(InboundFednowTransfer.Type.INBOUND_FEDNOW_TRANSFER)
+                .uniqueEndToEndTransactionReference("9a21e10a-7600-4a24-8ff3-2cbc5943c27a")
                 .unstructuredRemittanceInformation("Invoice 29582")
                 .build()
 
@@ -72,6 +73,8 @@ internal class InboundFednowTransferTest {
             .contains("transaction_uyrp7fld2ium70oa7oi")
         assertThat(inboundFednowTransfer.type())
             .isEqualTo(InboundFednowTransfer.Type.INBOUND_FEDNOW_TRANSFER)
+        assertThat(inboundFednowTransfer.uniqueEndToEndTransactionReference())
+            .contains("9a21e10a-7600-4a24-8ff3-2cbc5943c27a")
         assertThat(inboundFednowTransfer.unstructuredRemittanceInformation())
             .contains("Invoice 29582")
     }
@@ -105,6 +108,7 @@ internal class InboundFednowTransferTest {
                 .status(InboundFednowTransfer.Status.CONFIRMED)
                 .transactionId("transaction_uyrp7fld2ium70oa7oi")
                 .type(InboundFednowTransfer.Type.INBOUND_FEDNOW_TRANSFER)
+                .uniqueEndToEndTransactionReference("9a21e10a-7600-4a24-8ff3-2cbc5943c27a")
                 .unstructuredRemittanceInformation("Invoice 29582")
                 .build()