increase 1.77.0 → 1.79.0

data/rbi/increase/models/wire_transfer.rbi

@@ -101,7 +101,7 @@ module Increase
       attr_accessor :inbound_wire_drawdown_request_id
 
       # The message that will show on the recipient's bank statement.
-      sig { returns(T.nilable(String)) }
+      sig { returns(String) }
       attr_accessor :message_to_recipient
 
       # The transfer's network.
@@ -131,6 +131,17 @@ module Increase
       sig { returns(T.nilable(String)) }
       attr_accessor :pending_transaction_id
 
+      # Remittance information sent with the wire transfer.
+      sig { returns(T.nilable(Increase::WireTransfer::Remittance)) }
+      attr_reader :remittance
+
+      sig do
+        params(
+          remittance: T.nilable(Increase::WireTransfer::Remittance::OrHash)
+        ).void
+      end
+      attr_writer :remittance
+
       # If your transfer is reversed, this will contain details of the reversal.
       sig { returns(T.nilable(Increase::WireTransfer::Reversal)) }
       attr_reader :reversal
@@ -195,13 +206,14 @@ module Increase
           external_account_id: T.nilable(String),
           idempotency_key: T.nilable(String),
           inbound_wire_drawdown_request_id: T.nilable(String),
-          message_to_recipient: T.nilable(String),
+          message_to_recipient: String,
           network: Increase::WireTransfer::Network::OrSymbol,
           originator_address_line1: T.nilable(String),
           originator_address_line2: T.nilable(String),
           originator_address_line3: T.nilable(String),
           originator_name: T.nilable(String),
           pending_transaction_id: T.nilable(String),
+          remittance: T.nilable(Increase::WireTransfer::Remittance::OrHash),
           reversal: T.nilable(Increase::WireTransfer::Reversal::OrHash),
           routing_number: String,
           source_account_number_id: T.nilable(String),
@@ -268,6 +280,8 @@ module Increase
         # [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
         # by someone else in your organization.
         pending_transaction_id:,
+        # Remittance information sent with the wire transfer.
+        remittance:,
         # If your transfer is reversed, this will contain details of the reversal.
         reversal:,
         # The American Bankers' Association (ABA) Routing Transit Number (RTN).
@@ -306,13 +320,14 @@ module Increase
             external_account_id: T.nilable(String),
             idempotency_key: T.nilable(String),
             inbound_wire_drawdown_request_id: T.nilable(String),
-            message_to_recipient: T.nilable(String),
+            message_to_recipient: String,
             network: Increase::WireTransfer::Network::TaggedSymbol,
             originator_address_line1: T.nilable(String),
             originator_address_line2: T.nilable(String),
             originator_address_line3: T.nilable(String),
             originator_name: T.nilable(String),
             pending_transaction_id: T.nilable(String),
+            remittance: T.nilable(Increase::WireTransfer::Remittance),
             reversal: T.nilable(Increase::WireTransfer::Reversal),
             routing_number: String,
             source_account_number_id: T.nilable(String),
@@ -687,6 +702,203 @@ module Increase
         end
       end
 
