increase 1.113.0 → 1.114.0

data/lib/increase/models/inbound_fednow_transfer_list_params.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::InboundFednowTransfers#list
+    class InboundFednowTransferListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   Filter Inbound FedNow Transfers to those belonging to the specified Account.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute account_number_id
+      #   Filter Inbound FedNow Transfers to ones belonging to the specified Account
+      #   Number.
+      #
+      #   @return [String, nil]
+      optional :account_number_id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Increase::Models::InboundFednowTransferListParams::CreatedAt, nil]
+      optional :created_at, -> { Increase::InboundFednowTransferListParams::CreatedAt }
+
+      # @!attribute cursor
+      #   Return the page of entries after this one.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute limit
+      #   Limit the size of the list that is returned. The default (and maximum) is 100
+      #   objects.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(account_id: nil, account_number_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::InboundFednowTransferListParams} for more details.
+      #
+      #   @param account_id [String] Filter Inbound FedNow Transfers to those belonging to the specified Account.
+      #
+      #   @param account_number_id [String] Filter Inbound FedNow Transfers to ones belonging to the specified Account Numbe
+      #
+      #   @param created_at [Increase::Models::InboundFednowTransferListParams::CreatedAt]
+      #
+      #   @param cursor [String] Return the page of entries after this one.
+      #
+      #   @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class CreatedAt < Increase::Internal::Type::BaseModel
+        # @!attribute after
+        #   Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #   timestamp.
+        #
+        #   @return [Time, nil]
+        optional :after, Time
+
+        # @!attribute before
+        #   Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #   timestamp.
+        #
+        #   @return [Time, nil]
+        optional :before, Time
+
+        # @!attribute on_or_after
+        #   Return results on or after this
+        #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        #
+        #   @return [Time, nil]
+        optional :on_or_after, Time
+
+        # @!attribute on_or_before
+        #   Return results on or before this
+        #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        #
+        #   @return [Time, nil]
+        optional :on_or_before, Time
+
+        # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::InboundFednowTransferListParams::CreatedAt} for more details.
+        #
+        #   @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
+        #
+        #   @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
+        #
+        #   @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
+        #
+        #   @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
+      end
+    end
+  end
+end

data/lib/increase/models/inbound_fednow_transfer_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::InboundFednowTransfers#retrieve
+    class InboundFednowTransferRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/simulations/inbound_fednow_transfer_create_params.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    module Simulations
+      # @see Increase::Resources::Simulations::InboundFednowTransfers#create
+      class InboundFednowTransferCreateParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        # @!attribute account_number_id
+        #   The identifier of the Account Number the inbound FedNow Transfer is for.
+        #
+        #   @return [String]
+        required :account_number_id, String
+
+        # @!attribute amount
+        #   The transfer amount in USD cents. Must be positive.
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute debtor_account_number
+        #   The account number of the account that sent the transfer.
+        #
+        #   @return [String, nil]
+        optional :debtor_account_number, String
+
+        # @!attribute debtor_name
+        #   The name provided by the sender of the transfer.
+        #
+        #   @return [String, nil]
+        optional :debtor_name, String
+
+        # @!attribute debtor_routing_number
+        #   The routing number of the account that sent the transfer.
+        #
+        #   @return [String, nil]
+        optional :debtor_routing_number, String
+
+        # @!attribute unstructured_remittance_information
+        #   Additional information included with the transfer.
+        #
+        #   @return [String, nil]
+        optional :unstructured_remittance_information, String
+
+        # @!method initialize(account_number_id:, amount:, debtor_account_number: nil, debtor_name: nil, debtor_routing_number: nil, unstructured_remittance_information: nil, request_options: {})
+        #   @param account_number_id [String] The identifier of the Account Number the inbound FedNow Transfer is for.
+        #
+        #   @param amount [Integer] The transfer amount in USD cents. Must be positive.
+        #
+        #   @param debtor_account_number [String] The account number of the account that sent the transfer.
+        #
+        #   @param debtor_name [String] The name provided by the sender of the transfer.
+        #
+        #   @param debtor_routing_number [String] The routing number of the account that sent the transfer.
+        #
+        #   @param unstructured_remittance_information [String] Additional information included with the transfer.
+        #
+        #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/increase/models.rb

