modern_treasury 0.1.0.pre.alpha.15 → 0.1.0.pre.alpha.17

data/rbi/lib/modern_treasury/models/internal_accounts/balance_report.rbi

@@ -3,106 +3,61 @@
 module ModernTreasury
   module Models
     module InternalAccounts
-      class BalanceReport < ModernTreasury::BaseModel
+      class BalanceReport < ModernTreasury::Internal::Type::BaseModel
         sig { returns(String) }
-        def id
-        end
-
-        sig { params(_: String).returns(String) }
-        def id=(_)
-        end
+        attr_accessor :id
 
+        # The date of the balance report in local time.
         sig { returns(Date) }
-        def as_of_date
-        end
-
-        sig { params(_: Date).returns(Date) }
-        def as_of_date=(_)
-        end
+        attr_accessor :as_of_date
 
-        sig { returns(T.nilable(String)) }
-        def as_of_time
-        end
-
-        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-        def as_of_time=(_)
-        end
+        # The time (24-hour clock) of the balance report in local time.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :as_of_time
 
-        sig { returns(Symbol) }
-        def balance_report_type
-        end
-
-        sig { params(_: Symbol).returns(Symbol) }
-        def balance_report_type=(_)
-        end
+        # The specific type of balance report. One of `intraday`, `previous_day`,
+        # `real_time`, or `other`.
+        sig { returns(ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol) }
+        attr_accessor :balance_report_type
 
+        # An array of `Balance` objects.
         sig { returns(T::Array[ModernTreasury::Models::InternalAccounts::BalanceReport::Balance]) }
-        def balances
-        end
-
-        sig do
-          params(_: T::Array[ModernTreasury::Models::InternalAccounts::BalanceReport::Balance])
-            .returns(T::Array[ModernTreasury::Models::InternalAccounts::BalanceReport::Balance])
-        end
-        def balances=(_)
-        end
+        attr_accessor :balances
 
         sig { returns(Time) }
-        def created_at
-        end
-
-        sig { params(_: Time).returns(Time) }
-        def created_at=(_)
-        end
+        attr_accessor :created_at
 
+        # The ID of one of your organization's Internal Accounts.
         sig { returns(String) }
-        def internal_account_id
-        end
-
-        sig { params(_: String).returns(String) }
-        def internal_account_id=(_)
-        end
+        attr_accessor :internal_account_id
 
+        # 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
-
-        sig { params(_: String).returns(String) }
-        def object=(_)
-        end
+        attr_accessor :object
 
         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,
             as_of_date: Date,
-            as_of_time: T.nilable(String),
-            balance_report_type: Symbol,
-            balances: T::Array[ModernTreasury::Models::InternalAccounts::BalanceReport::Balance],
+            as_of_time: T.nilable(Time),
+            balance_report_type: ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType::OrSymbol,
+            balances: T::Array[T.any(ModernTreasury::Models::InternalAccounts::BalanceReport::Balance, ModernTreasury::Internal::AnyHash)],
             created_at: Time,
             internal_account_id: String,
             live_mode: T::Boolean,
             object: String,
             updated_at: Time
           )
-            .void
+            .returns(T.attached_class)
         end
-        def initialize(
+        def self.new(
           id:,
           as_of_date:,
           as_of_time:,
@@ -113,17 +68,15 @@ module ModernTreasury
           live_mode:,
           object:,
           updated_at:
-        )
-        end
-
+        ); end
         sig do
           override
             .returns(
               {
                 id: String,
                 as_of_date: Date,
-                as_of_time: T.nilable(String),
-                balance_report_type: Symbol,
+                as_of_time: T.nilable(Time),
+                balance_report_type: ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol,
                 balances: T::Array[ModernTreasury::Models::InternalAccounts::BalanceReport::Balance],
                 created_at: Time,
                 internal_account_id: String,
@@ -133,136 +86,113 @@ module ModernTreasury
               }
             )
         end
