modern_treasury 0.1.0.pre.alpha.15 → 0.1.0.pre.alpha.16

data/rbi/lib/modern_treasury/models/routing_number_lookup_request.rbi

@@ -3,69 +3,87 @@
 module ModernTreasury
   module Models
     class RoutingNumberLookupRequest < ModernTreasury::BaseModel
+      # The address of the bank.
       sig { returns(T.nilable(ModernTreasury::Models::RoutingNumberLookupRequest::BankAddress)) }
-      def bank_address
-      end
+      attr_reader :bank_address
 
       sig do
-        params(_: ModernTreasury::Models::RoutingNumberLookupRequest::BankAddress)
-          .returns(ModernTreasury::Models::RoutingNumberLookupRequest::BankAddress)
-      end
-      def bank_address=(_)
+        params(
+          bank_address: T.any(ModernTreasury::Models::RoutingNumberLookupRequest::BankAddress, ModernTreasury::Util::AnyHash)
+        )
+          .void
       end
+      attr_writer :bank_address
 
+      # The name of the bank.
       sig { returns(T.nilable(String)) }
-      def bank_name
-      end
+      attr_reader :bank_name
 
-      sig { params(_: String).returns(String) }
-      def bank_name=(_)
-      end
+      sig { params(bank_name: String).void }
+      attr_writer :bank_name
 
+      # The routing number of the bank.
       sig { returns(T.nilable(String)) }
-      def routing_number
-      end
+      attr_reader :routing_number
 
-      sig { params(_: String).returns(String) }
-      def routing_number=(_)
-      end
+      sig { params(routing_number: String).void }
+      attr_writer :routing_number
 
-      sig { returns(T.nilable(Symbol)) }
-      def routing_number_type
-      end
+      # The type of routing number. See
+      #   https://docs.moderntreasury.com/platform/reference/routing-detail-object for
+      #   more details. In sandbox mode we currently only support `aba` and `swift` with
+      #   routing numbers '123456789' and 'GRINUST0XXX' respectively.
+      sig { returns(T.nilable(ModernTreasury::Models::RoutingNumberLookupRequest::RoutingNumberType::TaggedSymbol)) }
+      attr_reader :routing_number_type
 
-      sig { params(_: Symbol).returns(Symbol) }
-      def routing_number_type=(_)
+      sig do
+        params(
+          routing_number_type: ModernTreasury::Models::RoutingNumberLookupRequest::RoutingNumberType::OrSymbol
+        )
+          .void
       end
+      attr_writer :routing_number_type
 
+      # An object containing key-value pairs, each with a sanctions list as the key and
+      #   a boolean value representing whether the bank is on that particular sanctions
+      #   list. Currently, this includes eu_con, uk_hmt, us_ofac, and un sanctions lists.
       sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-      def sanctions
-      end
+      attr_reader :sanctions
 
-      sig { params(_: T::Hash[Symbol, T.anything]).returns(T::Hash[Symbol, T.anything]) }
-      def sanctions=(_)
-      end
+      sig { params(sanctions: T::Hash[Symbol, T.anything]).void }
+      attr_writer :sanctions
 
-      sig { returns(T.nilable(T::Array[Symbol])) }
-      def supported_payment_types
+      # An array of payment types that are supported for this routing number. This can
+      #   include `ach`, `wire`, `rtp`, `sepa`, `bacs`, `au_becs`, and 'fednow' currently.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol]
+          )
+        )
       end
+      attr_reader :supported_payment_types
 
-      sig { params(_: T::Array[Symbol]).returns(T::Array[Symbol]) }
-      def supported_payment_types=(_)
+      sig do
+        params(
+          supported_payment_types: T::Array[ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::OrSymbol]
+        )
+          .void
       end
+      attr_writer :supported_payment_types
 
       sig do
         params(
-          bank_address: ModernTreasury::Models::RoutingNumberLookupRequest::BankAddress,
+          bank_address: T.any(ModernTreasury::Models::RoutingNumberLookupRequest::BankAddress, ModernTreasury::Util::AnyHash),
           bank_name: String,
           routing_number: String,
-          routing_number_type: Symbol,
+          routing_number_type: ModernTreasury::Models::RoutingNumberLookupRequest::RoutingNumberType::OrSymbol,
           sanctions: T::Hash[Symbol, T.anything],
-          supported_payment_types: T::Array[Symbol]
+          supported_payment_types: T::Array[ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::OrSymbol]
         )
