feat(api)!: add swift intermediary bic and inbound rtp events

.stats.yml

@@ -1,3 +1,3 @@
 configured_endpoints: 238
-openapi_spec_hash: 244db0c7a39ae8fff699dccda50b79bd
+openapi_spec_hash: 355ca6c73f05d0ce3888debdc2e1a7d8
 config_hash: 2ae0d8aaecf01b38cbf9f9e112822c23

src/increase/resources/simulations/ach_transfers.py

@@ -171,6 +171,7 @@ def return_(
         self,
         ach_transfer_id: str,
         *,
+        addenda_information: str | Omit = omit,
         reason: Literal[
             "insufficient_fund",
             "no_account",
@@ -260,6 +261,10 @@ def return_(
         Args:
           ach_transfer_id: The identifier of the ACH Transfer you wish to return.
 
+          addenda_information: Free-form information the returning bank includes in the return addenda. For a
+              `file_record_edit_criteria` (R17) return, set this to `QUESTIONABLE` to simulate
+              a return the bank believes was initiated under questionable circumstances.
+
           reason: The reason why the Federal Reserve or destination bank returned this transfer.
               Defaults to `no_account`.
 
@@ -296,8 +301,11 @@ def return_(
               - `authorization_revoked_by_customer` - Code R07. The customer revoked their
                 authorization for a previously authorized transfer.
               - `invalid_ach_routing_number` - Code R13. The routing number is invalid.
-              - `file_record_edit_criteria` - Code R17. The receiving bank is unable to
-                process a field in the transfer.
+              - `file_record_edit_criteria` - Code R17. This return code has multiple
+                meanings. The receiving bank was either unable to process a field in the
+                transfer, or believes the transfer was initiated under questionable
+                circumstances (such as fraud), or identified an improperly-initiated reversing
+                entry.
               - `enr_invalid_individual_name` - Code R45. A rare return reason. The individual
                 name field was invalid.
               - `returned_per_odfi_request` - Code R06. The originating financial institution
@@ -428,7 +436,13 @@ def return_(
             raise ValueError(f"Expected a non-empty value for `ach_transfer_id` but received {ach_transfer_id!r}")
         return self._post(
             path_template("/simulations/ach_transfers/{ach_transfer_id}/return", ach_transfer_id=ach_transfer_id),
-            body=maybe_transform({"reason": reason}, ach_transfer_return_params.ACHTransferReturnParams),
+            body=maybe_transform(
+                {
+                    "addenda_information": addenda_information,
+                    "reason": reason,
+                },
+                ach_transfer_return_params.ACHTransferReturnParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -694,6 +708,7 @@ async def return_(
         self,
         ach_transfer_id: str,
         *,
+        addenda_information: str | Omit = omit,
         reason: Literal[
             "insufficient_fund",
             "no_account",
@@ -783,6 +798,10 @@ async def return_(
         Args:
           ach_transfer_id: The identifier of the ACH Transfer you wish to return.
 
+          addenda_information: Free-form information the returning bank includes in the return addenda. For a
+              `file_record_edit_criteria` (R17) return, set this to `QUESTIONABLE` to simulate
+              a return the bank believes was initiated under questionable circumstances.
+
           reason: The reason why the Federal Reserve or destination bank returned this transfer.
               Defaults to `no_account`.
 
@@ -819,8 +838,11 @@ async def return_(
               - `authorization_revoked_by_customer` - Code R07. The customer revoked their
                 authorization for a previously authorized transfer.
               - `invalid_ach_routing_number` - Code R13. The routing number is invalid.
-              - `file_record_edit_criteria` - Code R17. The receiving bank is unable to
-                process a field in the transfer.
+              - `file_record_edit_criteria` - Code R17. This return code has multiple
+                meanings. The receiving bank was either unable to process a field in the
+                transfer, or believes the transfer was initiated under questionable
+                circumstances (such as fraud), or identified an improperly-initiated reversing
+                entry.
               - `enr_invalid_individual_name` - Code R45. A rare return reason. The individual
                 name field was invalid.
               - `returned_per_odfi_request` - Code R06. The originating financial institution
@@ -951,7 +973,13 @@ async def return_(
             raise ValueError(f"Expected a non-empty value for `ach_transfer_id` but received {ach_transfer_id!r}")
         return await self._post(
             path_template("/simulations/ach_transfers/{ach_transfer_id}/return", ach_transfer_id=ach_transfer_id),
-            body=await async_maybe_transform({"reason": reason}, ach_transfer_return_params.ACHTransferReturnParams),
+            body=await async_maybe_transform(
+                {
+                    "addenda_information": addenda_information,
+                    "reason": reason,
+                },
+                ach_transfer_return_params.ACHTransferReturnParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,

src/increase/resources/simulations/card_settlements.py

@@ -45,8 +45,8 @@ def create(
         self,
         *,
         card_id: str,
-        pending_transaction_id: str,
         amount: int | Omit = omit,
+        pending_transaction_id: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -66,11 +66,12 @@ def create(
         Args:
           card_id: The identifier of the Card to create a settlement on.
 
-          pending_transaction_id: The identifier of the Pending Transaction for the Card Authorization you wish to
-              settle.
-
           amount: The amount to be settled. This defaults to the amount of the Pending Transaction
-              being settled.
+              being settled, or a random amount if `pending_transaction_id` is not provided.
+
+          pending_transaction_id: The identifier of the Pending Transaction for the Card Authorization you wish to
+              settle. If not provided, the settlement will be force posted without a Card
+              Authorization.
 
           extra_headers: Send extra headers
 
@@ -87,8 +88,8 @@ def create(
             body=maybe_transform(
                 {
                     "card_id": card_id,
-                    "pending_transaction_id": pending_transaction_id,
                     "amount": amount,
+                    "pending_transaction_id": pending_transaction_id,
                 },
                 card_settlement_create_params.CardSettlementCreateParams,
             ),
@@ -127,8 +128,8 @@ async def create(
         self,
         *,
         card_id: str,
-        pending_transaction_id: str,
         amount: int | Omit = omit,
+        pending_transaction_id: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -148,11 +149,12 @@ async def create(
         Args:
           card_id: The identifier of the Card to create a settlement on.
 
-          pending_transaction_id: The identifier of the Pending Transaction for the Card Authorization you wish to
-              settle.
-
           amount: The amount to be settled. This defaults to the amount of the Pending Transaction
-              being settled.
+              being settled, or a random amount if `pending_transaction_id` is not provided.
+
+          pending_transaction_id: The identifier of the Pending Transaction for the Card Authorization you wish to
+              settle. If not provided, the settlement will be force posted without a Card
+              Authorization.
 
           extra_headers: Send extra headers
 
@@ -169,8 +171,8 @@ async def create(
             body=await async_maybe_transform(
                 {
                     "card_id": card_id,
-                    "pending_transaction_id": pending_transaction_id,
                     "amount": amount,
+                    "pending_transaction_id": pending_transaction_id,
                 },
                 card_settlement_create_params.CardSettlementCreateParams,
             ),

src/increase/resources/simulations/programs.py

@@ -47,7 +47,7 @@ def create(
         self,
         *,
         name: str,
-        bank: Literal["core_bank", "first_internet_bank", "grasshopper_bank", "twin_city_bank"] | Omit = omit,
+        bank: Literal["core_bank", "first_internet_bank", "grasshopper_bank"] | Omit = omit,
         lending_maximum_extendable_credit: int | Omit = omit,
         reserve_account_id: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -73,7 +73,6 @@ def create(
               - `core_bank` - Core Bank
               - `first_internet_bank` - First Internet Bank of Indiana
               - `grasshopper_bank` - Grasshopper Bank
-              - `twin_city_bank` - Twin City Bank
 
           lending_maximum_extendable_credit: The maximum extendable credit of the program being added.
 
@@ -135,7 +134,7 @@ async def create(
         self,
         *,
         name: str,
-        bank: Literal["core_bank", "first_internet_bank", "grasshopper_bank", "twin_city_bank"] | Omit = omit,
+        bank: Literal["core_bank", "first_internet_bank", "grasshopper_bank"] | Omit = omit,
         lending_maximum_extendable_credit: int | Omit = omit,
         reserve_account_id: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -161,7 +160,6 @@ async def create(
               - `core_bank` - Core Bank
               - `first_internet_bank` - First Internet Bank of Indiana
               - `grasshopper_bank` - Grasshopper Bank
-              - `twin_city_bank` - Twin City Bank
 
           lending_maximum_extendable_credit: The maximum extendable credit of the program being added.
 

src/increase/resources/swift_transfers.py

@@ -58,6 +58,7 @@ def create(
         instructed_currency: Literal["USD"],
         source_account_number_id: str,
         unstructured_remittance_information: str,
+        intermediary_bank_identification_code: str | Omit = omit,
         require_approval: bool | Omit = omit,
         routing_number: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -99,6 +100,9 @@ def create(
 
           unstructured_remittance_information: Unstructured remittance information to include in the transfer.
 
+          intermediary_bank_identification_code: The bank identification code (BIC) of the intermediary bank, if the transfer
+              should be routed through one.
+
           require_approval: Whether the transfer requires explicit approval via the dashboard or API.
 
           routing_number: The creditor's bank account routing or transit number. Required in certain
@@ -129,6 +133,7 @@ def create(
                     "instructed_currency": instructed_currency,
                     "source_account_number_id": source_account_number_id,
                     "unstructured_remittance_information": unstructured_remittance_information,
+                    "intermediary_bank_identification_code": intermediary_bank_identification_code,
                     "require_approval": require_approval,
                     "routing_number": routing_number,
                 },
@@ -361,6 +366,7 @@ async def create(
         instructed_currency: Literal["USD"],
         source_account_number_id: str,
         unstructured_remittance_information: str,
+        intermediary_bank_identification_code: str | Omit = omit,
         require_approval: bool | Omit = omit,
         routing_number: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -402,6 +408,9 @@ async def create(
 
           unstructured_remittance_information: Unstructured remittance information to include in the transfer.
 
+          intermediary_bank_identification_code: The bank identification code (BIC) of the intermediary bank, if the transfer
+              should be routed through one.
+
           require_approval: Whether the transfer requires explicit approval via the dashboard or API.
 
           routing_number: The creditor's bank account routing or transit number. Required in certain
@@ -432,6 +441,7 @@ async def create(
                     "instructed_currency": instructed_currency,
                     "source_account_number_id": source_account_number_id,
                     "unstructured_remittance_information": unstructured_remittance_information,
+                    "intermediary_bank_identification_code": intermediary_bank_identification_code,
                     "require_approval": require_approval,
                     "routing_number": routing_number,
                 },

src/increase/types/ach_prenotification.py

@@ -232,8 +232,11 @@ class PrenotificationReturn(BaseModel):
     - `authorization_revoked_by_customer` - Code R07. The customer revoked their
       authorization for a previously authorized transfer.
     - `invalid_ach_routing_number` - Code R13. The routing number is invalid.
-    - `file_record_edit_criteria` - Code R17. The receiving bank is unable to
-      process a field in the transfer.
+    - `file_record_edit_criteria` - Code R17. This return code has multiple
+      meanings. The receiving bank was either unable to process a field in the
+      transfer, or believes the transfer was initiated under questionable
+      circumstances (such as fraud), or identified an improperly-initiated reversing
+      entry.
     - `enr_invalid_individual_name` - Code R45. A rare return reason. The individual
       name field was invalid.
     - `returned_per_odfi_request` - Code R06. The originating financial institution

src/increase/types/ach_transfer.py

@@ -384,6 +384,16 @@ class PreferredEffectiveDate(BaseModel):
 class Return(BaseModel):
     """If your transfer is returned, this will contain details of the return."""
 
+    addenda_information: Optional[str] = None
+    """
+    Additional free-form information included by the receiving bank in the return's
+    addenda record. This is raw, uninterpreted text whose presence and format are
+    not guaranteed. For a `file_record_edit_criteria` (R17) return the receiving
+    bank may set this to `QUESTIONABLE` (optionally followed by more text) to
+    indicate it believes the transfer was initiated under questionable
+    circumstances.
+    """
+
     created_at: datetime.datetime
     """
     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -502,8 +512,11 @@ class Return(BaseModel):
     - `authorization_revoked_by_customer` - Code R07. The customer revoked their
       authorization for a previously authorized transfer.
     - `invalid_ach_routing_number` - Code R13. The routing number is invalid.
-    - `file_record_edit_criteria` - Code R17. The receiving bank is unable to
-      process a field in the transfer.
+    - `file_record_edit_criteria` - Code R17. This return code has multiple
+      meanings. The receiving bank was either unable to process a field in the
+      transfer, or believes the transfer was initiated under questionable
+      circumstances (such as fraud), or identified an improperly-initiated reversing
+      entry.
     - `enr_invalid_individual_name` - Code R45. A rare return reason. The individual
       name field was invalid.
     - `returned_per_odfi_request` - Code R06. The originating financial institution

src/increase/types/check_transfer.py

@@ -289,7 +289,10 @@ class PhysicalCheck(BaseModel):
     """The signature that will appear on the check."""
 
     tracking_updates: List[PhysicalCheckTrackingUpdate]
-    """Tracking updates relating to the physical check's delivery."""
+    """Tracking updates relating to the physical check's delivery.
+
+    Sorted by `created_at` in ascending order.
+    """
 
     if TYPE_CHECKING:
         # Some versions of Pydantic <2.8.0 have a bug and don’t allow assigning a

src/increase/types/event.py

@@ -85,6 +85,8 @@ class Event(BaseModel):
         "inbound_fednow_transfer.updated",
         "inbound_mail_item.created",
         "inbound_mail_item.updated",
+        "inbound_real_time_payments_request_for_payment.created",
+        "inbound_real_time_payments_request_for_payment.updated",
         "inbound_real_time_payments_transfer.created",
         "inbound_real_time_payments_transfer.updated",
         "inbound_wire_drawdown_request.created",
@@ -232,6 +234,10 @@ class Event(BaseModel):
       is updated.
     - `inbound_mail_item.created` - Occurs whenever an Inbound Mail Item is created.
     - `inbound_mail_item.updated` - Occurs whenever an Inbound Mail Item is updated.
+    - `inbound_real_time_payments_request_for_payment.created` - Occurs whenever an
+      Inbound Real-Time Payments Request for Payment is created.
+    - `inbound_real_time_payments_request_for_payment.updated` - Occurs whenever an
+      Inbound Real-Time Payments Request for Payment is updated.
     - `inbound_real_time_payments_transfer.created` - Occurs whenever an Inbound
       Real-Time Payments Transfer is created.
     - `inbound_real_time_payments_transfer.updated` - Occurs whenever an Inbound

src/increase/types/event_list_params.py

@@ -97,6 +97,8 @@ class EventListParams(TypedDict, total=False):
                 "inbound_fednow_transfer.updated",
                 "inbound_mail_item.created",
                 "inbound_mail_item.updated",
+                "inbound_real_time_payments_request_for_payment.created",
+                "inbound_real_time_payments_request_for_payment.updated",
                 "inbound_real_time_payments_transfer.created",
                 "inbound_real_time_payments_transfer.updated",
                 "inbound_wire_drawdown_request.created",

src/increase/types/event_subscription.py

@@ -75,6 +75,8 @@ class SelectedEventCategory(BaseModel):
             "inbound_fednow_transfer.updated",
             "inbound_mail_item.created",
             "inbound_mail_item.updated",
+            "inbound_real_time_payments_request_for_payment.created",
+            "inbound_real_time_payments_request_for_payment.updated",
             "inbound_real_time_payments_transfer.created",
             "inbound_real_time_payments_transfer.updated",
             "inbound_wire_drawdown_request.created",
@@ -220,6 +222,10 @@ class SelectedEventCategory(BaseModel):
       is updated.
     - `inbound_mail_item.created` - Occurs whenever an Inbound Mail Item is created.
     - `inbound_mail_item.updated` - Occurs whenever an Inbound Mail Item is updated.
+    - `inbound_real_time_payments_request_for_payment.created` - Occurs whenever an
+      Inbound Real-Time Payments Request for Payment is created.
+    - `inbound_real_time_payments_request_for_payment.updated` - Occurs whenever an
+      Inbound Real-Time Payments Request for Payment is updated.
     - `inbound_real_time_payments_transfer.created` - Occurs whenever an Inbound
       Real-Time Payments Transfer is created.
     - `inbound_real_time_payments_transfer.updated` - Occurs whenever an Inbound