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

data/rbi/lib/modern_treasury/models/return_retrieve_params.rbi

@@ -6,8 +6,11 @@ module ModernTreasury
       extend ModernTreasury::RequestParameters::Converter
       include ModernTreasury::RequestParameters
 
-      sig { params(request_options: T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything])).void }
-      def initialize(request_options: {})
+      sig do
+        params(request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+          .returns(T.attached_class)
+      end
+      def self.new(request_options: {})
       end
 
       sig { override.returns({request_options: ModernTreasury::RequestOptions}) }

data/rbi/lib/modern_treasury/models/routing_detail.rbi

@@ -4,113 +4,72 @@ module ModernTreasury
   module Models
     class RoutingDetail < ModernTreasury::BaseModel
       sig { returns(String) }
-      def id
-      end
-
-      sig { params(_: String).returns(String) }
-      def id=(_)
-      end
+      attr_accessor :id
 
       sig { returns(T.nilable(ModernTreasury::Models::RoutingDetail::BankAddress)) }
-      def bank_address
-      end
+      attr_reader :bank_address
 
       sig do
-        params(_: T.nilable(ModernTreasury::Models::RoutingDetail::BankAddress))
-          .returns(T.nilable(ModernTreasury::Models::RoutingDetail::BankAddress))
-      end
-      def bank_address=(_)
+        params(
+          bank_address: T.nilable(T.any(ModernTreasury::Models::RoutingDetail::BankAddress, ModernTreasury::Util::AnyHash))
+        )
+          .void
       end
+      attr_writer :bank_address
 
+      # The name of the bank.
       sig { returns(String) }
-      def bank_name
-      end
-
-      sig { params(_: String).returns(String) }
-      def bank_name=(_)
-      end
+      attr_accessor :bank_name
 
       sig { returns(Time) }
-      def created_at
-      end
-
-      sig { params(_: Time).returns(Time) }
-      def created_at=(_)
-      end
+      attr_accessor :created_at
 
       sig { returns(T.nilable(Time)) }
-      def discarded_at
-      end
-
-      sig { params(_: T.nilable(Time)).returns(T.nilable(Time)) }
-      def discarded_at=(_)
-      end
+      attr_accessor :discarded_at
 
+      # This field will be true if this object exists in the live environment or false
+      #   if it exists in the test environment.
       sig { returns(T::Boolean) }
-      def live_mode
-      end
-
-      sig { params(_: T::Boolean).returns(T::Boolean) }
-      def live_mode=(_)
-      end
+      attr_accessor :live_mode
 
       sig { returns(String) }
-      def object
-      end
+      attr_accessor :object
 
-      sig { params(_: String).returns(String) }
-      def object=(_)
-      end
-
-      sig { returns(T.nilable(Symbol)) }
-      def payment_type
-      end
-
-      sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
-      def payment_type=(_)
-      end
+      # If the routing detail is to be used for a specific payment type this field will
+      #   be populated, otherwise null.
+      sig { returns(T.nilable(ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)) }
+      attr_accessor :payment_type
 
+      # The routing number of the bank.
       sig { returns(String) }
-      def routing_number
-      end
+      attr_accessor :routing_number
 
-      sig { params(_: String).returns(String) }
-      def routing_number=(_)
-      end
-
-      sig { returns(Symbol) }
-      def routing_number_type
-      end
-
-      sig { params(_: Symbol).returns(Symbol) }
-      def routing_number_type=(_)
-      end
+      # The type of routing number. See
+      #   https://docs.moderntreasury.com/platform/reference/routing-detail-object for
+      #   more details.
+      sig { returns(ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol) }
+      attr_accessor :routing_number_type
 
       sig { returns(Time) }
-      def updated_at
-      end
-
-      sig { params(_: Time).returns(Time) }
-      def updated_at=(_)
-      end
+      attr_accessor :updated_at
 
       sig do
         params(
           id: String,
-          bank_address: T.nilable(ModernTreasury::Models::RoutingDetail::BankAddress),
+          bank_address: T.nilable(T.any(ModernTreasury::Models::RoutingDetail::BankAddress, ModernTreasury::Util::AnyHash)),
           bank_name: String,
           created_at: Time,
           discarded_at: T.nilable(Time),
           live_mode: T::Boolean,
           object: String,
-          payment_type: T.nilable(Symbol),
+          payment_type: T.nilable(ModernTreasury::Models::RoutingDetail::PaymentType::OrSymbol),
           routing_number: String,
-          routing_number_type: Symbol,
+          routing_number_type: ModernTreasury::Models::RoutingDetail::RoutingNumberType::OrSymbol,
           updated_at: Time
         )
-          .void
+          .returns(T.attached_class)
       end
-      def initialize(
+      def self.new(
         id:,
         bank_address:,
         bank_name:,
@@ -136,9 +95,9 @@ module ModernTreasury
               discarded_at: T.nilable(Time),
               live_mode: T::Boolean,
               object: String,
-              payment_type: T.nilable(Symbol),
+              payment_type: T.nilable(ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol),
               routing_number: String,
-              routing_number_type: Symbol,
+              routing_number_type: ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol,
               updated_at: Time
             }
           )
@@ -148,92 +107,43 @@ module ModernTreasury
 
       class BankAddress < ModernTreasury::BaseModel
         sig { returns(String) }
-        def id
-        end
-
-        sig { params(_: String).returns(String) }
-        def id=(_)
-        end
+        attr_accessor :id
 
+        # 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(Time) }
-        def created_at
-        end
-
-        sig { params(_: Time).returns(Time) }
-        def created_at=(_)
-        end
+        attr_accessor :created_at
 
         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
 
+        # This field will be true if this object exists in the live environment or false
+        #   if it exists in the test environment.
         sig { returns(T::Boolean) }
-        def live_mode
-        end
-
-        sig { params(_: T::Boolean).returns(T::Boolean) }
-        def live_mode=(_)
-        end
+        attr_accessor :live_mode
 
+        # 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
 
         sig { returns(String) }
-        def object
-        end
-
-        sig { params(_: String).returns(String) }
-        def object=(_)
-        end
+        attr_accessor :object
 
+        # 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
 
         sig { returns(Time) }
-        def updated_at
-        end
-
-        sig { params(_: Time).returns(Time) }
-        def updated_at=(_)
-        end
+        attr_accessor :updated_at
 
         sig do
           params(
@@ -249,9 +159,9 @@ module ModernTreasury
             region: T.nilable(String),
             updated_at: Time
           )
-            .void
+            .returns(T.attached_class)
         end
-        def initialize(
+        def self.new(
           id:,
           country:,
           created_at:,
@@ -288,71 +198,97 @@ module ModernTreasury
         end
       end
 
-      class PaymentType < ModernTreasury::Enum
-        abstract!
-
-        ACH = T.let(:ach, T.nilable(Symbol))
-        AU_BECS = T.let(:au_becs, T.nilable(Symbol))
-        BACS = T.let(:bacs, T.nilable(Symbol))
-        BOOK = T.let(:book, T.nilable(Symbol))
-        CARD = T.let(:card, T.nilable(Symbol))
-        CHATS = T.let(:chats, T.nilable(Symbol))
-        CHECK = T.let(:check, T.nilable(Symbol))
-        CROSS_BORDER = T.let(:cross_border, T.nilable(Symbol))
-        DK_NETS = T.let(:dk_nets, T.nilable(Symbol))
-        EFT = T.let(:eft, T.nilable(Symbol))
-        HU_ICS = T.let(:hu_ics, T.nilable(Symbol))
-        INTERAC = T.let(:interac, T.nilable(Symbol))
-        MASAV = T.let(:masav, T.nilable(Symbol))
-        MX_CCEN = T.let(:mx_ccen, T.nilable(Symbol))
-        NEFT = T.let(:neft, T.nilable(Symbol))
-        NICS = T.let(:nics, T.nilable(Symbol))
-        NZ_BECS = T.let(:nz_becs, T.nilable(Symbol))
-        PL_ELIXIR = T.let(:pl_elixir, T.nilable(Symbol))
-        PROVXCHANGE = T.let(:provxchange, T.nilable(Symbol))
-        RO_SENT = T.let(:ro_sent, T.nilable(Symbol))
-        RTP = T.let(:rtp, T.nilable(Symbol))
-        SE_BANKGIROT = T.let(:se_bankgirot, T.nilable(Symbol))
-        SEN = T.let(:sen, T.nilable(Symbol))
-        SEPA = T.let(:sepa, T.nilable(Symbol))
-        SG_GIRO = T.let(:sg_giro, T.nilable(Symbol))
-        SIC = T.let(:sic, T.nilable(Symbol))
-        SIGNET = T.let(:signet, T.nilable(Symbol))
-        SKNBI = T.let(:sknbi, T.nilable(Symbol))
-        WIRE = T.let(:wire, T.nilable(Symbol))
-        ZENGIN = T.let(:zengin, T.nilable(Symbol))
-
-        sig { override.returns(T::Array[Symbol]) }
+      # If the routing detail is to be used for a specific payment type this field will
+      #   be populated, otherwise null.
+      module PaymentType
+        extend ModernTreasury::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, ModernTreasury::Models::RoutingDetail::PaymentType) }
+        OrSymbol =
+          T.type_alias { T.any(Symbol, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol) }
+
+        ACH = T.let(:ach, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        AU_BECS = T.let(:au_becs, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        BACS = T.let(:bacs, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        BOOK = T.let(:book, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        CARD = T.let(:card, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        CHATS = T.let(:chats, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        CHECK = T.let(:check, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        CROSS_BORDER = T.let(:cross_border, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        DK_NETS = T.let(:dk_nets, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        EFT = T.let(:eft, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        HU_ICS = T.let(:hu_ics, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        INTERAC = T.let(:interac, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        MASAV = T.let(:masav, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        MX_CCEN = T.let(:mx_ccen, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        NEFT = T.let(:neft, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        NICS = T.let(:nics, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        NZ_BECS = T.let(:nz_becs, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        PL_ELIXIR = T.let(:pl_elixir, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        PROVXCHANGE = T.let(:provxchange, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        RO_SENT = T.let(:ro_sent, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        RTP = T.let(:rtp, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        SE_BANKGIROT = T.let(:se_bankgirot, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        SEN = T.let(:sen, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        SEPA = T.let(:sepa, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        SG_GIRO = T.let(:sg_giro, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        SIC = T.let(:sic, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        SIGNET = T.let(:signet, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        SKNBI = T.let(:sknbi, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        WIRE = T.let(:wire, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+        ZENGIN = T.let(:zengin, ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol)
+
+        sig { override.returns(T::Array[ModernTreasury::Models::RoutingDetail::PaymentType::TaggedSymbol]) }
         def self.values
         end
       end
 
-      class RoutingNumberType < ModernTreasury::Enum
-        abstract!
-
-        ABA = :aba
-        AU_BSB = :au_bsb
-        BR_CODIGO = :br_codigo
-        CA_CPA = :ca_cpa
-        CHIPS = :chips
-        CNAPS = :cnaps
-        DK_INTERBANK_CLEARING_CODE = :dk_interbank_clearing_code
-        GB_SORT_CODE = :gb_sort_code
-        HK_INTERBANK_CLEARING_CODE = :hk_interbank_clearing_code
-        HU_INTERBANK_CLEARING_CODE = :hu_interbank_clearing_code
-        ID_SKNBI_CODE = :id_sknbi_code
-        IN_IFSC = :in_ifsc
-        JP_ZENGIN_CODE = :jp_zengin_code
-        MX_BANK_IDENTIFIER = :mx_bank_identifier
-        MY_BRANCH_CODE = :my_branch_code
-        NZ_NATIONAL_CLEARING_CODE = :nz_national_clearing_code
-        PL_NATIONAL_CLEARING_CODE = :pl_national_clearing_code
-        SE_BANKGIRO_CLEARING_CODE = :se_bankgiro_clearing_code
-        SG_INTERBANK_CLEARING_CODE = :sg_interbank_clearing_code
-        SWIFT = :swift
-        ZA_NATIONAL_CLEARING_CODE = :za_national_clearing_code
-
-        sig { override.returns(T::Array[Symbol]) }
+      # The type of routing number. See
+      #   https://docs.moderntreasury.com/platform/reference/routing-detail-object for
+      #   more details.
+      module RoutingNumberType
+        extend ModernTreasury::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, ModernTreasury::Models::RoutingDetail::RoutingNumberType) }
+        OrSymbol =
+          T.type_alias { T.any(Symbol, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol) }
+
+        ABA = T.let(:aba, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol)
+        AU_BSB = T.let(:au_bsb, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol)
+        BR_CODIGO = T.let(:br_codigo, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol)
+        CA_CPA = T.let(:ca_cpa, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol)
+        CHIPS = T.let(:chips, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol)
+        CNAPS = T.let(:cnaps, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol)
+        DK_INTERBANK_CLEARING_CODE =
+          T.let(:dk_interbank_clearing_code, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol)
+        GB_SORT_CODE =
+          T.let(:gb_sort_code, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol)
+        HK_INTERBANK_CLEARING_CODE =
+          T.let(:hk_interbank_clearing_code, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol)
+        HU_INTERBANK_CLEARING_CODE =
+          T.let(:hu_interbank_clearing_code, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol)
+        ID_SKNBI_CODE =
+          T.let(:id_sknbi_code, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol)
+        IN_IFSC = T.let(:in_ifsc, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol)
+        JP_ZENGIN_CODE =
+          T.let(:jp_zengin_code, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol)
+        MX_BANK_IDENTIFIER =
+          T.let(:mx_bank_identifier, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol)
+        MY_BRANCH_CODE =
+          T.let(:my_branch_code, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol)
+        NZ_NATIONAL_CLEARING_CODE =
+          T.let(:nz_national_clearing_code, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol)
+        PL_NATIONAL_CLEARING_CODE =
+          T.let(:pl_national_clearing_code, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol)
+        SE_BANKGIRO_CLEARING_CODE =
+          T.let(:se_bankgiro_clearing_code, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol)
+        SG_INTERBANK_CLEARING_CODE =
+          T.let(:sg_interbank_clearing_code, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol)
+        SWIFT = T.let(:swift, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol)
+        ZA_NATIONAL_CLEARING_CODE =
+          T.let(:za_national_clearing_code, ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol)
+
+        sig { override.returns(T::Array[ModernTreasury::Models::RoutingDetail::RoutingNumberType::TaggedSymbol]) }
         def self.values
         end
       end