@@ -317,6 +317,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
@@ -356,6 +368,12 @@ 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/lib/increase/resources/fednow_transfers.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class FednowTransfers
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::FednowTransferCreateParams} for more details.
+      #
+      # Create a FedNow Transfer
+      #
+      # @overload create(account_id:, amount:, creditor_name:, debtor_name:, source_account_number_id:, unstructured_remittance_information:, account_number: nil, creditor_address: nil, debtor_address: nil, external_account_id: nil, require_approval: nil, routing_number: nil, request_options: {})
+      #
+      # @param account_id [String] The identifier for the account that will send the transfer.
+      #
+      # @param amount [Integer] The amount, in minor units, to send to the creditor.
+      #
+      # @param creditor_name [String] The creditor's name.
+      #
+      # @param debtor_name [String] The debtor's name.
+      #
+      # @param source_account_number_id [String] The Account Number to include in the transfer as the debtor's account number.
+      #
+      # @param unstructured_remittance_information [String] Unstructured remittance information to include in the transfer.
+      #
+      # @param account_number [String] The creditor's account number.
+      #
+      # @param creditor_address [Increase::Models::FednowTransferCreateParams::CreditorAddress] The creditor's address.
+      #
+      # @param debtor_address [Increase::Models::FednowTransferCreateParams::DebtorAddress] The debtor's address.
+      #
+      # @param external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr
+      #
+      # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
+      #
+      # @param routing_number [String] The creditor's bank account routing number.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::FednowTransfer]
+      #
+      # @see Increase::Models::FednowTransferCreateParams
+      def create(params)
+        parsed, options = Increase::FednowTransferCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "fednow_transfers",
+          body: parsed,
+          model: Increase::FednowTransfer,
+          options: options
+        )
+      end
+
+      # Retrieve a FedNow Transfer
+      #
+      # @overload retrieve(fednow_transfer_id, request_options: {})
+      #
+      # @param fednow_transfer_id [String] The identifier of the FedNow Transfer.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::FednowTransfer]
+      #
+      # @see Increase::Models::FednowTransferRetrieveParams
+      def retrieve(fednow_transfer_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["fednow_transfers/%1$s", fednow_transfer_id],
+          model: Increase::FednowTransfer,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::FednowTransferListParams} for more details.
+      #
+      # List FedNow Transfers
+      #
+      # @overload list(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
+      #
+      # @param account_id [String] Filter FedNow Transfers to those that originated from the specified Account.
+      #
+      # @param created_at [Increase::Models::FednowTransferListParams::CreatedAt]
+      #
+      # @param cursor [String] Return the page of entries after this one.
+      #
+      # @param external_account_id [String] Filter FedNow Transfers to those made to the specified External Account.
+      #
+      # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
+      #
+      # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      # @param status [Increase::Models::FednowTransferListParams::Status]
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Internal::Page<Increase::Models::FednowTransfer>]
+      #
+      # @see Increase::Models::FednowTransferListParams
+      def list(params = {})
+        parsed, options = Increase::FednowTransferListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "fednow_transfers",
+          query: parsed,
+          page: Increase::Internal::Page,
+          model: Increase::FednowTransfer,
+          options: options
+        )
+      end
+
+      # Approve a FedNow Transfer
+      #
+      # @overload approve(fednow_transfer_id, request_options: {})
+      #
+      # @param fednow_transfer_id [String] The identifier of the FedNow Transfer to approve.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::FednowTransfer]
+      #
+      # @see Increase::Models::FednowTransferApproveParams
+      def approve(fednow_transfer_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["fednow_transfers/%1$s/approve", fednow_transfer_id],
+          model: Increase::FednowTransfer,
+          options: params[:request_options]
+        )
+      end
+
+      # Cancel a pending FedNow Transfer
+      #
+      # @overload cancel(fednow_transfer_id, request_options: {})
+      #
+      # @param fednow_transfer_id [String] The identifier of the pending FedNow Transfer to cancel.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::FednowTransfer]
+      #
+      # @see Increase::Models::FednowTransferCancelParams
+      def cancel(fednow_transfer_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["fednow_transfers/%1$s/cancel", fednow_transfer_id],
+          model: Increase::FednowTransfer,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/increase/resources/inbound_fednow_transfers.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class InboundFednowTransfers
+      # Retrieve an Inbound FedNow Transfer
+      #
+      # @overload retrieve(inbound_fednow_transfer_id, request_options: {})
+      #
+      # @param inbound_fednow_transfer_id [String] The identifier of the Inbound FedNow Transfer to get details for.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::InboundFednowTransfer]
+      #
+      # @see Increase::Models::InboundFednowTransferRetrieveParams
+      def retrieve(inbound_fednow_transfer_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["inbound_fednow_transfers/%1$s", inbound_fednow_transfer_id],
+          model: Increase::InboundFednowTransfer,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::InboundFednowTransferListParams} for more details.
+      #
+      # List Inbound FedNow Transfers
+      #
+      # @overload list(account_id: nil, account_number_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {})
+      #
+      # @param account_id [String] Filter Inbound FedNow Transfers to those belonging to the specified Account.
+      #
+      # @param account_number_id [String] Filter Inbound FedNow Transfers to ones belonging to the specified Account Numbe
+      #
+      # @param created_at [Increase::Models::InboundFednowTransferListParams::CreatedAt]
+      #
+      # @param cursor [String] Return the page of entries after this one.
+      #
+      # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Internal::Page<Increase::Models::InboundFednowTransfer>]
+      #
+      # @see Increase::Models::InboundFednowTransferListParams
+      def list(params = {})
+        parsed, options = Increase::InboundFednowTransferListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "inbound_fednow_transfers",
+          query: parsed,
+          page: Increase::Internal::Page,
+          model: Increase::InboundFednowTransfer,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/increase/resources/simulations/inbound_fednow_transfers.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Simulations
+      class InboundFednowTransfers
+        # Simulates an [Inbound FedNow Transfer](#inbound-fednow-transfers) to your
+        # account.
+        #
+        # @overload create(account_number_id:, amount:, debtor_account_number: nil, debtor_name: nil, debtor_routing_number: nil, unstructured_remittance_information: nil, request_options: {})
+        #
+        # @param account_number_id [String] The identifier of the Account Number the inbound FedNow Transfer is for.
+        #
+        # @param amount [Integer] The transfer amount in USD cents. Must be positive.
+        #
+        # @param debtor_account_number [String] The account number of the account that sent the transfer.
+        #
+        # @param debtor_name [String] The name provided by the sender of the transfer.
+        #
+        # @param debtor_routing_number [String] The routing number of the account that sent the transfer.
+        #
+        # @param unstructured_remittance_information [String] Additional information included with the transfer.
+        #
+        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Increase::Models::InboundFednowTransfer]
+        #
+        # @see Increase::Models::Simulations::InboundFednowTransferCreateParams
+        def create(params)
+          parsed, options = Increase::Simulations::InboundFednowTransferCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "simulations/inbound_fednow_transfers",
+            body: parsed,
+            model: Increase::InboundFednowTransfer,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Increase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/increase/resources/simulations.rb

