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

lib/increase/models/ach_prenotification.rb

@@ -459,7 +459,7 @@ module ReturnReasonCode
           # Code R13. The routing number is invalid.
           INVALID_ACH_ROUTING_NUMBER = :invalid_ach_routing_number
 
-          # Code R17. The receiving bank is unable to process a field in the transfer.
+          # 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.
           FILE_RECORD_EDIT_CRITERIA = :file_record_edit_criteria
 
           # Code R45. A rare return reason. The individual name field was invalid.

lib/increase/models/ach_transfer.rb

@@ -1103,6 +1103,17 @@ module SettlementSchedule
 
       # @see Increase::Models::ACHTransfer#return_
       class Return < Increase::Internal::Type::BaseModel
+        # @!attribute addenda_information
+        #   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.
+        #
+        #   @return [String, nil]
+        required :addenda_information, String, nil?: true
+
         # @!attribute created_at
         #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
         #   the transfer was created.
@@ -1145,9 +1156,17 @@ class Return < Increase::Internal::Type::BaseModel
         #   @return [String]
         required :transfer_id, String
 
-        # @!method initialize(created_at:, raw_return_reason_code:, return_reason_code:, trace_number:, transaction_id:, transfer_id:)
+        # @!method initialize(addenda_information:, created_at:, raw_return_reason_code:, return_reason_code:, trace_number:, transaction_id:, transfer_id:)
         #   If your transfer is returned, this will contain details of the return.
         #
+        #   @param addenda_information [String, nil]
+        #     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.
+        #
         #   @param created_at [Time]
         #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
         #     the transfer was created.
@@ -1227,7 +1246,7 @@ module ReturnReasonCode
           # Code R13. The routing number is invalid.
           INVALID_ACH_ROUTING_NUMBER = :invalid_ach_routing_number
 
-          # Code R17. The receiving bank is unable to process a field in the transfer.
+          # 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.
           FILE_RECORD_EDIT_CRITERIA = :file_record_edit_criteria
 
           # Code R45. A rare return reason. The individual name field was invalid.

lib/increase/models/check_transfer.rb

@@ -563,7 +563,8 @@ class PhysicalCheck < Increase::Internal::Type::BaseModel
         required :signature, -> { Increase::CheckTransfer::PhysicalCheck::Signature }
 
         # @!attribute tracking_updates
-        #   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.
         #
         #   @return [Array<Increase::Models::CheckTransfer::PhysicalCheck::TrackingUpdate>]
         required :tracking_updates,
@@ -602,7 +603,8 @@ class PhysicalCheck < Increase::Internal::Type::BaseModel
         #     The signature that will appear on the check.
         #
         #   @param tracking_updates [Array<Increase::Models::CheckTransfer::PhysicalCheck::TrackingUpdate>]
-        #     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.
 
         # @see Increase::Models::CheckTransfer::PhysicalCheck#mailing_address
         class MailingAddress < Increase::Internal::Type::BaseModel

lib/increase/models/event.rb

@@ -254,6 +254,14 @@ module Category
         # Occurs whenever an Inbound Mail Item is updated.
         INBOUND_MAIL_ITEM_UPDATED = :"inbound_mail_item.updated"
 
+        # Occurs whenever an Inbound Real-Time Payments Request for Payment is created.
+        INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_CREATED =
+          :"inbound_real_time_payments_request_for_payment.created"
+
+        # Occurs whenever an Inbound Real-Time Payments Request for Payment is updated.
+        INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED =
+          :"inbound_real_time_payments_request_for_payment.updated"
+
         # Occurs whenever an Inbound Real-Time Payments Transfer is created.
         INBOUND_REAL_TIME_PAYMENTS_TRANSFER_CREATED = :"inbound_real_time_payments_transfer.created"
 

lib/increase/models/event_list_params.rb

@@ -262,6 +262,14 @@ module In
           # Occurs whenever an Inbound Mail Item is updated.
           INBOUND_MAIL_ITEM_UPDATED = :"inbound_mail_item.updated"
 
+          # Occurs whenever an Inbound Real-Time Payments Request for Payment is created.
+          INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_CREATED =
+            :"inbound_real_time_payments_request_for_payment.created"
+
+          # Occurs whenever an Inbound Real-Time Payments Request for Payment is updated.
+          INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED =
+            :"inbound_real_time_payments_request_for_payment.updated"
+
           # Occurs whenever an Inbound Real-Time Payments Transfer is created.
           INBOUND_REAL_TIME_PAYMENTS_TRANSFER_CREATED = :"inbound_real_time_payments_transfer.created"
 

lib/increase/models/event_subscription.rb

@@ -295,6 +295,14 @@ module EventCategory
           # Occurs whenever an Inbound Mail Item is updated.
           INBOUND_MAIL_ITEM_UPDATED = :"inbound_mail_item.updated"
 