-          .void
+          .returns(T.attached_class)
       end
-      def initialize(
+      def self.new(
         bank_address: nil,
         bank_name: nil,
         routing_number: nil,
@@ -82,9 +100,9 @@ module ModernTreasury
               bank_address: ModernTreasury::Models::RoutingNumberLookupRequest::BankAddress,
               bank_name: String,
               routing_number: String,
-              routing_number_type: Symbol,
+              routing_number_type: ModernTreasury::Models::RoutingNumberLookupRequest::RoutingNumberType::TaggedSymbol,
               sanctions: T::Hash[Symbol, T.anything],
-              supported_payment_types: T::Array[Symbol]
+              supported_payment_types: T::Array[ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol]
             }
           )
       end
@@ -92,54 +110,29 @@ module ModernTreasury
       end
 
       class BankAddress < ModernTreasury::BaseModel
+        # Country code conforms to [ISO 3166-1 alpha-2]
         sig { returns(T.nilable(String)) }
-        def country
-        end
-
-        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-        def country=(_)
-        end
+        attr_accessor :country
 
         sig { returns(T.nilable(String)) }
-        def line1
-        end
-
-        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-        def line1=(_)
-        end
+        attr_accessor :line1
 
         sig { returns(T.nilable(String)) }
-        def line2
-        end
-
-        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-        def line2=(_)
-        end
+        attr_accessor :line2
 
+        # Locality or City.
         sig { returns(T.nilable(String)) }
-        def locality
-        end
-
-        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-        def locality=(_)
-        end
+        attr_accessor :locality
 
+        # The postal code of the address.
         sig { returns(T.nilable(String)) }
-        def postal_code
-        end
-
-        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-        def postal_code=(_)
-        end
+        attr_accessor :postal_code
 
+        # Region or State.
         sig { returns(T.nilable(String)) }
-        def region
-        end
-
-        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-        def region=(_)
-        end
+        attr_accessor :region
 
+        # The address of the bank.
         sig do
           params(
             country: T.nilable(String),
@@ -149,9 +142,9 @@ module ModernTreasury
             postal_code: T.nilable(String),
             region: T.nilable(String)
           )
-            .void
+            .returns(T.attached_class)
         end
-        def initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil)
+        def self.new(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil)
         end
 
         sig do
@@ -171,58 +164,125 @@ module ModernTreasury
         end
       end
 
-      class RoutingNumberType < ModernTreasury::Enum
-        abstract!
-
-        ABA = :aba
-        AU_BSB = :au_bsb
-        CA_CPA = :ca_cpa
-        GB_SORT_CODE = :gb_sort_code
-        IN_IFSC = :in_ifsc
-        NZ_NATIONAL_CLEARING_CODE = :nz_national_clearing_code
-        SE_BANKGIRO_CLEARING_CODE = :se_bankgiro_clearing_code
-        SWIFT = :swift
+      # The type of routing number. See
+      #   https://docs.moderntreasury.com/platform/reference/routing-detail-object for
+      #   more details. In sandbox mode we currently only support `aba` and `swift` with
+      #   routing numbers '123456789' and 'GRINUST0XXX' respectively.
+      module RoutingNumberType
+        extend ModernTreasury::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, ModernTreasury::Models::RoutingNumberLookupRequest::RoutingNumberType) }
+        OrSymbol =
+          T.type_alias { T.any(Symbol, ModernTreasury::Models::RoutingNumberLookupRequest::RoutingNumberType::TaggedSymbol) }
+
+        ABA = T.let(:aba, ModernTreasury::Models::RoutingNumberLookupRequest::RoutingNumberType::TaggedSymbol)
+        AU_BSB =
+          T.let(:au_bsb, ModernTreasury::Models::RoutingNumberLookupRequest::RoutingNumberType::TaggedSymbol)
+        CA_CPA =
+          T.let(:ca_cpa, ModernTreasury::Models::RoutingNumberLookupRequest::RoutingNumberType::TaggedSymbol)
+        GB_SORT_CODE =
+          T.let(:gb_sort_code, ModernTreasury::Models::RoutingNumberLookupRequest::RoutingNumberType::TaggedSymbol)
+        IN_IFSC =
+          T.let(:in_ifsc, ModernTreasury::Models::RoutingNumberLookupRequest::RoutingNumberType::TaggedSymbol)
+        NZ_NATIONAL_CLEARING_CODE =
+          T.let(
+            :nz_national_clearing_code,
+            ModernTreasury::Models::RoutingNumberLookupRequest::RoutingNumberType::TaggedSymbol
+          )
+        SE_BANKGIRO_CLEARING_CODE =
+          T.let(
+            :se_bankgiro_clearing_code,
+            ModernTreasury::Models::RoutingNumberLookupRequest::RoutingNumberType::TaggedSymbol
+          )
+        SWIFT =
+          T.let(:swift, ModernTreasury::Models::RoutingNumberLookupRequest::RoutingNumberType::TaggedSymbol)
 
