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

data/rbi/modern_treasury/models/internal_account_retrieve_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class InternalAccountRetrieveParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::InternalAccountRetrieveParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: ModernTreasury::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig do
+        override.returns({ request_options: ModernTreasury::RequestOptions })
+      end
+      def to_hash
+      end
+    end
+  end
+end

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

@@ -6,6 +6,14 @@ module ModernTreasury
       extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::InternalAccountUpdateParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
       # The Counterparty associated to this account.
       sig { returns(T.nilable(String)) }
       attr_reader :counterparty_id
@@ -49,32 +57,39 @@ module ModernTreasury
           metadata: T::Hash[Symbol, String],
           name: String,
           parent_account_id: String,
-          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash)
-        )
-          .returns(T.attached_class)
+          request_options: ModernTreasury::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
       def self.new(
+        # The Counterparty associated to this account.
         counterparty_id: nil,
+        # The Ledger Account associated to this account.
         ledger_account_id: nil,
+        # Additional data in the form of key-value pairs. Pairs can be removed by passing
+        # an empty string or `null` as the value.
         metadata: nil,
+        # The nickname for the internal account.
         name: nil,
+        # The parent internal account for this account.
         parent_account_id: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              counterparty_id: String,
-              ledger_account_id: String,
-              metadata: T::Hash[Symbol, String],
-              name: String,
-              parent_account_id: String,
-              request_options: ModernTreasury::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            counterparty_id: String,
+            ledger_account_id: String,
+            metadata: T::Hash[Symbol, String],
+            name: String,
+            parent_account_id: String,
+            request_options: ModernTreasury::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/{lib/modern_treasury → modern_treasury}/models/internal_accounts/balance_report.rbi

@@ -4,6 +4,14 @@ module ModernTreasury
   module Models
     module InternalAccounts
       class BalanceReport < ModernTreasury::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ModernTreasury::InternalAccounts::BalanceReport,
+              ModernTreasury::Internal::AnyHash
+            )
+          end
+
         sig { returns(String) }
         attr_accessor :id
 
@@ -17,11 +25,19 @@ module ModernTreasury
 
         # The specific type of balance report. One of `intraday`, `previous_day`,
         # `real_time`, or `other`.
-        sig { returns(ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol) }
+        sig do
+          returns(
+            ModernTreasury::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol
+          )
+        end
         attr_accessor :balance_report_type
 
         # An array of `Balance` objects.
-        sig { returns(T::Array[ModernTreasury::Models::InternalAccounts::BalanceReport::Balance]) }
+        sig do
+          returns(
+            T::Array[ModernTreasury::InternalAccounts::BalanceReport::Balance]
+          )
+        end
         attr_accessor :balances
 
         sig { returns(Time) }
@@ -47,46 +63,63 @@ module ModernTreasury
             id: String,
             as_of_date: Date,
             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)],
+            balance_report_type:
+              ModernTreasury::InternalAccounts::BalanceReport::BalanceReportType::OrSymbol,
+            balances:
+              T::Array[
+                ModernTreasury::InternalAccounts::BalanceReport::Balance::OrHash
+              ],
             created_at: Time,
             internal_account_id: String,
             live_mode: T::Boolean,
             object: String,
             updated_at: Time
