increase 1.113.0 → 1.114.0

data/rbi/increase/models/fednow_transfer_approve_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Increase
+  module Models
+    class FednowTransferApproveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::FednowTransferApproveParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: Increase::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Increase::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/fednow_transfer_cancel_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Increase
+  module Models
+    class FednowTransferCancelParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::FednowTransferCancelParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: Increase::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Increase::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/fednow_transfer_create_params.rbi

@@ -0,0 +1,289 @@
+# typed: strong
+
+module Increase
+  module Models
+    class FednowTransferCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::FednowTransferCreateParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The identifier for the account that will send the transfer.
+      sig { returns(String) }
+      attr_accessor :account_id
+
+      # The amount, in minor units, to send to the creditor.
+      sig { returns(Integer) }
+      attr_accessor :amount
+
+      # The creditor's name.
+      sig { returns(String) }
+      attr_accessor :creditor_name
+
+      # The debtor's name.
+      sig { returns(String) }
+      attr_accessor :debtor_name
+
+      # The Account Number to include in the transfer as the debtor's account number.
+      sig { returns(String) }
+      attr_accessor :source_account_number_id
+
+      # Unstructured remittance information to include in the transfer.
+      sig { returns(String) }
+      attr_accessor :unstructured_remittance_information
+
+      # The creditor's account number.
+      sig { returns(T.nilable(String)) }
+      attr_reader :account_number
+
+      sig { params(account_number: String).void }
+      attr_writer :account_number
+
+      # The creditor's address.
+      sig do
+        returns(
+          T.nilable(Increase::FednowTransferCreateParams::CreditorAddress)
+        )
+      end
+      attr_reader :creditor_address
+
+      sig do
+        params(
+          creditor_address:
+            Increase::FednowTransferCreateParams::CreditorAddress::OrHash
+        ).void
+      end
+      attr_writer :creditor_address
+
+      # The debtor's address.
+      sig do
+        returns(T.nilable(Increase::FednowTransferCreateParams::DebtorAddress))
+      end
+      attr_reader :debtor_address
+
+      sig do
+        params(
+          debtor_address:
+            Increase::FednowTransferCreateParams::DebtorAddress::OrHash
+        ).void
+      end
+      attr_writer :debtor_address
+
+      # The ID of an External Account to initiate a transfer to. If this parameter is
+      # provided, `account_number` and `routing_number` must be absent.
+      sig { returns(T.nilable(String)) }
+      attr_reader :external_account_id
+
+      sig { params(external_account_id: String).void }
+      attr_writer :external_account_id
+
+      # Whether the transfer requires explicit approval via the dashboard or API.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :require_approval
+
+      sig { params(require_approval: T::Boolean).void }
+      attr_writer :require_approval
+
+      # The creditor's bank account routing number.
+      sig { returns(T.nilable(String)) }
+      attr_reader :routing_number
+
+      sig { params(routing_number: String).void }
+      attr_writer :routing_number
+
+      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(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            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,
+            debtor_address: Increase::FednowTransferCreateParams::DebtorAddress,
+            external_account_id: String,
+            require_approval: T::Boolean,
+            routing_number: String,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class CreditorAddress < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::FednowTransferCreateParams::CreditorAddress,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The city, district, town, or village of the address.
+        sig { returns(String) }
+        attr_accessor :city
+
+        # The postal code component of the address.
+        sig { returns(String) }
+        attr_accessor :postal_code
+
+        # The US state component of the address.
+        sig { returns(String) }
+        attr_accessor :state
+
+        # The first line of the address. This is usually the street number and street.
+        sig { returns(T.nilable(String)) }
+        attr_reader :line1
+
+        sig { params(line1: String).void }
+        attr_writer :line1
+
+        # The creditor's address.
+        sig do
+          params(
+            city: String,
+            postal_code: String,
+            state: String,
+            line1: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The city, district, town, or village of the address.
+          city:,
+          # The postal code component of the address.
+          postal_code:,
+          # The US state component of the address.
+          state:,
+          # The first line of the address. This is usually the street number and street.
+          line1: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { city: String, postal_code: String, state: String, line1: String }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class DebtorAddress < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::FednowTransferCreateParams::DebtorAddress,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The city, district, town, or village of the address.
+        sig { returns(String) }
+        attr_accessor :city
+
+        # The postal code component of the address.
+        sig { returns(String) }
+        attr_accessor :postal_code
+
+        # The US state component of the address.
+        sig { returns(String) }
+        attr_accessor :state
+
+        # The first line of the address. This is usually the street number and street.
+        sig { returns(T.nilable(String)) }
+        attr_reader :line1
+
+        sig { params(line1: String).void }
+        attr_writer :line1
+
+        # The debtor's address.
+        sig do
+          params(
+            city: String,
+            postal_code: String,
+            state: String,
+            line1: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The city, district, town, or village of the address.
+          city:,
+          # The postal code component of the address.
+          postal_code:,
+          # The US state component of the address.
+          state:,
+          # The first line of the address. This is usually the street number and street.
+          line1: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { city: String, postal_code: String, state: String, line1: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models/fednow_transfer_list_params.rbi

@@ -0,0 +1,334 @@
+# typed: strong
+
+module Increase
+  module Models
+    class FednowTransferListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Increase::FednowTransferListParams, Increase::Internal::AnyHash)
+        end
+
+      # Filter FedNow Transfers to those that originated from the specified Account.
+      sig { returns(T.nilable(String)) }
+      attr_reader :account_id
+
+      sig { params(account_id: String).void }
+      attr_writer :account_id
+
+      sig { returns(T.nilable(Increase::FednowTransferListParams::CreatedAt)) }
+      attr_reader :created_at
+
+      sig do
+        params(
+          created_at: Increase::FednowTransferListParams::CreatedAt::OrHash
+        ).void
+      end
+      attr_writer :created_at
+
+      # Return the page of entries after this one.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cursor
+
+      sig { params(cursor: String).void }
+      attr_writer :cursor
+
+      # Filter FedNow Transfers to those made to the specified External Account.
+      sig { returns(T.nilable(String)) }
+      attr_reader :external_account_id
+
+      sig { params(external_account_id: String).void }
+      attr_writer :external_account_id
+
+      # 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).
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      # Limit the size of the list that is returned. The default (and maximum) is 100
+      # objects.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig { returns(T.nilable(Increase::FednowTransferListParams::Status)) }
+      attr_reader :status
+
+      sig do
+        params(status: Increase::FednowTransferListParams::Status::OrHash).void
+      end
+      attr_writer :status
+
+      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(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            created_at: Increase::FednowTransferListParams::CreatedAt,
+            cursor: String,
+            external_account_id: String,
+            idempotency_key: String,
+            limit: Integer,
+            status: Increase::FednowTransferListParams::Status,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class CreatedAt < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::FednowTransferListParams::CreatedAt,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        # timestamp.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :after
+
+        sig { params(after: Time).void }
+        attr_writer :after
+
+        # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        # timestamp.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :before
+
+        sig { params(before: Time).void }
+        attr_writer :before
+
+        # Return results on or after this
+        # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :on_or_after
+
+        sig { params(on_or_after: Time).void }
+        attr_writer :on_or_after
+
+        # Return results on or before this
+        # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :on_or_before
+
+        sig { params(on_or_before: Time).void }
+        attr_writer :on_or_before
+
+        sig do
+          params(
+            after: Time,
+            before: Time,
+            on_or_after: Time,
+            on_or_before: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+          # timestamp.
+          after: nil,
+          # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+          # timestamp.
+          before: nil,
+          # Return results on or after this
+          # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+          on_or_after: nil,
+          # Return results on or before this
+          # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+          on_or_before: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { after: Time, before: Time, on_or_after: Time, on_or_before: Time }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Status < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::FednowTransferListParams::Status,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # Return results whose value is in the provided list. For GET requests, this
+        # should be encoded as a comma-delimited string, such as `?in=one,two,three`.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Increase::FednowTransferListParams::Status::In::OrSymbol]
+            )
+          )
+        end
+        attr_reader :in_
+
+        sig do
+          params(
+            in_:
+              T::Array[Increase::FednowTransferListParams::Status::In::OrSymbol]
+          ).void
+        end
+        attr_writer :in_
+
+        sig do
+          params(
+            in_:
+              T::Array[Increase::FednowTransferListParams::Status::In::OrSymbol]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Return results whose value is in the provided list. For GET requests, this
+          # should be encoded as a comma-delimited string, such as `?in=one,two,three`.
+          in_: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              in_:
+                T::Array[
+                  Increase::FednowTransferListParams::Status::In::OrSymbol
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Increase::FednowTransferListParams::Status::In)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The transfer is pending review by Increase.
+          PENDING_REVIEWING =
+            T.let(
+              :pending_reviewing,
+              Increase::FednowTransferListParams::Status::In::TaggedSymbol
+            )
+
+          # The transfer has been canceled.
+          CANCELED =
+            T.let(
+              :canceled,
+              Increase::FednowTransferListParams::Status::In::TaggedSymbol
+            )
+
+          # The transfer has been rejected by Increase.
+          REVIEWING_REJECTED =
+            T.let(
+              :reviewing_rejected,
+              Increase::FednowTransferListParams::Status::In::TaggedSymbol
+            )
+
+          # The transfer requires attention from an Increase operator.
+          REQUIRES_ATTENTION =
+            T.let(
+              :requires_attention,
+              Increase::FednowTransferListParams::Status::In::TaggedSymbol
+            )
+
+          # The transfer is pending approval.
+          PENDING_APPROVAL =
+            T.let(
+              :pending_approval,
+              Increase::FednowTransferListParams::Status::In::TaggedSymbol
+            )
+
+          # The transfer is queued to be submitted to FedNow.
+          PENDING_SUBMITTING =
+            T.let(
+              :pending_submitting,
+              Increase::FednowTransferListParams::Status::In::TaggedSymbol
+            )
+
+          # The transfer has been submitted and is pending a response from FedNow.
+          PENDING_RESPONSE =
+            T.let(
+              :pending_response,
+              Increase::FednowTransferListParams::Status::In::TaggedSymbol
+            )
+
+          # The transfer has been sent successfully and is complete.
+          COMPLETE =
+            T.let(
+              :complete,
+              Increase::FednowTransferListParams::Status::In::TaggedSymbol
+            )
+
+          # The transfer was rejected by the network or the recipient's bank.
+          REJECTED =
+            T.let(
+              :rejected,
+              Increase::FednowTransferListParams::Status::In::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::FednowTransferListParams::Status::In::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models/fednow_transfer_retrieve_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Increase
+  module Models
+    class FednowTransferRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::FednowTransferRetrieveParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: Increase::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Increase::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end