@@ -72,6 +72,9 @@ module Increase
       # @return [Increase::Resources::Simulations::InboundRealTimePaymentsTransfers]
       attr_reader :inbound_real_time_payments_transfers
 
+      # @return [Increase::Resources::Simulations::InboundFednowTransfers]
+      attr_reader :inbound_fednow_transfers
+
       # @return [Increase::Resources::Simulations::CheckDeposits]
       attr_reader :check_deposits
 
@@ -123,6 +126,7 @@ module Increase
           Increase::Resources::Simulations::RealTimePaymentsTransfers.new(client: client)
         @inbound_real_time_payments_transfers =
           Increase::Resources::Simulations::InboundRealTimePaymentsTransfers.new(client: client)
+        @inbound_fednow_transfers = Increase::Resources::Simulations::InboundFednowTransfers.new(client: client)
         @check_deposits = Increase::Resources::Simulations::CheckDeposits.new(client: client)
         @inbound_mail_items = Increase::Resources::Simulations::InboundMailItems.new(client: client)
         @programs = Increase::Resources::Simulations::Programs.new(client: client)

data/lib/increase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Increase
-  VERSION = "1.113.0"
+  VERSION = "1.114.0"
 end

data/lib/increase.rb

@@ -190,6 +190,12 @@ require_relative "increase/models/external_account_create_params"
 require_relative "increase/models/external_account_list_params"
 require_relative "increase/models/external_account_retrieve_params"
 require_relative "increase/models/external_account_update_params"
