increase 1.354.0 → 1.355.0

data/rbi/increase/models/inbound_real_time_payments_request_for_payment.rbi

@@ -0,0 +1,442 @@
+# typed: strong
+
+module Increase
+  module Models
+    class InboundRealTimePaymentsRequestForPayment < Increase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::InboundRealTimePaymentsRequestForPayment,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The inbound Real-Time Payments request for payment's identifier.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The Account the request for payment is for.
+      sig { returns(String) }
+      attr_accessor :account_id
+
+      # The identifier of the Account Number the request for payment is for.
+      sig { returns(String) }
+      attr_accessor :account_number_id
+
+      # The requested amount in USD cents.
+      sig { returns(Integer) }
+      attr_accessor :amount
+
+      # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      # the request for payment was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # Details of the party requesting payment.
+      sig do
+        returns(Increase::InboundRealTimePaymentsRequestForPayment::Creditor)
+      end
+      attr_reader :creditor
+
+      sig do
+        params(
+          creditor:
+            Increase::InboundRealTimePaymentsRequestForPayment::Creditor::OrHash
+        ).void
+      end
+      attr_writer :creditor
+
+      # The creditor's account number.
+      sig { returns(String) }
+      attr_accessor :creditor_account_number
+
+      # The creditor's American Bankers' Association (ABA) Routing Transit Number (RTN).
+      sig { returns(String) }
+      attr_accessor :creditor_routing_number
+
+      # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the requested
+      # currency. This will always be "USD" for a Real-Time Payments request for
+      # payment.
+      sig do
+        returns(
+          Increase::InboundRealTimePaymentsRequestForPayment::Currency::TaggedSymbol
+        )
+      end
+      attr_accessor :currency
+
+      # The name of the account holder the payment is requested from, as provided by the
+      # creditor.
+      sig { returns(String) }
+      attr_accessor :debtor_name
+
+      # A free-form reference string set by the creditor, to help identify the request
+      # for payment.
+      sig { returns(String) }
+      attr_accessor :end_to_end_identification
+
+      # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time after which
+      # the request for payment is no longer valid and should no longer be paid.
+      sig { returns(Time) }
+      attr_accessor :expires_at
+
+      # The identifier of the Real-Time Payments Transfer that fulfilled this request
+      # for payment. This is set once a transfer sent in response to the request for
+      # payment has been acknowledged by the Real-Time Payments network.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :fulfillment_real_time_payments_transfer_id
+
+      # An identifier for the party that issued the invoice, for requests for payment
+      # sent on behalf of another party.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :invoicer_identification
+
+      # The Real-Time Payments network identification of the request for payment.
+      sig { returns(String) }
+      attr_accessor :payment_information_identification
+
+      # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time by which
+      # the creditor requests the payment to be made.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :requested_execution_at
+
+      # A constant representing the object's type. For this resource it will always be
+      # `inbound_real_time_payments_request_for_payment`.
+      sig do
+        returns(
+          Increase::InboundRealTimePaymentsRequestForPayment::Type::TaggedSymbol
+        )
+      end
+      attr_accessor :type
+
+      # Unstructured information included with the request for payment.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :unstructured_remittance_information
+
+      # An Inbound Real-Time Payments Request for Payment is a request initiated outside
+      # of Increase for one of your accounts to send a Real-Time Payments transfer.
+      sig do
+        params(
+          id: String,
+          account_id: String,
+          account_number_id: String,
+          amount: Integer,
+          created_at: Time,
+          creditor:
+            Increase::InboundRealTimePaymentsRequestForPayment::Creditor::OrHash,
+          creditor_account_number: String,
+          creditor_routing_number: String,
+          currency:
+            Increase::InboundRealTimePaymentsRequestForPayment::Currency::OrSymbol,
+          debtor_name: String,
+          end_to_end_identification: String,
+          expires_at: Time,
+          fulfillment_real_time_payments_transfer_id: T.nilable(String),
+          invoicer_identification: T.nilable(String),
+          payment_information_identification: String,
+          requested_execution_at: T.nilable(Time),
+          type:
+            Increase::InboundRealTimePaymentsRequestForPayment::Type::OrSymbol,
+          unstructured_remittance_information: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The inbound Real-Time Payments request for payment's identifier.
+        id:,
+        # The Account the request for payment is for.
+        account_id:,
+        # The identifier of the Account Number the request for payment is for.
+        account_number_id:,
+        # The requested amount in USD cents.
+        amount:,
+        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+        # the request for payment was created.
+        created_at:,
+        # Details of the party requesting payment.
+        creditor:,
+        # The creditor's account number.
+        creditor_account_number:,
+        # The creditor's American Bankers' Association (ABA) Routing Transit Number (RTN).
+        creditor_routing_number:,
+        # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the requested
+        # currency. This will always be "USD" for a Real-Time Payments request for
+        # payment.
+        currency:,
+        # The name of the account holder the payment is requested from, as provided by the
+        # creditor.
+        debtor_name:,
+        # A free-form reference string set by the creditor, to help identify the request
+        # for payment.
+        end_to_end_identification:,
+        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time after which
+        # the request for payment is no longer valid and should no longer be paid.
+        expires_at:,
+        # The identifier of the Real-Time Payments Transfer that fulfilled this request
+        # for payment. This is set once a transfer sent in response to the request for
+        # payment has been acknowledged by the Real-Time Payments network.
+        fulfillment_real_time_payments_transfer_id:,
+        # An identifier for the party that issued the invoice, for requests for payment
+        # sent on behalf of another party.
+        invoicer_identification:,
+        # The Real-Time Payments network identification of the request for payment.
+        payment_information_identification:,
+        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time by which
+        # the creditor requests the payment to be made.
+        requested_execution_at:,
+        # A constant representing the object's type. For this resource it will always be
+        # `inbound_real_time_payments_request_for_payment`.
+        type:,
+        # Unstructured information included with the request for payment.
+        unstructured_remittance_information:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            account_id: String,
+            account_number_id: String,
+            amount: Integer,
+            created_at: Time,
+            creditor:
+              Increase::InboundRealTimePaymentsRequestForPayment::Creditor,
+            creditor_account_number: String,
+            creditor_routing_number: String,
+            currency:
+              Increase::InboundRealTimePaymentsRequestForPayment::Currency::TaggedSymbol,
+            debtor_name: String,
+            end_to_end_identification: String,
+            expires_at: Time,
+            fulfillment_real_time_payments_transfer_id: T.nilable(String),
+            invoicer_identification: T.nilable(String),
+            payment_information_identification: String,
+            requested_execution_at: T.nilable(Time),
+            type:
+              Increase::InboundRealTimePaymentsRequestForPayment::Type::TaggedSymbol,
+            unstructured_remittance_information: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Creditor < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::InboundRealTimePaymentsRequestForPayment::Creditor,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The name of the account that would receive the payment, as provided by the
+        # creditor.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :account_name
+
+        # Address of the creditor.
+        sig do
+          returns(
+            Increase::InboundRealTimePaymentsRequestForPayment::Creditor::Address
+          )
+        end
+        attr_reader :address
+
+        sig do
+          params(
+            address:
+              Increase::InboundRealTimePaymentsRequestForPayment::Creditor::Address::OrHash
+          ).void
+        end
+        attr_writer :address
+
+        # The name of the creditor.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # Details of the party requesting payment.
+        sig do
+          params(
+            account_name: T.nilable(String),
+            address:
+              Increase::InboundRealTimePaymentsRequestForPayment::Creditor::Address::OrHash,
+            name: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The name of the account that would receive the payment, as provided by the
+          # creditor.
+          account_name:,
+          # Address of the creditor.
+          address:,
+          # The name of the creditor.
+          name:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              account_name: T.nilable(String),
+              address:
+                Increase::InboundRealTimePaymentsRequestForPayment::Creditor::Address,
+              name: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Address < Increase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Increase::InboundRealTimePaymentsRequestForPayment::Creditor::Address,
+                Increase::Internal::AnyHash
+              )
+            end
+
+          # A second address line, such as an apartment or suite number. The first address
+          # line is separated into `building_number` and `street_name`.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :address_line2
+
+          # The number identifying the position of the building on the street.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :building_number
+
+          # The town or city.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :city
+
+          # The ISO 3166, Alpha-2 country code.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :country
+
+          # The postal code or zip.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :postal_code
+
+          # The US state component of the address.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :state
+
+          # The street name without the street number.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :street_name
+
+          # Address of the creditor.
+          sig do
+            params(
+              address_line2: T.nilable(String),
+              building_number: T.nilable(String),
+              city: T.nilable(String),
+              country: T.nilable(String),
+              postal_code: T.nilable(String),
+              state: T.nilable(String),
+              street_name: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # A second address line, such as an apartment or suite number. The first address
+            # line is separated into `building_number` and `street_name`.
+            address_line2:,
+            # The number identifying the position of the building on the street.
+            building_number:,
+            # The town or city.
+            city:,
+            # The ISO 3166, Alpha-2 country code.
+            country:,
+            # The postal code or zip.
+            postal_code:,
+            # The US state component of the address.
+            state:,
+            # The street name without the street number.
+            street_name:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                address_line2: T.nilable(String),
+                building_number: T.nilable(String),
+                city: T.nilable(String),
+                country: T.nilable(String),
+                postal_code: T.nilable(String),
+                state: T.nilable(String),
+                street_name: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+
+      # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the requested
+      # currency. This will always be "USD" for a Real-Time Payments request for
+      # payment.
+      module Currency
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Increase::InboundRealTimePaymentsRequestForPayment::Currency
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        # US Dollar (USD)
+        USD =
+          T.let(
+            :USD,
+            Increase::InboundRealTimePaymentsRequestForPayment::Currency::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Increase::InboundRealTimePaymentsRequestForPayment::Currency::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `inbound_real_time_payments_request_for_payment`.
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Increase::InboundRealTimePaymentsRequestForPayment::Type
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT =
+          T.let(
+            :inbound_real_time_payments_request_for_payment,
+            Increase::InboundRealTimePaymentsRequestForPayment::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Increase::InboundRealTimePaymentsRequestForPayment::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models/inbound_real_time_payments_requests_for_payment_list_params.rbi

@@ -0,0 +1,188 @@
+# typed: strong
+
+module Increase
+  module Models
+    class InboundRealTimePaymentsRequestsForPaymentListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::InboundRealTimePaymentsRequestsForPaymentListParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # Filter Inbound Real-Time Payments Requests for Payment to those belonging to the
+      # specified Account.
+      sig { returns(T.nilable(String)) }
+      attr_reader :account_id
+
+      sig { params(account_id: String).void }
+      attr_writer :account_id
+
+      # Filter Inbound Real-Time Payments Requests for Payment to ones belonging to the
+      # specified Account Number.
+      sig { returns(T.nilable(String)) }
+      attr_reader :account_number_id
+
+      sig { params(account_number_id: String).void }
+      attr_writer :account_number_id
+
+      sig do
+        returns(
+          T.nilable(
+            Increase::InboundRealTimePaymentsRequestsForPaymentListParams::CreatedAt
+          )
+        )
+      end
+      attr_reader :created_at
+
+      sig do
+        params(
+          created_at:
+            Increase::InboundRealTimePaymentsRequestsForPaymentListParams::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
+
+      # Limit the size of the list that is returned. The default (and maximum) is 100
+      # objects.
+      #
+      # Defaults to `100`.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig do
+        params(
+          account_id: String,
+          account_number_id: String,
+          created_at:
+            Increase::InboundRealTimePaymentsRequestsForPaymentListParams::CreatedAt::OrHash,
+          cursor: String,
+          limit: Integer,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Filter Inbound Real-Time Payments Requests for Payment to those belonging to the
+        # specified Account.
+        account_id: nil,
+        # Filter Inbound Real-Time Payments Requests for Payment 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.
+        #
+        # Defaults to `100`.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            account_number_id: String,
+            created_at:
+              Increase::InboundRealTimePaymentsRequestsForPaymentListParams::CreatedAt,
+            cursor: String,
+            limit: Integer,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class CreatedAt < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::InboundRealTimePaymentsRequestsForPaymentListParams::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
+    end
+  end
+end

data/rbi/increase/models/inbound_real_time_payments_requests_for_payment_retrieve_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Increase
+  module Models
+    class InboundRealTimePaymentsRequestsForPaymentRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::InboundRealTimePaymentsRequestsForPaymentRetrieveParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The identifier of the Inbound Real-Time Payments Request for Payment to get
+      # details for.
+      sig { returns(String) }
+      attr_accessor :inbound_real_time_payments_request_for_payment_id
+
+      sig do
+        params(
+          inbound_real_time_payments_request_for_payment_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The identifier of the Inbound Real-Time Payments Request for Payment to get
+        # details for.
+        inbound_real_time_payments_request_for_payment_id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            inbound_real_time_payments_request_for_payment_id: String,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end