-        def to_hash
-        end
-
-        class BalanceReportType < ModernTreasury::Enum
-          abstract!
+        def to_hash; end
+
+        # The specific type of balance report. One of `intraday`, `previous_day`,
+        # `real_time`, or `other`.
+        module BalanceReportType
+          extend ModernTreasury::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType) }
+          OrSymbol =
+            T.type_alias do
+              T.any(
+                Symbol,
+                String,
+                ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol
+              )
+            end
 
-          INTRADAY = :intraday
-          OTHER = :other
-          PREVIOUS_DAY = :previous_day
-          REAL_TIME = :real_time
+          INTRADAY =
+            T.let(:intraday, ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol)
+          OTHER =
+            T.let(:other, ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol)
+          PREVIOUS_DAY =
+            T.let(
+              :previous_day,
+              ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol
+            )
+          REAL_TIME =
+            T.let(
+              :real_time,
+              ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol
+            )
 
-          sig { override.returns(T::Array[Symbol]) }
-          def self.values
+          sig do
+            override
+              .returns(
+                T::Array[ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol]
+              )
           end
+          def self.values; end
         end
 
-        class Balance < ModernTreasury::BaseModel
+        class Balance < ModernTreasury::Internal::Type::BaseModel
           sig { returns(String) }
-          def id
-          end
-
-          sig { params(_: String).returns(String) }
-          def id=(_)
-          end
+          attr_accessor :id
 
+          # The balance amount.
           sig { returns(Integer) }
-          def amount
-          end
-
-          sig { params(_: Integer).returns(Integer) }
-          def amount=(_)
-          end
+          attr_accessor :amount
 
+          # The date on which the balance became true for the account.
           sig { returns(T.nilable(Date)) }
-          def as_of_date
-          end
-
-          sig { params(_: T.nilable(Date)).returns(T.nilable(Date)) }
-          def as_of_date=(_)
-          end
-
-          sig { returns(T.nilable(String)) }
-          def as_of_time
-          end
-
-          sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-          def as_of_time=(_)
-          end
+          attr_accessor :as_of_date
 
-          sig { returns(Symbol) }
-          def balance_type
-          end
+          # The time on which the balance became true for the account.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :as_of_time
 
-          sig { params(_: Symbol).returns(Symbol) }
-          def balance_type=(_)
-          end
+          # The specific type of balance reported. One of `opening_ledger`,
+          # `closing_ledger`, `current_ledger`, `opening_available`,
+          # `opening_available_next_business_day`, `closing_available`, `current_available`,
+          # 'previously_closed_book', or `other`.
+          sig { returns(ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol) }
+          attr_accessor :balance_type
 
           sig { returns(Time) }
-          def created_at
-          end
-
-          sig { params(_: Time).returns(Time) }
-          def created_at=(_)
-          end
+          attr_accessor :created_at
 
-          sig { returns(Symbol) }
-          def currency
-          end
-
-          sig { params(_: Symbol).returns(Symbol) }
-          def currency=(_)
-          end
+          # The currency of the balance.
+          sig { returns(ModernTreasury::Models::Currency::TaggedSymbol) }
+          attr_accessor :currency
 
+          # 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
-
-          sig { params(_: String).returns(String) }
-          def object=(_)
-          end
+          attr_accessor :object
 
           sig { returns(Time) }
-          def updated_at
-          end
-
-          sig { params(_: Time).returns(Time) }
-          def updated_at=(_)
-          end
+          attr_accessor :updated_at
 
+          # The date on which the balance becomes available.
           sig { returns(T.nilable(Date)) }
-          def value_date
-          end
-
-          sig { params(_: T.nilable(Date)).returns(T.nilable(Date)) }
-          def value_date=(_)
-          end
+          attr_accessor :value_date
 
+          # The code used by the bank when reporting this specific balance.
           sig { returns(String) }
-          def vendor_code
-          end
-
-          sig { params(_: String).returns(String) }
-          def vendor_code=(_)
-          end
+          attr_accessor :vendor_code
 
+          # The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`,
+          # `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
+          # `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
+          # `swift`, or `us_bank`.
           sig { returns(T.nilable(String)) }
