increase 1.113.0 → 1.115.0

data/rbi/increase/models/pending_transaction.rbi

@@ -1372,6 +1372,26 @@ module Increase
             end
             attr_writer :dental
 
+            # The original pre-authorized amount.
+            sig do
+              returns(
+                T.nilable(
+                  Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Original
+                )
+              )
+            end
+            attr_reader :original
+
+            sig do
+              params(
+                original:
+                  T.nilable(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Original::OrHash
+                  )
+              ).void
+            end
+            attr_writer :original
+
             # The part of this transaction amount that was for healthcare prescriptions.
             sig do
               returns(
@@ -1525,6 +1545,10 @@ module Increase
                   T.nilable(
                     Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Dental::OrHash
                   ),
+                original:
+                  T.nilable(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Original::OrHash
+                  ),
                 prescription:
                   T.nilable(
                     Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Prescription::OrHash
@@ -1560,6 +1584,8 @@ module Increase
               clinic:,
               # The part of this transaction amount that was for dental-related services.
               dental:,
+              # The original pre-authorized amount.
+              original:,
               # The part of this transaction amount that was for healthcare prescriptions.
               prescription:,
               # The surcharge amount charged for this transaction by the merchant.
@@ -1588,6 +1614,10 @@ module Increase
                     T.nilable(
                       Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Dental
                     ),
+                  original:
+                    T.nilable(
+                      Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Original
+                    ),
                   prescription:
                     T.nilable(
                       Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Prescription
@@ -1706,6 +1736,48 @@ module Increase
               end
             end
 
+            class Original < Increase::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Original,
+                    Increase::Internal::AnyHash
+                  )
+                end
+
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
+              sig { returns(Integer) }
+              attr_accessor :amount
+
+              # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+              # amount's currency.
+              sig { returns(String) }
+              attr_accessor :currency
+
+              # The original pre-authorized amount.
+              sig do
+                params(amount: Integer, currency: String).returns(
+                  T.attached_class
+                )
+              end
+              def self.new(
+                # The amount in minor units of the `currency` field. The amount is positive if it
+                # is added to the amount (such as an ATM surcharge fee) and negative if it is
+                # subtracted from the amount (such as a discount).
+                amount:,
+                # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+                # amount's currency.
+                currency:
+              )
+              end
+
+              sig { override.returns({ amount: Integer, currency: String }) }
+              def to_hash
+              end
+            end
+
             class Prescription < Increase::Internal::Type::BaseModel
               OrHash =
                 T.type_alias do

data/rbi/increase/models/real_time_decision.rbi

@@ -870,6 +870,26 @@ module Increase
           end
           attr_writer :dental
 
+          # The original pre-authorized amount.
+          sig do
+            returns(
+              T.nilable(
+                Increase::RealTimeDecision::CardAuthorization::AdditionalAmounts::Original
+              )
+            )
+          end
+          attr_reader :original
+
+          sig do
+            params(
+              original:
+                T.nilable(
+                  Increase::RealTimeDecision::CardAuthorization::AdditionalAmounts::Original::OrHash
+                )
+            ).void
+          end
+          attr_writer :original
+
           # The part of this transaction amount that was for healthcare prescriptions.
           sig do
             returns(
@@ -1023,6 +1043,10 @@ module Increase
                 T.nilable(
                   Increase::RealTimeDecision::CardAuthorization::AdditionalAmounts::Dental::OrHash
                 ),
+              original:
+                T.nilable(
+                  Increase::RealTimeDecision::CardAuthorization::AdditionalAmounts::Original::OrHash
+                ),
               prescription:
                 T.nilable(
                   Increase::RealTimeDecision::CardAuthorization::AdditionalAmounts::Prescription::OrHash
@@ -1058,6 +1082,8 @@ module Increase
             clinic:,
             # The part of this transaction amount that was for dental-related services.
             dental:,
+            # The original pre-authorized amount.
+            original:,
             # The part of this transaction amount that was for healthcare prescriptions.
             prescription:,
             # The surcharge amount charged for this transaction by the merchant.
@@ -1086,6 +1112,10 @@ module Increase
                   T.nilable(
                     Increase::RealTimeDecision::CardAuthorization::AdditionalAmounts::Dental
                   ),
+                original:
+                  T.nilable(
+                    Increase::RealTimeDecision::CardAuthorization::AdditionalAmounts::Original
+                  ),
                 prescription:
                   T.nilable(
                     Increase::RealTimeDecision::CardAuthorization::AdditionalAmounts::Prescription
@@ -1204,6 +1234,48 @@ module Increase
             end
           end
 
+          class Original < Increase::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Increase::RealTimeDecision::CardAuthorization::AdditionalAmounts::Original,
+                  Increase::Internal::AnyHash
+                )
+              end
+
+            # The amount in minor units of the `currency` field. The amount is positive if it
+            # is added to the amount (such as an ATM surcharge fee) and negative if it is
+            # subtracted from the amount (such as a discount).
+            sig { returns(Integer) }
+            attr_accessor :amount
+
+            # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+            # amount's currency.
+            sig { returns(String) }
+            attr_accessor :currency
+
+            # The original pre-authorized amount.
+            sig do
+              params(amount: Integer, currency: String).returns(
+                T.attached_class
+              )
+            end
+            def self.new(
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
+              amount:,
+              # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+              # amount's currency.
+              currency:
+            )
+            end
+
+            sig { override.returns({ amount: Integer, currency: String }) }
+            def to_hash
+            end
+          end
+
           class Prescription < Increase::Internal::Type::BaseModel
             OrHash =
               T.type_alias do

data/rbi/increase/models/simulations/inbound_fednow_transfer_create_params.rbi

@@ -0,0 +1,100 @@
+# typed: strong
+
+module Increase
+  module Models
+    module Simulations
+      class InboundFednowTransferCreateParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::Simulations::InboundFednowTransferCreateParams,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The identifier of the Account Number the inbound FedNow Transfer is for.
+        sig { returns(String) }
+        attr_accessor :account_number_id
+
+        # The transfer amount in USD cents. Must be positive.
+        sig { returns(Integer) }
+        attr_accessor :amount
+
+        # The account number of the account that sent the transfer.
+        sig { returns(T.nilable(String)) }
+        attr_reader :debtor_account_number
+
+        sig { params(debtor_account_number: String).void }
+        attr_writer :debtor_account_number
+
+        # The name provided by the sender of the transfer.
+        sig { returns(T.nilable(String)) }
+        attr_reader :debtor_name
+
+        sig { params(debtor_name: String).void }
+        attr_writer :debtor_name
+
+        # The routing number of the account that sent the transfer.
+        sig { returns(T.nilable(String)) }
+        attr_reader :debtor_routing_number
+
+        sig { params(debtor_routing_number: String).void }
+        attr_writer :debtor_routing_number
+
+        # Additional information included with the transfer.
+        sig { returns(T.nilable(String)) }
+        attr_reader :unstructured_remittance_information
+
+        sig { params(unstructured_remittance_information: String).void }
+        attr_writer :unstructured_remittance_information
+
+        sig do
+          params(
+            account_number_id: String,
+            amount: Integer,
+            debtor_account_number: String,
+            debtor_name: String,
+            debtor_routing_number: String,
+            unstructured_remittance_information: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The identifier of the Account Number the inbound FedNow Transfer is for.
+          account_number_id:,
+          # The transfer amount in USD cents. Must be positive.
+          amount:,
+          # The account number of the account that sent the transfer.
+          debtor_account_number: nil,
+          # The name provided by the sender of the transfer.
+          debtor_name: nil,
+          # The routing number of the account that sent the transfer.
+          debtor_routing_number: nil,
+          # Additional information included with the transfer.
+          unstructured_remittance_information: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              account_number_id: String,
+              amount: Integer,
+              debtor_account_number: String,
+              debtor_name: String,
+              debtor_routing_number: String,
+              unstructured_remittance_information: String,
+              request_options: Increase::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models/transaction.rbi

@@ -3068,6 +3068,26 @@ module Increase
             end
             attr_writer :dental
 
+            # The original pre-authorized amount.
+            sig do
+              returns(
+                T.nilable(
+                  Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Original
+                )
+              )
+            end
+            attr_reader :original
+
+            sig do
+              params(
+                original:
+                  T.nilable(
+                    Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Original::OrHash
+                  )
+              ).void
+            end
+            attr_writer :original
+
             # The part of this transaction amount that was for healthcare prescriptions.
             sig do
               returns(
@@ -3221,6 +3241,10 @@ module Increase
                   T.nilable(
                     Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Dental::OrHash
                   ),
+                original:
+                  T.nilable(
+                    Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Original::OrHash
+                  ),
                 prescription:
                   T.nilable(
                     Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Prescription::OrHash
@@ -3256,6 +3280,8 @@ module Increase
               clinic:,
               # The part of this transaction amount that was for dental-related services.
               dental:,
+              # The original pre-authorized amount.
+              original:,
               # The part of this transaction amount that was for healthcare prescriptions.
               prescription:,
               # The surcharge amount charged for this transaction by the merchant.
@@ -3284,6 +3310,10 @@ module Increase
                     T.nilable(
                       Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Dental
                     ),
+                  original:
+                    T.nilable(
+                      Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Original
+                    ),
                   prescription:
                     T.nilable(
                       Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Prescription
@@ -3402,6 +3432,48 @@ module Increase
               end
             end
 
+            class Original < Increase::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Original,
+                    Increase::Internal::AnyHash
+                  )
+                end
+
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
+              sig { returns(Integer) }
+              attr_accessor :amount
+
+              # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+              # amount's currency.
+              sig { returns(String) }
+              attr_accessor :currency
+
+              # The original pre-authorized amount.
+              sig do
+                params(amount: Integer, currency: String).returns(
+                  T.attached_class
+                )
+              end
+              def self.new(
+                # The amount in minor units of the `currency` field. The amount is positive if it
+                # is added to the amount (such as an ATM surcharge fee) and negative if it is
+                # subtracted from the amount (such as a discount).
+                amount:,
+                # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+                # amount's currency.
+                currency:
+              )
+              end
+
+              sig { override.returns({ amount: Integer, currency: String }) }
+              def to_hash
+              end
+            end
+
             class Prescription < Increase::Internal::Type::BaseModel
               OrHash =
                 T.type_alias do

data/rbi/increase/models.rbi

@@ -312,6 +312,18 @@ module Increase
 
   ExternalAccountUpdateParams = Increase::Models::ExternalAccountUpdateParams
 
+  FednowTransfer = Increase::Models::FednowTransfer
+
+  FednowTransferApproveParams = Increase::Models::FednowTransferApproveParams
+
+  FednowTransferCancelParams = Increase::Models::FednowTransferCancelParams
+
+  FednowTransferCreateParams = Increase::Models::FednowTransferCreateParams
+
+  FednowTransferListParams = Increase::Models::FednowTransferListParams
+
+  FednowTransferRetrieveParams = Increase::Models::FednowTransferRetrieveParams
+
   File = Increase::Models::File
 
   FileCreateParams = Increase::Models::FileCreateParams
@@ -358,6 +370,14 @@ module Increase
   InboundCheckDepositReturnParams =
     Increase::Models::InboundCheckDepositReturnParams
 
+  InboundFednowTransfer = Increase::Models::InboundFednowTransfer
+
+  InboundFednowTransferListParams =
+    Increase::Models::InboundFednowTransferListParams
+
+  InboundFednowTransferRetrieveParams =
+    Increase::Models::InboundFednowTransferRetrieveParams
+
   InboundMailItem = Increase::Models::InboundMailItem
 
   InboundMailItemListParams = Increase::Models::InboundMailItemListParams

data/rbi/increase/resources/fednow_transfers.rbi

@@ -0,0 +1,138 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class FednowTransfers
+      # Create a FedNow Transfer
+      sig do
+        params(
+          account_id: String,
+          amount: Integer,
+          creditor_name: String,
+          debtor_name: String,
+          source_account_number_id: String,
+          unstructured_remittance_information: String,
+          account_number: String,
+          creditor_address:
+            Increase::FednowTransferCreateParams::CreditorAddress::OrHash,
+          debtor_address:
+            Increase::FednowTransferCreateParams::DebtorAddress::OrHash,
+          external_account_id: String,
+          require_approval: T::Boolean,
+          routing_number: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::FednowTransfer)
+      end
+      def create(
+        # The identifier for the account that will send the transfer.
+        account_id:,
+        # The amount, in minor units, to send to the creditor.
+        amount:,
+        # The creditor's name.
+        creditor_name:,
+        # The debtor's name.
+        debtor_name:,
+        # The Account Number to include in the transfer as the debtor's account number.
+        source_account_number_id:,
+        # Unstructured remittance information to include in the transfer.
+        unstructured_remittance_information:,
+        # The creditor's account number.
+        account_number: nil,
+        # The creditor's address.
+        creditor_address: nil,
+        # The debtor's address.
+        debtor_address: nil,
+        # The ID of an External Account to initiate a transfer to. If this parameter is
+        # provided, `account_number` and `routing_number` must be absent.
+        external_account_id: nil,
+        # Whether the transfer requires explicit approval via the dashboard or API.
+        require_approval: nil,
+        # The creditor's bank account routing number.
+        routing_number: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a FedNow Transfer
+      sig do
+        params(
+          fednow_transfer_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::FednowTransfer)
+      end
+      def retrieve(
+        # The identifier of the FedNow Transfer.
+        fednow_transfer_id,
+        request_options: {}
+      )
+      end
+
+      # List FedNow Transfers
+      sig do
+        params(
+          account_id: String,
+          created_at: Increase::FednowTransferListParams::CreatedAt::OrHash,
+          cursor: String,
+          external_account_id: String,
+          idempotency_key: String,
+          limit: Integer,
+          status: Increase::FednowTransferListParams::Status::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::FednowTransfer])
+      end
+      def list(
+        # Filter FedNow Transfers to those that originated from the specified Account.
+        account_id: nil,
+        created_at: nil,
+        # Return the page of entries after this one.
+        cursor: nil,
+        # Filter FedNow Transfers to those made to the specified External Account.
+        external_account_id: nil,
+        # Filter records to the one with the specified `idempotency_key` you chose for
+        # that object. This value is unique across Increase and is used to ensure that a
+        # request is only processed once. Learn more about
+        # [idempotency](https://increase.com/documentation/idempotency-keys).
+        idempotency_key: nil,
+        # Limit the size of the list that is returned. The default (and maximum) is 100
+        # objects.
+        limit: nil,
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Approve a FedNow Transfer
+      sig do
+        params(
+          fednow_transfer_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::FednowTransfer)
+      end
+      def approve(
+        # The identifier of the FedNow Transfer to approve.
+        fednow_transfer_id,
+        request_options: {}
+      )
+      end
+
+      # Cancel a pending FedNow Transfer
+      sig do
+        params(
+          fednow_transfer_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::FednowTransfer)
+      end
+      def cancel(
+        # The identifier of the pending FedNow Transfer to cancel.
+        fednow_transfer_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Increase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/increase/resources/inbound_fednow_transfers.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class InboundFednowTransfers
+      # Retrieve an Inbound FedNow Transfer
+      sig do
+        params(
+          inbound_fednow_transfer_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::InboundFednowTransfer)
+      end
+      def retrieve(
+        # The identifier of the Inbound FedNow Transfer to get details for.
+        inbound_fednow_transfer_id,
+        request_options: {}
+      )
+      end
+
+      # List Inbound FedNow Transfers
+      sig do
+        params(
+          account_id: String,
+          account_number_id: String,
+          created_at:
+            Increase::InboundFednowTransferListParams::CreatedAt::OrHash,
+          cursor: String,
+          limit: Integer,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::InboundFednowTransfer])
+      end
+      def list(
+        # Filter Inbound FedNow Transfers to those belonging to the specified Account.
+        account_id: nil,
+        # Filter Inbound FedNow Transfers to ones belonging to the specified Account
+        # Number.
+        account_number_id: nil,
+        created_at: nil,
+        # Return the page of entries after this one.
+        cursor: nil,
+        # Limit the size of the list that is returned. The default (and maximum) is 100
+        # objects.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Increase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/increase/resources/simulations/inbound_fednow_transfers.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class InboundFednowTransfers
+        # Simulates an [Inbound FedNow Transfer](#inbound-fednow-transfers) to your
+        # account.
+        sig do
+          params(
+            account_number_id: String,
+            amount: Integer,
+            debtor_account_number: String,
+            debtor_name: String,
+            debtor_routing_number: String,
+            unstructured_remittance_information: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::InboundFednowTransfer)
+        end
+        def create(
+          # The identifier of the Account Number the inbound FedNow Transfer is for.
+          account_number_id:,
+          # The transfer amount in USD cents. Must be positive.
+          amount:,
+          # The account number of the account that sent the transfer.
+          debtor_account_number: nil,
+          # The name provided by the sender of the transfer.
+          debtor_name: nil,
+          # The routing number of the account that sent the transfer.
+          debtor_routing_number: nil,
+          # Additional information included with the transfer.
+          unstructured_remittance_information: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Increase::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end