+      class Remittance < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::WireTransfer::Remittance,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The type of remittance information being passed.
+        sig do
+          returns(Increase::WireTransfer::Remittance::Category::TaggedSymbol)
+        end
+        attr_accessor :category
+
+        # Internal Revenue Service (IRS) tax repayment information. Required if `category`
+        # is equal to `tax`.
+        sig { returns(T.nilable(Increase::WireTransfer::Remittance::Tax)) }
+        attr_reader :tax
+
+        sig do
+          params(
+            tax: T.nilable(Increase::WireTransfer::Remittance::Tax::OrHash)
+          ).void
+        end
+        attr_writer :tax
+
+        # Unstructured remittance information. Required if `category` is equal to
+        # `unstructured`.
+        sig do
+          returns(T.nilable(Increase::WireTransfer::Remittance::Unstructured))
+        end
+        attr_reader :unstructured
+
+        sig do
+          params(
+            unstructured:
+              T.nilable(
+                Increase::WireTransfer::Remittance::Unstructured::OrHash
+              )
+          ).void
+        end
+        attr_writer :unstructured
+
+        # Remittance information sent with the wire transfer.
+        sig do
+          params(
+            category: Increase::WireTransfer::Remittance::Category::OrSymbol,
+            tax: T.nilable(Increase::WireTransfer::Remittance::Tax::OrHash),
+            unstructured:
+              T.nilable(
+                Increase::WireTransfer::Remittance::Unstructured::OrHash
+              )
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The type of remittance information being passed.
+          category:,
+          # Internal Revenue Service (IRS) tax repayment information. Required if `category`
+          # is equal to `tax`.
+          tax:,
+          # Unstructured remittance information. Required if `category` is equal to
+          # `unstructured`.
+          unstructured:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              category:
+                Increase::WireTransfer::Remittance::Category::TaggedSymbol,
+              tax: T.nilable(Increase::WireTransfer::Remittance::Tax),
+              unstructured:
+                T.nilable(Increase::WireTransfer::Remittance::Unstructured)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The type of remittance information being passed.
+        module Category
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Increase::WireTransfer::Remittance::Category)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The wire transfer contains unstructured remittance information.
+          UNSTRUCTURED =
+            T.let(
+              :unstructured,
+              Increase::WireTransfer::Remittance::Category::TaggedSymbol
+            )
+
+          # The wire transfer is for tax payment purposes to the Internal Revenue Service (IRS).
+          TAX =
+            T.let(
+              :tax,
+              Increase::WireTransfer::Remittance::Category::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::WireTransfer::Remittance::Category::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Tax < Increase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Increase::WireTransfer::Remittance::Tax,
+                Increase::Internal::AnyHash
+              )
+            end
+
+          # The month and year the tax payment is for, in YYYY-MM-DD format. The day is
+          # ignored.
+          sig { returns(Date) }
+          attr_accessor :date
+
+          # The 9-digit Tax Identification Number (TIN) or Employer Identification Number
+          # (EIN).
+          sig { returns(String) }
+          attr_accessor :identification_number
+
+          # The 5-character tax type code.
+          sig { returns(String) }
+          attr_accessor :type_code
+
+          # Internal Revenue Service (IRS) tax repayment information. Required if `category`
+          # is equal to `tax`.
+          sig do
+            params(
+              date: Date,
+              identification_number: String,
+              type_code: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The month and year the tax payment is for, in YYYY-MM-DD format. The day is
+            # ignored.
+            date:,
+            # The 9-digit Tax Identification Number (TIN) or Employer Identification Number
+            # (EIN).
+            identification_number:,
+            # The 5-character tax type code.
+            type_code:
+          )
+          end
+
+          sig do
+            override.returns(
+              { date: Date, identification_number: String, type_code: String }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class Unstructured < Increase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Increase::WireTransfer::Remittance::Unstructured,
+                Increase::Internal::AnyHash
+              )
+            end
+
+          # The message to the beneficiary.
+          sig { returns(String) }
+          attr_accessor :message
+
+          # Unstructured remittance information. Required if `category` is equal to
+          # `unstructured`.
+          sig { params(message: String).returns(T.attached_class) }
+          def self.new(
+            # The message to the beneficiary.
+            message:
+          )
+          end
+
+          sig { override.returns({ message: String }) }
+          def to_hash
+          end
+        end
+      end
+
       class Reversal < Increase::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/increase/models/wire_transfer_create_params.rbi

@@ -23,10 +23,6 @@ module Increase
       sig { returns(String) }
       attr_accessor :beneficiary_name
 
-      # The message that will show on the recipient's bank statement.
-      sig { returns(String) }
-      attr_accessor :message_to_recipient
-
       # The account number for the destination account.
       sig { returns(T.nilable(String)) }
       attr_reader :account_number
@@ -103,6 +99,17 @@ module Increase
       sig { params(originator_name: String).void }
       attr_writer :originator_name
 
+      # Additional remittance information related to the wire transfer.
+      sig { returns(T.nilable(Increase::WireTransferCreateParams::Remittance)) }
+      attr_reader :remittance
+
+      sig do
+        params(
+          remittance: Increase::WireTransferCreateParams::Remittance::OrHash
+        ).void
+      end
+      attr_writer :remittance
+
       # Whether the transfer requires explicit approval via the dashboard or API.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :require_approval
@@ -130,7 +137,6 @@ module Increase
           account_id: String,
           amount: Integer,
           beneficiary_name: String,