-          def vendor_code_type
-          end
-
-          sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-          def vendor_code_type=(_)
-          end
+          attr_accessor :vendor_code_type
 
           sig do
             params(
               id: String,
               amount: Integer,
               as_of_date: T.nilable(Date),
-              as_of_time: T.nilable(String),
-              balance_type: Symbol,
+              as_of_time: T.nilable(Time),
+              balance_type: ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::OrSymbol,
               created_at: Time,
-              currency: Symbol,
+              currency: ModernTreasury::Models::Currency::OrSymbol,
               live_mode: T::Boolean,
               object: String,
               updated_at: Time,
@@ -270,9 +200,9 @@ module ModernTreasury
               vendor_code: String,
               vendor_code_type: T.nilable(String)
             )
-              .void
+              .returns(T.attached_class)
           end
-          def initialize(
+          def self.new(
             id:,
             amount:,
             as_of_date:,
@@ -286,9 +216,7 @@ module ModernTreasury
             value_date:,
             vendor_code:,
             vendor_code_type:
-          )
-          end
-
+          ); end
           sig do
             override
               .returns(
@@ -296,10 +224,10 @@ module ModernTreasury
                   id: String,
                   amount: Integer,
                   as_of_date: T.nilable(Date),
-                  as_of_time: T.nilable(String),
-                  balance_type: Symbol,
+                  as_of_time: T.nilable(Time),
+                  balance_type: ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol,
                   created_at: Time,
-                  currency: Symbol,
+                  currency: ModernTreasury::Models::Currency::TaggedSymbol,
                   live_mode: T::Boolean,
                   object: String,
                   updated_at: Time,
@@ -309,25 +237,76 @@ module ModernTreasury
                 }
               )
           end
-          def to_hash
-          end
+          def to_hash; end
+
+          # The specific type of balance reported. One of `opening_ledger`,
+          # `closing_ledger`, `current_ledger`, `opening_available`,
+          # `opening_available_next_business_day`, `closing_available`, `current_available`,
+          # 'previously_closed_book', or `other`.
+          module BalanceType
+            extend ModernTreasury::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias { T.all(Symbol, ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType) }
+            OrSymbol =
+              T.type_alias do
+                T.any(
+                  Symbol,
+                  String,
+                  ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
+                )
+              end
+
+            CLOSING_AVAILABLE =
+              T.let(
+                :closing_available,
+                ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
+              )
+            CLOSING_LEDGER =
+              T.let(
+                :closing_ledger,
+                ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
+              )
+            CURRENT_AVAILABLE =
+              T.let(
+                :current_available,
+                ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
+              )
+            CURRENT_LEDGER =
+              T.let(
+                :current_ledger,
+                ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
+              )
+            OPENING_AVAILABLE =
+              T.let(
+                :opening_available,
+                ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
+              )
+            OPENING_AVAILABLE_NEXT_BUSINESS_DAY =
+              T.let(
+                :opening_available_next_business_day,
+                ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
+              )
+            OPENING_LEDGER =
+              T.let(
+                :opening_ledger,
+                ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
+              )
+            OTHER =
+              T.let(:other, ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol)
+            PREVIOUSLY_CLOSED_BOOK =
+              T.let(
+                :previously_closed_book,
+                ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
+              )
 
-          class BalanceType < ModernTreasury::Enum
-            abstract!
-
-            CLOSING_AVAILABLE = :closing_available
-            CLOSING_LEDGER = :closing_ledger
-            CURRENT_AVAILABLE = :current_available
-            CURRENT_LEDGER = :current_ledger
-            OPENING_AVAILABLE = :opening_available
-            OPENING_AVAILABLE_NEXT_BUSINESS_DAY = :opening_available_next_business_day
-            OPENING_LEDGER = :opening_ledger
-            OTHER = :other
-            PREVIOUSLY_CLOSED_BOOK = :previously_closed_book
-
-            sig { override.returns(T::Array[Symbol]) }
-            def self.values
+            sig do
+              override
+                .returns(
+                  T::Array[ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol]
+                )
             end
+            def self.values; end
           end
         end
       end