increase 1.112.0 → 1.114.0

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.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

data/rbi/increase/resources/simulations.rbi

@@ -84,6 +84,9 @@ module Increase
       end
       attr_reader :inbound_real_time_payments_transfers
 
+      sig { returns(Increase::Resources::Simulations::InboundFednowTransfers) }
+      attr_reader :inbound_fednow_transfers
+
       sig { returns(Increase::Resources::Simulations::CheckDeposits) }
       attr_reader :check_deposits
 

data/sig/increase/client.rbs

@@ -65,6 +65,10 @@ module Increase
 
     attr_reader inbound_real_time_payments_transfers: Increase::Resources::InboundRealTimePaymentsTransfers
 
+    attr_reader fednow_transfers: Increase::Resources::FednowTransfers
+
+    attr_reader inbound_fednow_transfers: Increase::Resources::InboundFednowTransfers
+
     attr_reader check_deposits: Increase::Resources::CheckDeposits
 
     attr_reader lockboxes: Increase::Resources::Lockboxes

data/sig/increase/models/check_transfer.rbs

@@ -151,7 +151,7 @@ module Increase
         # The available balance of the account must be at least the amount of the check, and a Pending Transaction will be created for the full amount.
         FULL: :full
 
-        # No balance check will performed; a zero-dollar Pending Transaction will be created.
+        # No balance check will performed when the check transfer is initiated. A zero-dollar Pending Transaction will be created. The balance will still be checked when the Inbound Check Deposit is created.
         NONE: :none
 
         def self?.values: -> ::Array[Increase::Models::CheckTransfer::balance_check]