increase 1.353.0 → 1.355.0

data/rbi/increase/models/real_time_payments_requests_for_payment_cancel_params.rbi

@@ -0,0 +1,136 @@
+# typed: strong
+
+module Increase
+  module Models
+    class RealTimePaymentsRequestsForPaymentCancelParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::RealTimePaymentsRequestsForPaymentCancelParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The identifier of the Real-Time Payments Request for Payment to cancel.
+      sig { returns(String) }
+      attr_accessor :real_time_payments_request_for_payment_id
+
+      # Additional information about the cancellation to pass on to the recipient bank.
+      sig { returns(T.nilable(String)) }
+      attr_reader :additional_information
+
+      sig { params(additional_information: String).void }
+      attr_writer :additional_information
+
+      # The reason the request for payment is being canceled. Defaults to
+      # `requested_by_customer`.
+      sig do
+        returns(
+          T.nilable(
+            Increase::RealTimePaymentsRequestsForPaymentCancelParams::Reason::OrSymbol
+          )
+        )
+      end
+      attr_reader :reason
+
+      sig do
+        params(
+          reason:
+            Increase::RealTimePaymentsRequestsForPaymentCancelParams::Reason::OrSymbol
+        ).void
+      end
+      attr_writer :reason
+
+      sig do
+        params(
+          real_time_payments_request_for_payment_id: String,
+          additional_information: String,
+          reason:
+            Increase::RealTimePaymentsRequestsForPaymentCancelParams::Reason::OrSymbol,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The identifier of the Real-Time Payments Request for Payment to cancel.
+        real_time_payments_request_for_payment_id:,
+        # Additional information about the cancellation to pass on to the recipient bank.
+        additional_information: nil,
+        # The reason the request for payment is being canceled. Defaults to
+        # `requested_by_customer`.
+        reason: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            real_time_payments_request_for_payment_id: String,
+            additional_information: String,
+            reason:
+              Increase::RealTimePaymentsRequestsForPaymentCancelParams::Reason::OrSymbol,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The reason the request for payment is being canceled. Defaults to
+      # `requested_by_customer`.
+      module Reason
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Increase::RealTimePaymentsRequestsForPaymentCancelParams::Reason
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        # The creditor no longer wants to be paid. Corresponds to the Real-Time Payments reason code `CUST`.
+        REQUESTED_BY_CUSTOMER =
+          T.let(
+            :requested_by_customer,
+            Increase::RealTimePaymentsRequestsForPaymentCancelParams::Reason::TaggedSymbol
+          )
+
+        # The requested payment has already been made through another channel. Corresponds to the Real-Time Payments reason code `UPAY`.
+        PAID_BY_OTHER_MEANS =
+          T.let(
+            :paid_by_other_means,
+            Increase::RealTimePaymentsRequestsForPaymentCancelParams::Reason::TaggedSymbol
+          )
+
+        # The request for payment duplicated another request for payment. Corresponds to the Real-Time Payments reason code `DUPL`.
+        DUPLICATE =
+          T.let(
+            :duplicate,
+            Increase::RealTimePaymentsRequestsForPaymentCancelParams::Reason::TaggedSymbol
+          )
+
+        # The request for payment was sent for the wrong amount. Corresponds to the Real-Time Payments reason code `AM09`.
+        WRONG_AMOUNT =
+          T.let(
+            :wrong_amount,
+            Increase::RealTimePaymentsRequestsForPaymentCancelParams::Reason::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Increase::RealTimePaymentsRequestsForPaymentCancelParams::Reason::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models/real_time_payments_requests_for_payment_create_params.rbi

@@ -0,0 +1,303 @@
+# typed: strong
+
+module Increase
+  module Models
+    class RealTimePaymentsRequestsForPaymentCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::RealTimePaymentsRequestsForPaymentCreateParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The identifier of the Account Number where the funds will land.
+      sig { returns(String) }
+      attr_accessor :account_number_id
+
+      # The requested amount in USD cents. Must be positive.
+      sig { returns(Integer) }
+      attr_accessor :amount
+
+      # Details of the person being requested to pay.
+      sig do
+        returns(
+          Increase::RealTimePaymentsRequestsForPaymentCreateParams::Debtor
+        )
+      end
+      attr_reader :debtor
+
+      sig do
+        params(
+          debtor:
+            Increase::RealTimePaymentsRequestsForPaymentCreateParams::Debtor::OrHash
+        ).void
+      end
+      attr_writer :debtor
+
+      # The debtor's account number, which the funds will be requested from.
+      sig { returns(String) }
+      attr_accessor :debtor_account_number
+
+      # The debtor's American Bankers' Association (ABA) Routing Transit Number (RTN).
+      sig { returns(String) }
+      attr_accessor :debtor_routing_number
+
+      # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time after which
+      # the request for payment is no longer valid. After this time the debtor's bank
+      # should no longer allow the debtor to pay it. Must not be before
+      # `requested_execution_at`.
+      sig { returns(Time) }
+      attr_accessor :expires_at
+
+      # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time by which
+      # you are requesting the payment to be made.
+      sig { returns(Time) }
+      attr_accessor :requested_execution_at
+
+      # Unstructured information that will show on the recipient's bank statement.
+      sig { returns(String) }
+      attr_accessor :unstructured_remittance_information
+
+      # The name of the creditor requesting the payment. If not provided, defaults to
+      # the name of the account's entity.
+      sig { returns(T.nilable(String)) }
+      attr_reader :creditor_name
+
+      sig { params(creditor_name: String).void }
+      attr_writer :creditor_name
+
+      sig do
+        params(
+          account_number_id: String,
+          amount: Integer,
+          debtor:
+            Increase::RealTimePaymentsRequestsForPaymentCreateParams::Debtor::OrHash,
+          debtor_account_number: String,
+          debtor_routing_number: String,
+          expires_at: Time,
+          requested_execution_at: Time,
+          unstructured_remittance_information: String,
+          creditor_name: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The identifier of the Account Number where the funds will land.
+        account_number_id:,
+        # The requested amount in USD cents. Must be positive.
+        amount:,
+        # Details of the person being requested to pay.
+        debtor:,
+        # The debtor's account number, which the funds will be requested from.
+        debtor_account_number:,
+        # The debtor's American Bankers' Association (ABA) Routing Transit Number (RTN).
+        debtor_routing_number:,
+        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time after which
+        # the request for payment is no longer valid. After this time the debtor's bank
+        # should no longer allow the debtor to pay it. Must not be before
+        # `requested_execution_at`.
+        expires_at:,
+        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time by which
+        # you are requesting the payment to be made.
+        requested_execution_at:,
+        # Unstructured information that will show on the recipient's bank statement.
+        unstructured_remittance_information:,
+        # The name of the creditor requesting the payment. If not provided, defaults to
+        # the name of the account's entity.
+        creditor_name: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_number_id: String,
+            amount: Integer,
+            debtor:
+              Increase::RealTimePaymentsRequestsForPaymentCreateParams::Debtor,
+            debtor_account_number: String,
+            debtor_routing_number: String,
+            expires_at: Time,
+            requested_execution_at: Time,
+            unstructured_remittance_information: String,
+            creditor_name: String,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Debtor < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::RealTimePaymentsRequestsForPaymentCreateParams::Debtor,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # Address of the debtor.
+        sig do
+          returns(
+            Increase::RealTimePaymentsRequestsForPaymentCreateParams::Debtor::Address
+          )
+        end
+        attr_reader :address
+
+        sig do
+          params(
+            address:
+              Increase::RealTimePaymentsRequestsForPaymentCreateParams::Debtor::Address::OrHash
+          ).void
+        end
+        attr_writer :address
+
+        # The name of the debtor.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # Details of the person being requested to pay.
+        sig do
+          params(
+            address:
+              Increase::RealTimePaymentsRequestsForPaymentCreateParams::Debtor::Address::OrHash,
+            name: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Address of the debtor.
+          address:,
+          # The name of the debtor.
+          name:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              address:
+                Increase::RealTimePaymentsRequestsForPaymentCreateParams::Debtor::Address,
+              name: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Address < Increase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Increase::RealTimePaymentsRequestsForPaymentCreateParams::Debtor::Address,
+                Increase::Internal::AnyHash
+              )
+            end
+
+          # The ISO 3166, Alpha-2 country code.
+          #
+          # Defaults to `US`.
+          sig { returns(String) }
+          attr_accessor :country
+
+          # 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_reader :address_line2
+
+          sig { params(address_line2: String).void }
+          attr_writer :address_line2
+
+          # The number identifying the position of the building on the street.
+          sig { returns(T.nilable(String)) }
+          attr_reader :building_number
+
+          sig { params(building_number: String).void }
+          attr_writer :building_number
+
+          # The town or city.
+          sig { returns(T.nilable(String)) }
+          attr_reader :city
+
+          sig { params(city: String).void }
+          attr_writer :city
+
+          # The postal code or zip.
+          sig { returns(T.nilable(String)) }
+          attr_reader :postal_code
+
+          sig { params(postal_code: String).void }
+          attr_writer :postal_code
+
+          # The US state component of the address.
+          sig { returns(T.nilable(String)) }
+          attr_reader :state
+
+          sig { params(state: String).void }
+          attr_writer :state
+
+          # The street name without the street number.
+          sig { returns(T.nilable(String)) }
+          attr_reader :street_name
+
+          sig { params(street_name: String).void }
+          attr_writer :street_name
+
+          # Address of the debtor.
+          sig do
+            params(
+              country: String,
+              address_line2: String,
+              building_number: String,
+              city: String,
+              postal_code: String,
+              state: String,
+              street_name: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The ISO 3166, Alpha-2 country code.
+            #
+            # Defaults to `US`.
+            country:,
+            # 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: nil,
+            # The number identifying the position of the building on the street.
+            building_number: nil,
+            # The town or city.
+            city: nil,
+            # The postal code or zip.
+            postal_code: nil,
+            # The US state component of the address.
+            state: nil,
+            # The street name without the street number.
+            street_name: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                country: String,
+                address_line2: String,
+                building_number: String,
+                city: String,
+                postal_code: String,
+                state: String,
+                street_name: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models/real_time_payments_requests_for_payment_list_params.rbi

@@ -0,0 +1,192 @@
+# typed: strong
+
+module Increase
+  module Models
+    class RealTimePaymentsRequestsForPaymentListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::RealTimePaymentsRequestsForPaymentListParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # Filter Real-Time Payments Requests for Payment to those destined to the
+      # specified Account.
+      sig { returns(T.nilable(String)) }
+      attr_reader :account_id
+
+      sig { params(account_id: String).void }
+      attr_writer :account_id
+
+      sig do
+        returns(
+          T.nilable(
+            Increase::RealTimePaymentsRequestsForPaymentListParams::CreatedAt
+          )
+        )
+      end
+      attr_reader :created_at
+
+      sig do
+        params(
+          created_at:
+            Increase::RealTimePaymentsRequestsForPaymentListParams::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 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.
+      #
+      # 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,
+          created_at:
+            Increase::RealTimePaymentsRequestsForPaymentListParams::CreatedAt::OrHash,
+          cursor: String,
+          idempotency_key: String,
+          limit: Integer,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Filter Real-Time Payments Requests for Payment to those destined to the
+        # specified Account.
+        account_id: nil,
+        created_at: nil,
+        # Return the page of entries after this one.
+        cursor: 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.
+        #
+        # Defaults to `100`.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            created_at:
+              Increase::RealTimePaymentsRequestsForPaymentListParams::CreatedAt,
+            cursor: String,
+            idempotency_key: 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::RealTimePaymentsRequestsForPaymentListParams::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/real_time_payments_requests_for_payment_retrieve_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Increase
+  module Models
+    class RealTimePaymentsRequestsForPaymentRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::RealTimePaymentsRequestsForPaymentRetrieveParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The identifier of the Real-Time Payments Request for Payment.
+      sig { returns(String) }
+      attr_accessor :real_time_payments_request_for_payment_id
+
+      sig do
+        params(
+          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 Real-Time Payments Request for Payment.
+        real_time_payments_request_for_payment_id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            real_time_payments_request_for_payment_id: String,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/simulations/digital_wallet_token_request_create_response.rbi

@@ -134,6 +134,27 @@ module Increase
               Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::DeclineReason::TaggedSymbol
             )
 
+          # The group was locked.
+          GROUP_LOCKED =
+            T.let(
+              :group_locked,
+              Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::DeclineReason::TaggedSymbol
+            )
+
+          # The account has been closed.
+          ACCOUNT_CLOSED =
+            T.let(
+              :account_closed,
+              Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::DeclineReason::TaggedSymbol
+            )
+
+          # The account's entity was not active.
+          ENTITY_NOT_ACTIVE =
+            T.let(
+              :entity_not_active,
+              Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::DeclineReason::TaggedSymbol
+            )
+
           sig do
             override.returns(
               T::Array[