-          message_to_recipient: String,
           account_number: String,
           beneficiary_address_line1: String,
           beneficiary_address_line2: String,
@@ -141,6 +147,7 @@ module Increase
           originator_address_line2: String,
           originator_address_line3: String,
           originator_name: String,
+          remittance: Increase::WireTransferCreateParams::Remittance::OrHash,
           require_approval: T::Boolean,
           routing_number: String,
           source_account_number_id: String,
@@ -154,8 +161,6 @@ module Increase
         amount:,
         # The beneficiary's name.
         beneficiary_name:,
-        # The message that will show on the recipient's bank statement.
-        message_to_recipient:,
         # The account number for the destination account.
         account_number: nil,
         # The beneficiary's address line 1.
@@ -182,6 +187,8 @@ module Increase
         # The originator's name. This is only necessary if you're transferring from a
         # commingled account. Otherwise, we'll use the associated entity's details.
         originator_name: nil,
+        # Additional remittance information related to the wire transfer.
+        remittance: nil,
         # Whether the transfer requires explicit approval via the dashboard or API.
         require_approval: nil,
         # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
@@ -199,7 +206,6 @@ module Increase
             account_id: String,
             amount: Integer,
             beneficiary_name: String,
-            message_to_recipient: String,
             account_number: String,
             beneficiary_address_line1: String,
             beneficiary_address_line2: String,
@@ -210,6 +216,7 @@ module Increase
             originator_address_line2: String,
             originator_address_line3: String,
             originator_name: String,
+            remittance: Increase::WireTransferCreateParams::Remittance,
             require_approval: T::Boolean,
             routing_number: String,
             source_account_number_id: String,
@@ -219,6 +226,213 @@ module Increase
       end
       def to_hash
       end