+          # Occurs whenever an Inbound Real-Time Payments Request for Payment is created.
+          INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_CREATED =
+            :"inbound_real_time_payments_request_for_payment.created"
+
+          # Occurs whenever an Inbound Real-Time Payments Request for Payment is updated.
+          INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED =
+            :"inbound_real_time_payments_request_for_payment.updated"
+
           # Occurs whenever an Inbound Real-Time Payments Transfer is created.
           INBOUND_REAL_TIME_PAYMENTS_TRANSFER_CREATED = :"inbound_real_time_payments_transfer.created"
 

lib/increase/models/event_subscription_create_params.rb

@@ -264,6 +264,14 @@ module EventCategory
           # Occurs whenever an Inbound Mail Item is updated.
           INBOUND_MAIL_ITEM_UPDATED = :"inbound_mail_item.updated"
 
+          # Occurs whenever an Inbound Real-Time Payments Request for Payment is created.
+          INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_CREATED =
+            :"inbound_real_time_payments_request_for_payment.created"
+
+          # Occurs whenever an Inbound Real-Time Payments Request for Payment is updated.
+          INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED =
+            :"inbound_real_time_payments_request_for_payment.updated"
+
           # Occurs whenever an Inbound Real-Time Payments Transfer is created.
           INBOUND_REAL_TIME_PAYMENTS_TRANSFER_CREATED = :"inbound_real_time_payments_transfer.created"
 

lib/increase/models/inbound_wire_transfer.rb

@@ -65,6 +65,12 @@ class InboundWireTransfer < Increase::Internal::Type::BaseModel
       #   @return [String, nil]
       required :creditor_name, String, nil?: true
 
+      # @!attribute debtor_account_number
+      #   The account number of the sender.
+      #
+      #   @return [String, nil]
+      required :debtor_account_number, String, nil?: true
+
       # @!attribute debtor_address_line1
       #   A free-form address field set by the sender.
       #
@@ -89,6 +95,12 @@ class InboundWireTransfer < Increase::Internal::Type::BaseModel
       #   @return [String, nil]
       required :debtor_name, String, nil?: true
 
+      # @!attribute debtor_routing_number
+      #   The American Banking Association (ABA) routing number of the sender.
+      #
+      #   @return [String, nil]
+      required :debtor_routing_number, String, nil?: true
+
       # @!attribute description
       #   An Increase-constructed description of the transfer.
       #
@@ -167,7 +179,7 @@ class InboundWireTransfer < Increase::Internal::Type::BaseModel
       #   @return [String, nil]
       required :wire_drawdown_request_id, String, nil?: true
 
-      # @!method initialize(id:, acceptance:, account_id:, account_number_id:, amount:, created_at:, creditor_address_line1:, creditor_address_line2:, creditor_address_line3:, creditor_name:, debtor_address_line1:, debtor_address_line2:, debtor_address_line3:, debtor_name:, description:, end_to_end_identification:, input_message_accountability_data:, instructing_agent_routing_number:, instruction_identification:, purpose:, reversal:, status:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:, wire_drawdown_request_id:)
+      # @!method initialize(id:, acceptance:, account_id:, account_number_id:, amount:, created_at:, creditor_address_line1:, creditor_address_line2:, creditor_address_line3:, creditor_name:, debtor_account_number:, debtor_address_line1:, debtor_address_line2:, debtor_address_line3:, debtor_name:, debtor_routing_number:, description:, end_to_end_identification:, input_message_accountability_data:, instructing_agent_routing_number:, instruction_identification:, purpose:, reversal:, status:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:, wire_drawdown_request_id:)
       #   An Inbound Wire Transfer is a wire transfer initiated outside of Increase to
       #   your account.
       #
@@ -194,6 +206,8 @@ class InboundWireTransfer < Increase::Internal::Type::BaseModel
       #
       #   @param creditor_name [String, nil] A name set by the sender.
       #
+      #   @param debtor_account_number [String, nil] The account number of the sender.
+      #
       #   @param debtor_address_line1 [String, nil] A free-form address field set by the sender.
       #
       #   @param debtor_address_line2 [String, nil] A free-form address field set by the sender.
@@ -202,6 +216,9 @@ class InboundWireTransfer < Increase::Internal::Type::BaseModel
       #
       #   @param debtor_name [String, nil] A name set by the sender.
       #
+      #   @param debtor_routing_number [String, nil]
+      #     The American Banking Association (ABA) routing number of the sender.
+      #
       #   @param description [String] An Increase-constructed description of the transfer.
       #
       #   @param end_to_end_identification [String, nil]

lib/increase/models/simulations/ach_transfer_return_params.rb

@@ -14,16 +14,29 @@ class ACHTransferReturnParams < Increase::Internal::Type::BaseModel
         #   @return [String]
         required :ach_transfer_id, String
 
+        # @!attribute 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.
+        #
+        #   @return [String, nil]
+        optional :addenda_information, String
+
         # @!attribute reason
         #   The reason why the Federal Reserve or destination bank returned this transfer.
         #   Defaults to `no_account`.
         #
         #   @return [Symbol, Increase::Models::Simulations::ACHTransferReturnParams::Reason, nil]
         optional :reason, enum: -> { Increase::Simulations::ACHTransferReturnParams::Reason }
 