+require_relative "increase/models/fednow_transfer"
+require_relative "increase/models/fednow_transfer_approve_params"
+require_relative "increase/models/fednow_transfer_cancel_params"
+require_relative "increase/models/fednow_transfer_create_params"
+require_relative "increase/models/fednow_transfer_list_params"
+require_relative "increase/models/fednow_transfer_retrieve_params"
 require_relative "increase/models/file"
 require_relative "increase/models/file_create_params"
 require_relative "increase/models/file_link"
@@ -209,6 +215,9 @@ require_relative "increase/models/inbound_check_deposit_decline_params"
 require_relative "increase/models/inbound_check_deposit_list_params"
 require_relative "increase/models/inbound_check_deposit_retrieve_params"
 require_relative "increase/models/inbound_check_deposit_return_params"
+require_relative "increase/models/inbound_fednow_transfer"
+require_relative "increase/models/inbound_fednow_transfer_list_params"
+require_relative "increase/models/inbound_fednow_transfer_retrieve_params"
 require_relative "increase/models/inbound_mail_item"
 require_relative "increase/models/inbound_mail_item_list_params"
 require_relative "increase/models/inbound_mail_item_retrieve_params"
@@ -303,6 +312,7 @@ require_relative "increase/models/simulations/digital_wallet_token_request_creat
 require_relative "increase/models/simulations/document_create_params"
 require_relative "increase/models/simulations/inbound_ach_transfer_create_params"
 require_relative "increase/models/simulations/inbound_check_deposit_create_params"
+require_relative "increase/models/simulations/inbound_fednow_transfer_create_params"
 require_relative "increase/models/simulations/inbound_mail_item_create_params"
 require_relative "increase/models/simulations/inbound_real_time_payments_transfer_create_params"
 require_relative "increase/models/simulations/inbound_wire_drawdown_request_create_params"
@@ -360,11 +370,13 @@ require_relative "increase/resources/events"
 require_relative "increase/resources/event_subscriptions"
 require_relative "increase/resources/exports"
 require_relative "increase/resources/external_accounts"
+require_relative "increase/resources/fednow_transfers"
 require_relative "increase/resources/file_links"
 require_relative "increase/resources/files"
 require_relative "increase/resources/groups"
 require_relative "increase/resources/inbound_ach_transfers"
 require_relative "increase/resources/inbound_check_deposits"
+require_relative "increase/resources/inbound_fednow_transfers"
 require_relative "increase/resources/inbound_mail_items"
 require_relative "increase/resources/inbound_real_time_payments_transfers"
 require_relative "increase/resources/inbound_wire_drawdown_requests"
@@ -402,6 +414,7 @@ require_relative "increase/resources/simulations/digital_wallet_token_requests"
 require_relative "increase/resources/simulations/documents"
 require_relative "increase/resources/simulations/inbound_ach_transfers"
 require_relative "increase/resources/simulations/inbound_check_deposits"
+require_relative "increase/resources/simulations/inbound_fednow_transfers"
 require_relative "increase/resources/simulations/inbound_mail_items"
 require_relative "increase/resources/simulations/inbound_real_time_payments_transfers"
 require_relative "increase/resources/simulations/inbound_wire_drawdown_requests"

data/rbi/increase/client.rbi

@@ -97,6 +97,12 @@ module Increase
     sig { returns(Increase::Resources::InboundRealTimePaymentsTransfers) }
     attr_reader :inbound_real_time_payments_transfers
 
+    sig { returns(Increase::Resources::FednowTransfers) }
+    attr_reader :fednow_transfers
+
+    sig { returns(Increase::Resources::InboundFednowTransfers) }
+    attr_reader :inbound_fednow_transfers
+
     sig { returns(Increase::Resources::CheckDeposits) }
     attr_reader :check_deposits