-        sig { override.returns(T::Array[Symbol]) }
+        sig do
+          override
+            .returns(T::Array[ModernTreasury::Models::RoutingNumberLookupRequest::RoutingNumberType::TaggedSymbol])
+        end
         def self.values
         end
       end
 
-      class SupportedPaymentType < ModernTreasury::Enum
-        abstract!
-
-        ACH = :ach
-        AU_BECS = :au_becs
-        BACS = :bacs
-        BOOK = :book
-        CARD = :card
-        CHATS = :chats
-        CHECK = :check
-        CROSS_BORDER = :cross_border
-        DK_NETS = :dk_nets
-        EFT = :eft
-        HU_ICS = :hu_ics
-        INTERAC = :interac
-        MASAV = :masav
-        MX_CCEN = :mx_ccen
-        NEFT = :neft
-        NICS = :nics
-        NZ_BECS = :nz_becs
-        PL_ELIXIR = :pl_elixir
-        PROVXCHANGE = :provxchange
-        RO_SENT = :ro_sent
-        RTP = :rtp
-        SE_BANKGIROT = :se_bankgirot
-        SEN = :sen
-        SEPA = :sepa
-        SG_GIRO = :sg_giro
-        SIC = :sic
-        SIGNET = :signet
-        SKNBI = :sknbi
-        WIRE = :wire
-        ZENGIN = :zengin
-
-        sig { override.returns(T::Array[Symbol]) }
+      module SupportedPaymentType
+        extend ModernTreasury::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType) }
+        OrSymbol =
+          T.type_alias { T.any(Symbol, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol) }
+
+        ACH = T.let(:ach, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        AU_BECS =
+          T.let(:au_becs, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        BACS =
+          T.let(:bacs, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        BOOK =
+          T.let(:book, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        CARD =
+          T.let(:card, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        CHATS =
+          T.let(:chats, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        CHECK =
+          T.let(:check, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        CROSS_BORDER =
+          T.let(
+            :cross_border,
+            ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol
+          )
+        DK_NETS =
+          T.let(:dk_nets, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        EFT = T.let(:eft, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        HU_ICS =
+          T.let(:hu_ics, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        INTERAC =
+          T.let(:interac, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        MASAV =
+          T.let(:masav, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        MX_CCEN =
+          T.let(:mx_ccen, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        NEFT =
+          T.let(:neft, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        NICS =
+          T.let(:nics, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        NZ_BECS =
+          T.let(:nz_becs, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        PL_ELIXIR =
+          T.let(:pl_elixir, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        PROVXCHANGE =
+          T.let(
+            :provxchange,
+            ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol
+          )
+        RO_SENT =
+          T.let(:ro_sent, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        RTP = T.let(:rtp, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        SE_BANKGIROT =
+          T.let(
+            :se_bankgirot,
+            ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol
+          )
+        SEN = T.let(:sen, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        SEPA =
+          T.let(:sepa, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        SG_GIRO =
+          T.let(:sg_giro, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        SIC = T.let(:sic, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        SIGNET =
+          T.let(:signet, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        SKNBI =
+          T.let(:sknbi, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        WIRE =
+          T.let(:wire, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+        ZENGIN =
+          T.let(:zengin, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol)
+
+        sig do
+          override
+            .returns(T::Array[ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType::TaggedSymbol])
+        end
         def self.values
         end
       end