+
+      class Remittance < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::WireTransferCreateParams::Remittance,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The type of remittance information being passed.
+        sig do
+          returns(
+            Increase::WireTransferCreateParams::Remittance::Category::OrSymbol
+          )
+        end
+        attr_accessor :category
+
+        # Internal Revenue Service (IRS) tax repayment information. Required if `category`
+        # is equal to `tax`.
+        sig do
+          returns(
+            T.nilable(Increase::WireTransferCreateParams::Remittance::Tax)
+          )
+        end
+        attr_reader :tax
+
+        sig do
+          params(
+            tax: Increase::WireTransferCreateParams::Remittance::Tax::OrHash
+          ).void
+        end
+        attr_writer :tax
+
+        # Unstructured remittance information. Required if `category` is equal to
+        # `unstructured`.
+        sig do
+          returns(
+            T.nilable(
+              Increase::WireTransferCreateParams::Remittance::Unstructured
+            )
+          )
+        end
+        attr_reader :unstructured
+
+        sig do
+          params(
+            unstructured:
+              Increase::WireTransferCreateParams::Remittance::Unstructured::OrHash
+          ).void
+        end
+        attr_writer :unstructured
+
+        # Additional remittance information related to the wire transfer.
+        sig do
+          params(
+            category:
+              Increase::WireTransferCreateParams::Remittance::Category::OrSymbol,
+            tax: Increase::WireTransferCreateParams::Remittance::Tax::OrHash,
+            unstructured:
+              Increase::WireTransferCreateParams::Remittance::Unstructured::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The type of remittance information being passed.
+          category:,
+          # Internal Revenue Service (IRS) tax repayment information. Required if `category`
+          # is equal to `tax`.
+          tax: nil,
+          # Unstructured remittance information. Required if `category` is equal to
+          # `unstructured`.
+          unstructured: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              category:
+                Increase::WireTransferCreateParams::Remittance::Category::OrSymbol,
+              tax: Increase::WireTransferCreateParams::Remittance::Tax,
+              unstructured:
+                Increase::WireTransferCreateParams::Remittance::Unstructured
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The type of remittance information being passed.
+        module Category
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Increase::WireTransferCreateParams::Remittance::Category
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The wire transfer contains unstructured remittance information.
+          UNSTRUCTURED =
+            T.let(
+              :unstructured,
+              Increase::WireTransferCreateParams::Remittance::Category::TaggedSymbol
+            )
+
+          # The wire transfer is for tax payment purposes to the Internal Revenue Service (IRS).
+          TAX =
+            T.let(
+              :tax,
+              Increase::WireTransferCreateParams::Remittance::Category::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::WireTransferCreateParams::Remittance::Category::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Tax < Increase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Increase::WireTransferCreateParams::Remittance::Tax,
+                Increase::Internal::AnyHash
+              )
+            end
+
+          # The month and year the tax payment is for, in YYYY-MM-DD format. The day is
+          # ignored.
+          sig { returns(Date) }
+          attr_accessor :date
+
+          # The 9-digit Tax Identification Number (TIN) or Employer Identification Number
+          # (EIN).
+          sig { returns(String) }
+          attr_accessor :identification_number
+
+          # The 5-character tax type code.
+          sig { returns(String) }
+          attr_accessor :type_code
+
+          # Internal Revenue Service (IRS) tax repayment information. Required if `category`
+          # is equal to `tax`.
+          sig do
+            params(
+              date: Date,
+              identification_number: String,
+              type_code: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The month and year the tax payment is for, in YYYY-MM-DD format. The day is
+            # ignored.
+            date:,
+            # The 9-digit Tax Identification Number (TIN) or Employer Identification Number
+            # (EIN).
+            identification_number:,
+            # The 5-character tax type code.
+            type_code:
+          )
+          end
+
+          sig do
+            override.returns(
+              { date: Date, identification_number: String, type_code: String }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class Unstructured < Increase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Increase::WireTransferCreateParams::Remittance::Unstructured,
+                Increase::Internal::AnyHash
+              )
+            end
+
+          # The message to the beneficiary.
+          sig { returns(String) }
+          attr_accessor :message
+
+          # Unstructured remittance information. Required if `category` is equal to
+          # `unstructured`.
+          sig { params(message: String).returns(T.attached_class) }
+          def self.new(
+            # The message to the beneficiary.
+            message:
+          )
+          end
+
+          sig { override.returns({ message: String }) }
+          def to_hash
+          end
+        end
+      end
     end
   end
 end

data/rbi/increase/resources/wire_transfers.rbi

@@ -9,7 +9,6 @@ module Increase
           account_id: String,
           amount: Integer,
           beneficiary_name: String,
-          message_to_recipient: String,
           account_number: String,
           beneficiary_address_line1: String,
           beneficiary_address_line2: String,
@@ -20,6 +19,7 @@ module Increase
           originator_address_line2: String,
           originator_address_line3: String,
           originator_name: String,
+          remittance: Increase::WireTransferCreateParams::Remittance::OrHash,
           require_approval: T::Boolean,
           routing_number: String,
           source_account_number_id: String,
@@ -33,8 +33,6 @@ module Increase
         amount:,
         # The beneficiary's name.
         beneficiary_name:,
-        # The message that will show on the recipient's bank statement.
-        message_to_recipient:,
         # The account number for the destination account.
         account_number: nil,
         # The beneficiary's address line 1.
@@ -61,6 +59,8 @@ module Increase
         # The originator's name. This is only necessary if you're transferring from a
         # commingled account. Otherwise, we'll use the associated entity's details.
         originator_name: nil,
+        # Additional remittance information related to the wire transfer.
+        remittance: nil,
         # Whether the transfer requires explicit approval via the dashboard or API.
         require_approval: nil,
         # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the

data/sig/increase/models/declined_transaction.rbs

@@ -111,6 +111,7 @@ module Increase
           category: Increase::Models::DeclinedTransaction::Source::category,
           check_decline: Increase::DeclinedTransaction::Source::CheckDecline?,
           check_deposit_rejection: Increase::DeclinedTransaction::Source::CheckDepositRejection?,
+          inbound_fednow_transfer_decline: Increase::DeclinedTransaction::Source::InboundFednowTransferDecline?,
           inbound_real_time_payments_transfer_decline: Increase::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline?,
           other: top?,
           wire_decline: Increase::DeclinedTransaction::Source::WireDecline?
@@ -127,6 +128,8 @@ module Increase
 
         attr_accessor check_deposit_rejection: Increase::DeclinedTransaction::Source::CheckDepositRejection?
 
+        attr_accessor inbound_fednow_transfer_decline: Increase::DeclinedTransaction::Source::InboundFednowTransferDecline?
+
         attr_accessor inbound_real_time_payments_transfer_decline: Increase::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline?
 
         attr_accessor other: top?
@@ -139,6 +142,7 @@ module Increase
           category: Increase::Models::DeclinedTransaction::Source::category,
           check_decline: Increase::DeclinedTransaction::Source::CheckDecline?,
           check_deposit_rejection: Increase::DeclinedTransaction::Source::CheckDepositRejection?,
+          inbound_fednow_transfer_decline: Increase::DeclinedTransaction::Source::InboundFednowTransferDecline?,
           inbound_real_time_payments_transfer_decline: Increase::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline?,
           other: top?,
           wire_decline: Increase::DeclinedTransaction::Source::WireDecline?
@@ -150,6 +154,7 @@ module Increase
           category: Increase::Models::DeclinedTransaction::Source::category,
           check_decline: Increase::DeclinedTransaction::Source::CheckDecline?,
           check_deposit_rejection: Increase::DeclinedTransaction::Source::CheckDepositRejection?,
+          inbound_fednow_transfer_decline: Increase::DeclinedTransaction::Source::InboundFednowTransferDecline?,
           inbound_real_time_payments_transfer_decline: Increase::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline?,
           other: top?,
           wire_decline: Increase::DeclinedTransaction::Source::WireDecline?
@@ -1197,6 +1202,7 @@ module Increase
           | :card_decline
           | :check_decline
           | :inbound_real_time_payments_transfer_decline
+          | :inbound_fednow_transfer_decline
           | :wire_decline
           | :check_deposit_rejection
           | :other
@@ -1216,6 +1222,9 @@ module Increase
           # Inbound Real-Time Payments Transfer Decline: details will be under the `inbound_real_time_payments_transfer_decline` object.
           INBOUND_REAL_TIME_PAYMENTS_TRANSFER_DECLINE: :inbound_real_time_payments_transfer_decline
 
+          # Inbound FedNow Transfer Decline: details will be under the `inbound_fednow_transfer_decline` object.
+          INBOUND_FEDNOW_TRANSFER_DECLINE: :inbound_fednow_transfer_decline
+
           # Wire Decline: details will be under the `wire_decline` object.
           WIRE_DECLINE: :wire_decline
 
@@ -1475,6 +1484,60 @@ module Increase
           end
         end
 
+        type inbound_fednow_transfer_decline =
+          {
+            reason: Increase::Models::DeclinedTransaction::Source::InboundFednowTransferDecline::reason,
+            transfer_id: String
+          }
+
+        class InboundFednowTransferDecline < Increase::Internal::Type::BaseModel
+          attr_accessor reason: Increase::Models::DeclinedTransaction::Source::InboundFednowTransferDecline::reason
+
+          attr_accessor transfer_id: String
+
+          def initialize: (
+            reason: Increase::Models::DeclinedTransaction::Source::InboundFednowTransferDecline::reason,
+            transfer_id: String
+          ) -> void
+
+          def to_hash: -> {
+            reason: Increase::Models::DeclinedTransaction::Source::InboundFednowTransferDecline::reason,
+            transfer_id: String
+          }
+
+          type reason =
+            :account_number_canceled
+            | :account_number_disabled
+            | :account_restricted
+            | :group_locked
+            | :entity_not_active
+            | :fednow_not_enabled
+
+          module Reason
+            extend Increase::Internal::Type::Enum
+
+            # The account number is canceled.
+            ACCOUNT_NUMBER_CANCELED: :account_number_canceled
+
+            # The account number is disabled.
+            ACCOUNT_NUMBER_DISABLED: :account_number_disabled
+
+            # Your account is restricted.
+            ACCOUNT_RESTRICTED: :account_restricted
+
+            # Your account is inactive.
+            GROUP_LOCKED: :group_locked
+
+            # The account's entity is not active.
+            ENTITY_NOT_ACTIVE: :entity_not_active
+
+            # Your account is not enabled to receive FedNow transfers.
+            FEDNOW_NOT_ENABLED: :fednow_not_enabled
+
+            def self?.values: -> ::Array[Increase::Models::DeclinedTransaction::Source::InboundFednowTransferDecline::reason]
+          end
+        end
+
         type inbound_real_time_payments_transfer_decline =
           {
             amount: Integer,