modern_treasury 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.20

data/rbi/modern_treasury/models/external_account_verify_params.rbi

@@ -0,0 +1,387 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class ExternalAccountVerifyParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::ExternalAccountVerifyParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
+      # The ID of the internal account where the micro-deposits originate from. Both
+      # credit and debit capabilities must be enabled.
+      sig { returns(String) }
+      attr_accessor :originating_account_id
+
+      # Can be `ach`, `eft`, or `rtp`.
+      sig do
+        returns(
+          ModernTreasury::ExternalAccountVerifyParams::PaymentType::OrSymbol
+        )
+      end
+      attr_accessor :payment_type
+
+      # Defaults to the currency of the originating account.
+      sig { returns(T.nilable(ModernTreasury::Currency::OrSymbol)) }
+      attr_reader :currency
+
+      sig { params(currency: ModernTreasury::Currency::OrSymbol).void }
+      attr_writer :currency
+
+      # A payment type to fallback to if the original type is not valid for the
+      # receiving account. Currently, this only supports falling back from RTP to ACH
+      # (payment_type=rtp and fallback_type=ach)
+      sig do
+        returns(
+          T.nilable(
+            ModernTreasury::ExternalAccountVerifyParams::FallbackType::OrSymbol
+          )
+        )
+      end
+      attr_reader :fallback_type
+
+      sig do
+        params(
+          fallback_type:
+            ModernTreasury::ExternalAccountVerifyParams::FallbackType::OrSymbol
+        ).void
+      end
+      attr_writer :fallback_type
+
+      # Either `normal` or `high`. For ACH payments, `high` represents a same-day ACH
+      # transfer. This will apply to both `payment_type` and `fallback_type`.
+      sig do
+        returns(
+          T.nilable(
+            ModernTreasury::ExternalAccountVerifyParams::Priority::OrSymbol
+          )
+        )
+      end
+      attr_reader :priority
+
+      sig do
+        params(
+          priority:
+            ModernTreasury::ExternalAccountVerifyParams::Priority::OrSymbol
+        ).void
+      end
+      attr_writer :priority
+
+      sig do
+        params(
+          originating_account_id: String,
+          payment_type:
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::OrSymbol,
+          currency: ModernTreasury::Currency::OrSymbol,
+          fallback_type:
+            ModernTreasury::ExternalAccountVerifyParams::FallbackType::OrSymbol,
+          priority:
+            ModernTreasury::ExternalAccountVerifyParams::Priority::OrSymbol,
+          request_options: ModernTreasury::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the internal account where the micro-deposits originate from. Both
+        # credit and debit capabilities must be enabled.
+        originating_account_id:,
+        # Can be `ach`, `eft`, or `rtp`.
+        payment_type:,
+        # Defaults to the currency of the originating account.
+        currency: nil,
+        # A payment type to fallback to if the original type is not valid for the
+        # receiving account. Currently, this only supports falling back from RTP to ACH
+        # (payment_type=rtp and fallback_type=ach)
+        fallback_type: nil,
+        # Either `normal` or `high`. For ACH payments, `high` represents a same-day ACH
+        # transfer. This will apply to both `payment_type` and `fallback_type`.
+        priority: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            originating_account_id: String,
+            payment_type:
+              ModernTreasury::ExternalAccountVerifyParams::PaymentType::OrSymbol,
+            currency: ModernTreasury::Currency::OrSymbol,
+            fallback_type:
+              ModernTreasury::ExternalAccountVerifyParams::FallbackType::OrSymbol,
+            priority:
+              ModernTreasury::ExternalAccountVerifyParams::Priority::OrSymbol,
+            request_options: ModernTreasury::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Can be `ach`, `eft`, or `rtp`.
+      module PaymentType
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ModernTreasury::ExternalAccountVerifyParams::PaymentType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACH =
+          T.let(
+            :ach,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        AU_BECS =
+          T.let(
+            :au_becs,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        BACS =
+          T.let(
+            :bacs,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        BASE =
+          T.let(
+            :base,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        BOOK =
+          T.let(
+            :book,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        CARD =
+          T.let(
+            :card,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        CHATS =
+          T.let(
+            :chats,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        CHECK =
+          T.let(
+            :check,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        CROSS_BORDER =
+          T.let(
+            :cross_border,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        DK_NETS =
+          T.let(
+            :dk_nets,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        EFT =
+          T.let(
+            :eft,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        ETHEREUM =
+          T.let(
+            :ethereum,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        HU_ICS =
+          T.let(
+            :hu_ics,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        INTERAC =
+          T.let(
+            :interac,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        MASAV =
+          T.let(
+            :masav,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        MX_CCEN =
+          T.let(
+            :mx_ccen,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        NEFT =
+          T.let(
+            :neft,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        NICS =
+          T.let(
+            :nics,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        NZ_BECS =
+          T.let(
+            :nz_becs,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        PL_ELIXIR =
+          T.let(
+            :pl_elixir,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        POLYGON =
+          T.let(
+            :polygon,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        PROVXCHANGE =
+          T.let(
+            :provxchange,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        RO_SENT =
+          T.let(
+            :ro_sent,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        RTP =
+          T.let(
+            :rtp,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        SE_BANKGIROT =
+          T.let(
+            :se_bankgirot,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        SEN =
+          T.let(
+            :sen,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        SEPA =
+          T.let(
+            :sepa,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        SG_GIRO =
+          T.let(
+            :sg_giro,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        SIC =
+          T.let(
+            :sic,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        SIGNET =
+          T.let(
+            :signet,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        SKNBI =
+          T.let(
+            :sknbi,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        SOLANA =
+          T.let(
+            :solana,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        WIRE =
+          T.let(
+            :wire,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+        ZENGIN =
+          T.let(
+            :zengin,
+            ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::ExternalAccountVerifyParams::PaymentType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # A payment type to fallback to if the original type is not valid for the
+      # receiving account. Currently, this only supports falling back from RTP to ACH
+      # (payment_type=rtp and fallback_type=ach)
+      module FallbackType
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ModernTreasury::ExternalAccountVerifyParams::FallbackType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACH =
+          T.let(
+            :ach,
+            ModernTreasury::ExternalAccountVerifyParams::FallbackType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::ExternalAccountVerifyParams::FallbackType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Either `normal` or `high`. For ACH payments, `high` represents a same-day ACH
+      # transfer. This will apply to both `payment_type` and `fallback_type`.
+      module Priority
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ModernTreasury::ExternalAccountVerifyParams::Priority)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        HIGH =
+          T.let(
+            :high,
+            ModernTreasury::ExternalAccountVerifyParams::Priority::TaggedSymbol
+          )
+        NORMAL =
+          T.let(
+            :normal,
+            ModernTreasury::ExternalAccountVerifyParams::Priority::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::ExternalAccountVerifyParams::Priority::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/{lib/modern_treasury → modern_treasury}/models/external_account_verify_response.rbi

@@ -5,7 +5,23 @@ module ModernTreasury
     module ExternalAccountVerifyResponse
       extend ModernTreasury::Internal::Type::Union
 
+      Variants =
+        T.type_alias do
+          T.any(
+            ModernTreasury::ExternalAccount,
+            ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt
+          )
+        end
+
       class ExternalAccountVerificationAttempt < ModernTreasury::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt,
+              ModernTreasury::Internal::AnyHash
+            )
+          end
+
         sig { returns(String) }
         attr_accessor :id
 
@@ -67,47 +83,63 @@ module ModernTreasury
             live_mode: T::Boolean,
             object: String,
             originating_account_id: String,
-            payment_type: ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::OrSymbol,
-            priority: T.nilable(
-              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Priority::OrSymbol
-            ),
-            status: ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status::OrSymbol,
+            payment_type:
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::OrSymbol,
+            priority:
+              T.nilable(
+                ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Priority::OrSymbol
+              ),
+            status:
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status::OrSymbol,
             updated_at: Time
-          )
-            .returns(T.attached_class)
+          ).returns(T.attached_class)
         end
         def self.new(
           id:,
           created_at:,
+          # The ID of the external account.
           external_account_id:,
+          # This field will be true if this object exists in the live environment or false
+          # if it exists in the test environment.
           live_mode:,
           object:,
+          # The ID of the internal account where the micro-deposits originate from.
           originating_account_id:,
+          # The type of payment that can be made to this account. Can be `ach`, `eft`, or
+          # `rtp`.
           payment_type:,
+          # The priority of the payment. Can be `normal` or `high`.
           priority:,
+          # The status of the verification attempt. Can be `pending_verification`,
+          # `verified`, `failed`, or `cancelled`.
           status:,
           updated_at:
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns(
-              {
-                id: String,
-                created_at: Time,
-                external_account_id: String,
-                live_mode: T::Boolean,
-                object: String,
-                originating_account_id: String,
-                payment_type: ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol,
-                priority: T.nilable(
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              external_account_id: String,
+              live_mode: T::Boolean,
+              object: String,
+              originating_account_id: String,
+              payment_type:
+                ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol,
+              priority:
+                T.nilable(
                   ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Priority::TaggedSymbol
                 ),
-                status: ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status::TaggedSymbol,
-                updated_at: Time
-              }
-            )
+              status:
+                ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status::TaggedSymbol,
+              updated_at: Time
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
 
         # The type of payment that can be made to this account. Can be `ach`, `eft`, or
         # `rtp`.
@@ -116,16 +148,12 @@ module ModernTreasury
 
           TaggedSymbol =
             T.type_alias do
-              T.all(Symbol, ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType)
-            end
-          OrSymbol =
-            T.type_alias do
-              T.any(
+              T.all(
                 Symbol,
-                String,
-                ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+                ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType
               )
             end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           ACH =
             T.let(
@@ -142,6 +170,11 @@ module ModernTreasury
               :bacs,
               ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
             )
+          BASE =
+            T.let(
+              :base,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
           BOOK =
             T.let(
               :book,
@@ -177,6 +210,11 @@ module ModernTreasury
               :eft,
               ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
             )
+          ETHEREUM =
+            T.let(
+              :ethereum,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
           HU_ICS =
             T.let(
               :hu_ics,
@@ -217,6 +255,11 @@ module ModernTreasury
               :pl_elixir,
               ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
             )
+          POLYGON =
+            T.let(
+              :polygon,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
           PROVXCHANGE =
             T.let(
               :provxchange,
@@ -267,6 +310,11 @@ module ModernTreasury
               :sknbi,
               ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
             )
+          SOLANA =
+            T.let(
+              :solana,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
           WIRE =
             T.let(
               :wire,
@@ -279,14 +327,14 @@ module ModernTreasury
             )
 
           sig do
-            override
-              .returns(
-                T::Array[
-                  ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
-                ]
-              )
+            override.returns(
+              T::Array[
+                ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
           end
-          def self.values; end
         end
 
         # The priority of the payment. Can be `normal` or `high`.
@@ -295,16 +343,12 @@ module ModernTreasury
 
           TaggedSymbol =
             T.type_alias do
-              T.all(Symbol, ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Priority)
-            end
-          OrSymbol =
-            T.type_alias do
-              T.any(
+              T.all(
                 Symbol,
-                String,
-                ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Priority::TaggedSymbol
+                ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Priority
               )
             end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           HIGH =
             T.let(
@@ -318,14 +362,14 @@ module ModernTreasury
             )
 
           sig do
-            override
-              .returns(
-                T::Array[
-                  ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Priority::TaggedSymbol
-                ]
-              )
+            override.returns(
+              T::Array[
+                ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Priority::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
           end
-          def self.values; end
         end
 
         # The status of the verification attempt. Can be `pending_verification`,
@@ -335,16 +379,12 @@ module ModernTreasury
 
           TaggedSymbol =
             T.type_alias do
-              T.all(Symbol, ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status)
-            end
-          OrSymbol =
-            T.type_alias do
-              T.any(
+              T.all(
                 Symbol,
-                String,
-                ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status::TaggedSymbol
+                ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status
               )
             end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           CANCELLED =
             T.let(
@@ -368,24 +408,26 @@ module ModernTreasury
             )
 
           sig do
-            override
-              .returns(
-                T::Array[
-                  ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status::TaggedSymbol
-                ]
-              )
+            override.returns(
+              T::Array[
+                ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
           end
-          def self.values; end
         end
       end
 
       sig do
-        override
-          .returns(
-            [ModernTreasury::Models::ExternalAccount, ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt]
-          )
+        override.returns(
+          T::Array[
+            ModernTreasury::Models::ExternalAccountVerifyResponse::Variants
+          ]
+        )
+      end
+      def self.variants
       end
-      def self.variants; end
     end
   end
 end