-          )
-            .returns(T.attached_class)
+          ).returns(T.attached_class)
         end
         def self.new(
           id:,
+          # The date of the balance report in local time.
           as_of_date:,
+          # The time (24-hour clock) of the balance report in local time.
           as_of_time:,
+          # The specific type of balance report. One of `intraday`, `previous_day`,
+          # `real_time`, or `other`.
           balance_report_type:,
+          # An array of `Balance` objects.
           balances:,
           created_at:,
+          # The ID of one of your organization's Internal Accounts.
           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.
           live_mode:,
           object:,
           updated_at:
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns(
-              {
-                id: String,
-                as_of_date: Date,
-                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,
-                live_mode: T::Boolean,
-                object: String,
-                updated_at: Time
-              }
-            )
+          override.returns(
+            {
+              id: String,
+              as_of_date: Date,
+              as_of_time: T.nilable(Time),
+              balance_report_type:
+                ModernTreasury::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol,
+              balances:
+                T::Array[
+                  ModernTreasury::InternalAccounts::BalanceReport::Balance
+                ],
+              created_at: Time,
+              internal_account_id: String,
+              live_mode: T::Boolean,
+              object: String,
+              updated_at: Time
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
 
         # The specific type of balance report. One of `intraday`, `previous_day`,
         # `real_time`, or `other`.
@@ -94,41 +127,55 @@ module ModernTreasury
           extend ModernTreasury::Internal::Type::Enum
 
           TaggedSymbol =
-            T.type_alias { T.all(Symbol, ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType) }
-          OrSymbol =
             T.type_alias do
-              T.any(
+              T.all(
                 Symbol,
-                String,
-                ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol
+                ModernTreasury::InternalAccounts::BalanceReport::BalanceReportType
               )
             end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           INTRADAY =
-            T.let(:intraday, ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol)
+            T.let(
+              :intraday,
+              ModernTreasury::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol
+            )
           OTHER =
-            T.let(:other, ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol)
+            T.let(
+              :other,
+              ModernTreasury::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol
+            )
           PREVIOUS_DAY =
             T.let(
               :previous_day,
-              ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol
+              ModernTreasury::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol
             )
           REAL_TIME =
             T.let(
               :real_time,
-              ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol
+              ModernTreasury::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol
             )
 
           sig do
-            override
-              .returns(
-                T::Array[ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol]
-              )
+            override.returns(
+              T::Array[
+                ModernTreasury::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
           end
-          def self.values; end
         end
 
         class Balance < ModernTreasury::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ModernTreasury::InternalAccounts::BalanceReport::Balance,
+                ModernTreasury::Internal::AnyHash
+              )
+            end
+
           sig { returns(String) }
           attr_accessor :id
 
@@ -148,14 +195,18 @@ module ModernTreasury
           # `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) }
+          sig do
+            returns(
+              ModernTreasury::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
+            )
+          end
           attr_accessor :balance_type
 
           sig { returns(Time) }
           attr_accessor :created_at
 
           # The currency of the balance.
-          sig { returns(ModernTreasury::Models::Currency::TaggedSymbol) }
+          sig { returns(ModernTreasury::Currency::TaggedSymbol) }
           attr_accessor :currency
 
           # This field will be true if this object exists in the live environment or false
@@ -190,54 +241,73 @@ module ModernTreasury
               amount: Integer,
               as_of_date: T.nilable(Date),
               as_of_time: T.nilable(Time),
-              balance_type: ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::OrSymbol,
+              balance_type:
+                ModernTreasury::InternalAccounts::BalanceReport::Balance::BalanceType::OrSymbol,
               created_at: Time,
-              currency: ModernTreasury::Models::Currency::OrSymbol,
+              currency: ModernTreasury::Currency::OrSymbol,
               live_mode: T::Boolean,
               object: String,
               updated_at: Time,
               value_date: T.nilable(Date),
               vendor_code: String,
               vendor_code_type: T.nilable(String)
-            )
-              .returns(T.attached_class)
+            ).returns(T.attached_class)
           end
           def self.new(
             id:,
+            # The balance amount.
             amount:,
+            # The date on which the balance became true for the account.
             as_of_date:,
+            # The time on which the balance became true for the account.
             as_of_time:,
+            # 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`.
             balance_type:,
             created_at:,
+            # The currency of the balance.
             currency:,
+            # 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:,
             updated_at:,
+            # The date on which the balance becomes available.
             value_date:,
+            # The code used by the bank when reporting this specific balance.
             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`.
             vendor_code_type:
-          ); end
+          )
+          end
+
           sig do
-            override
-              .returns(
-                {
-                  id: String,
-                  amount: Integer,
-                  as_of_date: T.nilable(Date),
-                  as_of_time: T.nilable(Time),
-                  balance_type: ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol,
-                  created_at: Time,
-                  currency: ModernTreasury::Models::Currency::TaggedSymbol,
-                  live_mode: T::Boolean,
-                  object: String,
-                  updated_at: Time,
-                  value_date: T.nilable(Date),
-                  vendor_code: String,
-                  vendor_code_type: T.nilable(String)
-                }
-              )
+            override.returns(
+              {
+                id: String,
+                amount: Integer,
+                as_of_date: T.nilable(Date),
+                as_of_time: T.nilable(Time),
+                balance_type:
+                  ModernTreasury::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol,
+                created_at: Time,
+                currency: ModernTreasury::Currency::TaggedSymbol,
+                live_mode: T::Boolean,
+                object: String,
+                updated_at: Time,
+                value_date: T.nilable(Date),
+                vendor_code: String,
+                vendor_code_type: T.nilable(String)
+              }
+            )
+          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`,
@@ -247,66 +317,69 @@ module ModernTreasury
             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(
+                T.all(
                   Symbol,
-                  String,
-                  ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
+                  ModernTreasury::InternalAccounts::BalanceReport::Balance::BalanceType
                 )
               end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
 
             CLOSING_AVAILABLE =
               T.let(
                 :closing_available,
-                ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
+                ModernTreasury::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
               )
             CLOSING_LEDGER =
               T.let(
                 :closing_ledger,
-                ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
+                ModernTreasury::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
               )
             CURRENT_AVAILABLE =
               T.let(
                 :current_available,
-                ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
+                ModernTreasury::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
               )
             CURRENT_LEDGER =
               T.let(
                 :current_ledger,
-                ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
+                ModernTreasury::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
               )
             OPENING_AVAILABLE =
               T.let(
                 :opening_available,
-                ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
+                ModernTreasury::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
               )
             OPENING_AVAILABLE_NEXT_BUSINESS_DAY =
               T.let(
                 :opening_available_next_business_day,
-                ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
+                ModernTreasury::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
               )
             OPENING_LEDGER =
               T.let(
                 :opening_ledger,
-                ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
+                ModernTreasury::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
               )
             OTHER =
-              T.let(:other, ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol)
+              T.let(
+                :other,
+                ModernTreasury::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
+              )
             PREVIOUSLY_CLOSED_BOOK =
               T.let(
                 :previously_closed_book,
-                ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
+                ModernTreasury::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
               )
 
             sig do
-              override
-                .returns(
-                  T::Array[ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol]
-                )
+              override.returns(
+                T::Array[
+                  ModernTreasury::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
             end
-            def self.values; end
           end
         end
       end