modern_treasury 0.0.0 → 0.1.0.pre.alpha.16

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

@@ -0,0 +1,311 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    module InternalAccounts
+      class BalanceReport < ModernTreasury::BaseModel
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The date of the balance report in local time.
+        sig { returns(Date) }
+        attr_accessor :as_of_date
+
+        # The time (24-hour clock) of the balance report in local time.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :as_of_time
+
+        # 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]) }
+        attr_accessor :balances
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # The ID of one of your organization's Internal Accounts.
+        sig { returns(String) }
+        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) }
+        attr_accessor :live_mode
+
+        sig { returns(String) }
+        attr_accessor :object
+
+        sig { returns(Time) }
+        attr_accessor :updated_at
+
+        sig do
+          params(
+            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::Util::AnyHash)],
+            created_at: Time,
+            internal_account_id: String,
+            live_mode: T::Boolean,
+            object: String,
+            updated_at: Time
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          as_of_date:,
+          as_of_time:,
+          balance_report_type:,
+          balances:,
+          created_at:,
+          internal_account_id:,
+          live_mode:,
+          object:,
+          updated_at:
+        )
+        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
+              }
+            )
+        end
+        def to_hash
+        end
+
+        # The specific type of balance report. One of `intraday`, `previous_day`,
+        #   `real_time`, or `other`.
+        module BalanceReportType
+          extend ModernTreasury::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType) }
+          OrSymbol =
+            T.type_alias { T.any(Symbol, ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol) }
+
+          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 do
+            override
+              .returns(
+                T::Array[ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType::TaggedSymbol]
+              )
+          end
+          def self.values
+          end
+        end
+
+        class Balance < ModernTreasury::BaseModel
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The balance amount.
+          sig { returns(Integer) }
+          attr_accessor :amount
+
+          # The date on which the balance became true for the account.
+          sig { returns(T.nilable(Date)) }
+          attr_accessor :as_of_date
+
+          # The time on which the balance became true for the account.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :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`.
+          sig { returns(ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol) }
+          attr_accessor :balance_type
+
+          sig { returns(Time) }
+          attr_accessor :created_at
+
+          # 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) }
+          attr_accessor :live_mode
+
+          sig { returns(String) }
+          attr_accessor :object
+
+          sig { returns(Time) }
+          attr_accessor :updated_at
+
+          # The date on which the balance becomes available.
+          sig { returns(T.nilable(Date)) }
+          attr_accessor :value_date
+
+          # The code used by the bank when reporting this specific balance.
+          sig { returns(String) }
+          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)) }
+          attr_accessor :vendor_code_type
+
+          sig do
+            params(
+              id: String,
+              amount: Integer,
+              as_of_date: T.nilable(Date),
+              as_of_time: T.nilable(Time),
+              balance_type: ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::OrSymbol,
+              created_at: Time,
+              currency: ModernTreasury::Models::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)
+          end
+          def self.new(
+            id:,
+            amount:,
+            as_of_date:,
+            as_of_time:,
+            balance_type:,
+            created_at:,
+            currency:,
+            live_mode:,
+            object:,
+            updated_at:,
+            value_date:,
+            vendor_code:,
+            vendor_code_type:
+          )
+          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)
+                }
+              )
+          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::Enum
+
+            TaggedSymbol =
+              T.type_alias { T.all(Symbol, ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType) }
+            OrSymbol =
+              T.type_alias { T.any(Symbol, ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol) }
+
+            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
+              )
+
+            sig do
+              override
+                .returns(
+                  T::Array[ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType::TaggedSymbol]
+                )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,235 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    module InternalAccounts
+      class BalanceReportCreateParams < ModernTreasury::BaseModel
+        extend ModernTreasury::RequestParameters::Converter
+        include ModernTreasury::RequestParameters
+
+        # The date of the balance report in local time.
+        sig { returns(Date) }
+        attr_accessor :as_of_date
+
+        # The time (24-hour clock) of the balance report in local time.
+        sig { returns(String) }
+        attr_accessor :as_of_time
+
+        # The specific type of balance report. One of `intraday`, `previous_day`,
+        #   `real_time`, or `other`.
+        sig { returns(ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::BalanceReportType::OrSymbol) }
+        attr_accessor :balance_report_type
+
+        # An array of `Balance` objects.
+        sig { returns(T::Array[ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance]) }
+        attr_accessor :balances
+
+        sig do
+          params(
+            as_of_date: Date,
+            as_of_time: String,
+            balance_report_type: ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::BalanceReportType::OrSymbol,
+            balances: T::Array[
+            T.any(
+              ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance,
+              ModernTreasury::Util::AnyHash
+            )
+            ],
+            request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(as_of_date:, as_of_time:, balance_report_type:, balances:, request_options: {})
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                as_of_date: Date,
+                as_of_time: String,
+                balance_report_type: ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::BalanceReportType::OrSymbol,
+                balances: T::Array[ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance],
+                request_options: ModernTreasury::RequestOptions
+              }
+            )
+        end
+        def to_hash
+        end
+
+        # The specific type of balance report. One of `intraday`, `previous_day`,
+        #   `real_time`, or `other`.
+        module BalanceReportType
+          extend ModernTreasury::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::BalanceReportType) }
+          OrSymbol =
+            T.type_alias do
+              T.any(
+                Symbol,
+                ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::BalanceReportType::TaggedSymbol
+              )
+            end
+
+          INTRADAY =
+            T.let(
+              :intraday,
+              ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::BalanceReportType::TaggedSymbol
+            )
+          OTHER =
+            T.let(
+              :other,
+              ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::BalanceReportType::TaggedSymbol
+            )
+          PREVIOUS_DAY =
+            T.let(
+              :previous_day,
+              ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::BalanceReportType::TaggedSymbol
+            )
+          REAL_TIME =
+            T.let(
+              :real_time,
+              ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::BalanceReportType::TaggedSymbol
+            )
+
+          sig do
+            override
+              .returns(
+                T::Array[ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::BalanceReportType::TaggedSymbol]
+              )
+          end
+          def self.values
+          end
+        end
+
+        class Balance < ModernTreasury::BaseModel
+          # The balance amount.
+          sig { returns(Integer) }
+          attr_accessor :amount
+
+          # 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 do
+            returns(
+              ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance::BalanceType::OrSymbol
+            )
+          end
+          attr_accessor :balance_type
+
+          # The code used by the bank when reporting this specific balance.
+          sig { returns(String) }
+          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)) }
+          attr_accessor :vendor_code_type
+
+          sig do
+            params(
+              amount: Integer,
+              balance_type: ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance::BalanceType::OrSymbol,
+              vendor_code: String,
+              vendor_code_type: T.nilable(String)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(amount:, balance_type:, vendor_code:, vendor_code_type:)
+          end
+
+          sig do
+            override
+              .returns(
+                {
+                  amount: Integer,
+                  balance_type: ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance::BalanceType::OrSymbol,
+                  vendor_code: String,
+                  vendor_code_type: T.nilable(String)
+                }
+              )
+          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::Enum
+
+            TaggedSymbol =
+              T.type_alias { T.all(Symbol, ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance::BalanceType) }
+            OrSymbol =
+              T.type_alias do
+                T.any(
+                  Symbol,
+                  ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance::BalanceType::TaggedSymbol
+                )
+              end
+
+            CLOSING_AVAILABLE =
+              T.let(
+                :closing_available,
+                ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance::BalanceType::TaggedSymbol
+              )
+            CLOSING_LEDGER =
+              T.let(
+                :closing_ledger,
+                ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance::BalanceType::TaggedSymbol
+              )
+            CURRENT_AVAILABLE =
+              T.let(
+                :current_available,
+                ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance::BalanceType::TaggedSymbol
+              )
+            CURRENT_LEDGER =
+              T.let(
+                :current_ledger,
+                ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance::BalanceType::TaggedSymbol
+              )
+            OPENING_AVAILABLE =
+              T.let(
+                :opening_available,
+                ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance::BalanceType::TaggedSymbol
+              )
+            OPENING_AVAILABLE_NEXT_BUSINESS_DAY =
+              T.let(
+                :opening_available_next_business_day,
+                ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance::BalanceType::TaggedSymbol
+              )
+            OPENING_LEDGER =
+              T.let(
+                :opening_ledger,
+                ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance::BalanceType::TaggedSymbol
+              )
+            OTHER =
+              T.let(
+                :other,
+                ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance::BalanceType::TaggedSymbol
+              )
+            PREVIOUSLY_CLOSED_BOOK =
+              T.let(
+                :previously_closed_book,
+                ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance::BalanceType::TaggedSymbol
+              )
+
+            sig do
+              override
+                .returns(
+                  T::Array[ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance::BalanceType::TaggedSymbol]
+                )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    module InternalAccounts
+      class BalanceReportDeleteParams < ModernTreasury::BaseModel
+        extend ModernTreasury::RequestParameters::Converter
+        include ModernTreasury::RequestParameters
+
+        sig { returns(String) }
+        attr_accessor :internal_account_id
+
+        sig do
+          params(
+            internal_account_id: String,
+            request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(internal_account_id:, request_options: {})
+        end
+
+        sig do
+          override.returns({internal_account_id: String, request_options: ModernTreasury::RequestOptions})
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,119 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    module InternalAccounts
+      class BalanceReportListParams < ModernTreasury::BaseModel
+        extend ModernTreasury::RequestParameters::Converter
+        include ModernTreasury::RequestParameters
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :after_cursor
+
+        # The date of the balance report in local time.
+        sig { returns(T.nilable(Date)) }
+        attr_reader :as_of_date
+
+        sig { params(as_of_date: Date).void }
+        attr_writer :as_of_date
+
+        # The specific type of balance report. One of `intraday`, `previous_day`,
+        #   `real_time`, or `other`.
+        sig do
+          returns(
+            T.nilable(ModernTreasury::Models::InternalAccounts::BalanceReportListParams::BalanceReportType::OrSymbol)
+          )
+        end
+        attr_reader :balance_report_type
+
+        sig do
+          params(
+            balance_report_type: ModernTreasury::Models::InternalAccounts::BalanceReportListParams::BalanceReportType::OrSymbol
+          )
+            .void
+        end
+        attr_writer :balance_report_type
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :per_page
+
+        sig { params(per_page: Integer).void }
+        attr_writer :per_page
+
+        sig do
+          params(
+            after_cursor: T.nilable(String),
+            as_of_date: Date,
+            balance_report_type: ModernTreasury::Models::InternalAccounts::BalanceReportListParams::BalanceReportType::OrSymbol,
+            per_page: Integer,
+            request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(after_cursor: nil, as_of_date: nil, balance_report_type: nil, per_page: nil, request_options: {})
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                after_cursor: T.nilable(String),
+                as_of_date: Date,
+                balance_report_type: ModernTreasury::Models::InternalAccounts::BalanceReportListParams::BalanceReportType::OrSymbol,
+                per_page: Integer,
+                request_options: ModernTreasury::RequestOptions
+              }
+            )
+        end
+        def to_hash
+        end
+
+        # The specific type of balance report. One of `intraday`, `previous_day`,
+        #   `real_time`, or `other`.
+        module BalanceReportType
+          extend ModernTreasury::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, ModernTreasury::Models::InternalAccounts::BalanceReportListParams::BalanceReportType) }
+          OrSymbol =
+            T.type_alias do
+              T.any(
+                Symbol,
+                ModernTreasury::Models::InternalAccounts::BalanceReportListParams::BalanceReportType::TaggedSymbol
+              )
+            end
+
+          INTRADAY =
+            T.let(
+              :intraday,
+              ModernTreasury::Models::InternalAccounts::BalanceReportListParams::BalanceReportType::TaggedSymbol
+            )
+          OTHER =
+            T.let(
+              :other,
+              ModernTreasury::Models::InternalAccounts::BalanceReportListParams::BalanceReportType::TaggedSymbol
+            )
+          PREVIOUS_DAY =
+            T.let(
+              :previous_day,
+              ModernTreasury::Models::InternalAccounts::BalanceReportListParams::BalanceReportType::TaggedSymbol
+            )
+          REAL_TIME =
+            T.let(
+              :real_time,
+              ModernTreasury::Models::InternalAccounts::BalanceReportListParams::BalanceReportType::TaggedSymbol
+            )
+
+          sig do
+            override
+              .returns(
+                T::Array[ModernTreasury::Models::InternalAccounts::BalanceReportListParams::BalanceReportType::TaggedSymbol]
+              )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end