-        # @!method initialize(ach_transfer_id:, reason: nil, request_options: {})
+        # @!method initialize(ach_transfer_id:, addenda_information: nil, reason: nil, request_options: {})
         #   @param ach_transfer_id [String] The identifier of the ACH Transfer you wish to return.
         #
+        #   @param addenda_information [String]
+        #     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.
+        #
         #   @param reason [Symbol, Increase::Models::Simulations::ACHTransferReturnParams::Reason]
         #     The reason why the Federal Reserve or destination bank returned this transfer.
         #     Defaults to `no_account`.
@@ -85,7 +98,7 @@ module Reason
           # Code R13. The routing number is invalid.
           INVALID_ACH_ROUTING_NUMBER = :invalid_ach_routing_number
 
-          # Code R17. The receiving bank is unable to process a field in the transfer.
+          # 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.
           FILE_RECORD_EDIT_CRITERIA = :file_record_edit_criteria
 
           # Code R45. A rare return reason. The individual name field was invalid.

lib/increase/models/simulations/card_settlement_create_params.rb

@@ -14,30 +14,32 @@ class CardSettlementCreateParams < Increase::Internal::Type::BaseModel
         #   @return [String]
         required :card_id, String
 
-        # @!attribute pending_transaction_id
-        #   The identifier of the Pending Transaction for the Card Authorization you wish to
-        #   settle.
-        #
-        #   @return [String]
-        required :pending_transaction_id, String
-
         # @!attribute 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.
         #
         #   @return [Integer, nil]
         optional :amount, Integer
 
-        # @!method initialize(card_id:, pending_transaction_id:, amount: nil, request_options: {})
-        #   @param card_id [String] The identifier of the Card to create a settlement on.
+        # @!attribute 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.
         #
-        #   @param pending_transaction_id [String]
-        #     The identifier of the Pending Transaction for the Card Authorization you wish to
-        #     settle.
+        #   @return [String, nil]
+        optional :pending_transaction_id, String
+
+        # @!method initialize(card_id:, amount: nil, pending_transaction_id: nil, request_options: {})
+        #   @param card_id [String] The identifier of the Card to create a settlement on.
         #
         #   @param amount [Integer]
         #     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.
+        #
+        #   @param pending_transaction_id [String]
+        #     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.
         #
         #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
       end

lib/increase/models/simulations/program_create_params.rb

@@ -58,9 +58,6 @@ module Bank
           # Grasshopper Bank
           GRASSHOPPER_BANK = :grasshopper_bank
 
-          # Twin City Bank
-          TWIN_CITY_BANK = :twin_city_bank
-
           # @!method self.values
           #   @return [Array<Symbol>]
         end

lib/increase/models/swift_transfer.rb

@@ -93,6 +93,13 @@ class SwiftTransfer < Increase::Internal::Type::BaseModel
       #   @return [Symbol, Increase::Models::SwiftTransfer::InstructedCurrency]
       required :instructed_currency, enum: -> { Increase::SwiftTransfer::InstructedCurrency }
 
+      # @!attribute intermediary_bank_identification_code
+      #   The bank identification code (BIC) of the intermediary bank, if the transfer is
+      #   routed through one.
+      #
+      #   @return [String, nil]
+      required :intermediary_bank_identification_code, String, nil?: true
+
       # @!attribute pending_transaction_id
       #   The ID for the pending transaction representing the transfer.
       #
@@ -146,7 +153,7 @@ class SwiftTransfer < Increase::Internal::Type::BaseModel
       #   @return [String]
       required :unstructured_remittance_information, String
 
-      # @!method initialize(id:, account_id:, account_number:, amount:, bank_identification_code:, created_at:, created_by:, creditor_address:, creditor_name:, debtor_address:, debtor_name:, idempotency_key:, instructed_amount:, instructed_currency:, pending_transaction_id:, routing_number:, source_account_number_id:, status:, transaction_id:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
+      # @!method initialize(id:, account_id:, account_number:, amount:, bank_identification_code:, created_at:, created_by:, creditor_address:, creditor_name:, debtor_address:, debtor_name:, idempotency_key:, instructed_amount:, instructed_currency:, intermediary_bank_identification_code:, pending_transaction_id:, routing_number:, source_account_number_id:, status:, transaction_id:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
       #   Swift Transfers send funds internationally.
       #
       #   @param id [String] The Swift transfer's identifier.
@@ -187,6 +194,10 @@ class SwiftTransfer < Increase::Internal::Type::BaseModel
       #     The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the
       #     instructed amount.
       #
+      #   @param intermediary_bank_identification_code [String, nil]
+      #     The bank identification code (BIC) of the intermediary bank, if the transfer is
+      #     routed through one.
+      #
       #   @param pending_transaction_id [String, nil] The ID for the pending transaction representing the transfer.
       #
       #   @param routing_number [String, nil]