modern_treasury 0.0.0 → 0.1.0.pre.alpha.16

data/rbi/lib/modern_treasury/models/external_account_verify_response.rbi

@@ -0,0 +1,395 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    module ExternalAccountVerifyResponse
+      extend ModernTreasury::Union
+
+      class ExternalAccountVerificationAttempt < ModernTreasury::BaseModel
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # The ID of the external account.
+        sig { returns(String) }
+        attr_accessor :external_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
+
+        # The ID of the internal account where the micro-deposits originate from.
+        sig { returns(String) }
+        attr_accessor :originating_account_id
+
+        # The type of payment that can be made to this account. Can be `ach`, `eft`, or
+        #   `rtp`.
+        sig do
+          returns(
+            ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+          )
+        end
+        attr_accessor :payment_type
+
+        # The priority of the payment. Can be `normal` or `high`.
+        sig do
+          returns(
+            T.nilable(
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Priority::TaggedSymbol
+            )
+          )
+        end
+        attr_accessor :priority
+
+        # The status of the verification attempt. Can be `pending_verification`,
+        #   `verified`, `failed`, or `cancelled`.
+        sig do
+          returns(
+            ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        sig { returns(Time) }
+        attr_accessor :updated_at
+
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            external_account_id: String,
+            live_mode: T::Boolean,
+            object: String,
+            originating_account_id: String,
+            payment_type: ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::OrSymbol,
+            priority: T.nilable(
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Priority::OrSymbol
+            ),
+            status: ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status::OrSymbol,
+            updated_at: Time
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          created_at:,
+          external_account_id:,
+          live_mode:,
+          object:,
+          originating_account_id:,
+          payment_type:,
+          priority:,
+          status:,
+          updated_at:
+        )
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                id: String,
+                created_at: Time,
+                external_account_id: String,
+                live_mode: T::Boolean,
+                object: String,
+                originating_account_id: String,
+                payment_type: ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol,
+                priority: T.nilable(
+                  ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Priority::TaggedSymbol
+                ),
+                status: ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status::TaggedSymbol,
+                updated_at: Time
+              }
+            )
+        end
+        def to_hash
+        end
+
+        # The type of payment that can be made to this account. Can be `ach`, `eft`, or
+        #   `rtp`.
+        module PaymentType
+          extend ModernTreasury::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType)
+            end
+          OrSymbol =
+            T.type_alias do
+              T.any(
+                Symbol,
+                ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+              )
+            end
+
+          ACH =
+            T.let(
+              :ach,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          AU_BECS =
+            T.let(
+              :au_becs,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          BACS =
+            T.let(
+              :bacs,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          BOOK =
+            T.let(
+              :book,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          CARD =
+            T.let(
+              :card,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          CHATS =
+            T.let(
+              :chats,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          CHECK =
+            T.let(
+              :check,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          CROSS_BORDER =
+            T.let(
+              :cross_border,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          DK_NETS =
+            T.let(
+              :dk_nets,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          EFT =
+            T.let(
+              :eft,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          HU_ICS =
+            T.let(
+              :hu_ics,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          INTERAC =
+            T.let(
+              :interac,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          MASAV =
+            T.let(
+              :masav,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          MX_CCEN =
+            T.let(
+              :mx_ccen,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          NEFT =
+            T.let(
+              :neft,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          NICS =
+            T.let(
+              :nics,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          NZ_BECS =
+            T.let(
+              :nz_becs,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          PL_ELIXIR =
+            T.let(
+              :pl_elixir,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          PROVXCHANGE =
+            T.let(
+              :provxchange,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          RO_SENT =
+            T.let(
+              :ro_sent,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          RTP =
+            T.let(
+              :rtp,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          SE_BANKGIROT =
+            T.let(
+              :se_bankgirot,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          SEN =
+            T.let(
+              :sen,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          SEPA =
+            T.let(
+              :sepa,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          SG_GIRO =
+            T.let(
+              :sg_giro,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          SIC =
+            T.let(
+              :sic,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          SIGNET =
+            T.let(
+              :signet,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          SKNBI =
+            T.let(
+              :sknbi,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          WIRE =
+            T.let(
+              :wire,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+          ZENGIN =
+            T.let(
+              :zengin,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+            )
+
+          sig do
+            override
+              .returns(
+                T::Array[
+                ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType::TaggedSymbol
+                ]
+              )
+          end
+          def self.values
+          end
+        end
+
+        # The priority of the payment. Can be `normal` or `high`.
+        module Priority
+          extend ModernTreasury::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Priority)
+            end
+          OrSymbol =
+            T.type_alias do
+              T.any(
+                Symbol,
+                ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Priority::TaggedSymbol
+              )
+            end
+
+          HIGH =
+            T.let(
+              :high,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Priority::TaggedSymbol
+            )
+          NORMAL =
+            T.let(
+              :normal,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Priority::TaggedSymbol
+            )
+
+          sig do
+            override
+              .returns(
+                T::Array[
+                ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Priority::TaggedSymbol
+                ]
+              )
+          end
+          def self.values
+          end
+        end
+
+        # The status of the verification attempt. Can be `pending_verification`,
+        #   `verified`, `failed`, or `cancelled`.
+        module Status
+          extend ModernTreasury::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status)
+            end
+          OrSymbol =
+            T.type_alias do
+              T.any(
+                Symbol,
+                ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status::TaggedSymbol
+              )
+            end
+
+          CANCELLED =
+            T.let(
+              :cancelled,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status::TaggedSymbol
+            )
+          FAILED =
+            T.let(
+              :failed,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status::TaggedSymbol
+            )
+          PENDING_VERIFICATION =
+            T.let(
+              :pending_verification,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status::TaggedSymbol
+            )
+          VERIFIED =
+            T.let(
+              :verified,
+              ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status::TaggedSymbol
+            )
+
+          sig do
+            override
+              .returns(
+                T::Array[
+                ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status::TaggedSymbol
+                ]
+              )
+          end
+          def self.values
+          end
+        end
+      end
+
+      sig do
+        override
+          .returns(
+            [ModernTreasury::Models::ExternalAccount, ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt]
+          )
+      end
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/lib/modern_treasury/models/foreign_exchange_quote.rbi

@@ -0,0 +1,188 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class ForeignExchangeQuote < ModernTreasury::BaseModel
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The timestamp until when the quoted rate is valid.
+      sig { returns(Time) }
+      attr_accessor :effective_at
+
+      # The timestamp until which the quote must be booked by.
+      sig { returns(Time) }
+      attr_accessor :expires_at
+
+      # Either `fixed_to_variable` if the `base_amount` was specified, or
+      #   `variable_to_fixed` if the `target_amount` was specified when requesting the
+      #   quote.
+      sig { returns(String) }
+      attr_accessor :foreign_exchange_indicator
+
+      # The serialized rate information represented by this quote.
+      sig { returns(ModernTreasury::Models::ForeignExchangeQuote::ForeignExchangeRate) }
+      attr_reader :foreign_exchange_rate
+
+      sig do
+        params(
+          foreign_exchange_rate: T.any(ModernTreasury::Models::ForeignExchangeQuote::ForeignExchangeRate, ModernTreasury::Util::AnyHash)
+        )
+          .void
+      end
+      attr_writer :foreign_exchange_rate
+
+      # The ID for the `InternalAccount` this quote is associated with.
+      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
+
+      # Additional data represented as key-value pairs. Both the key and value must be
+      #   strings.
+      sig { returns(T::Hash[Symbol, String]) }
+      attr_accessor :metadata
+
+      sig { returns(String) }
+      attr_accessor :object
+
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # This vendor assigned ID for this quote.
+      sig { returns(T.nilable(String)) }
+      attr_reader :vendor_id
+
+      sig { params(vendor_id: String).void }
+      attr_writer :vendor_id
+
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          effective_at: Time,
+          expires_at: Time,
+          foreign_exchange_indicator: String,
+          foreign_exchange_rate: T.any(ModernTreasury::Models::ForeignExchangeQuote::ForeignExchangeRate, ModernTreasury::Util::AnyHash),
+          internal_account_id: String,
+          live_mode: T::Boolean,
+          metadata: T::Hash[Symbol, String],
+          object: String,
+          updated_at: Time,
+          vendor_id: String
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        created_at:,
+        effective_at:,
+        expires_at:,
+        foreign_exchange_indicator:,
+        foreign_exchange_rate:,
+        internal_account_id:,
+        live_mode:,
+        metadata:,
+        object:,
+        updated_at:,
+        vendor_id: nil
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              id: String,
+              created_at: Time,
+              effective_at: Time,
+              expires_at: Time,
+              foreign_exchange_indicator: String,
+              foreign_exchange_rate: ModernTreasury::Models::ForeignExchangeQuote::ForeignExchangeRate,
+              internal_account_id: String,
+              live_mode: T::Boolean,
+              metadata: T::Hash[Symbol, String],
+              object: String,
+              updated_at: Time,
+              vendor_id: String
+            }
+          )
+      end
+      def to_hash
+      end
+
+      class ForeignExchangeRate < ModernTreasury::BaseModel
+        # Amount in the lowest denomination of the `base_currency` to convert, often
+        #   called the "sell" amount.
+        sig { returns(Integer) }
+        attr_accessor :base_amount
+
+        # Currency to convert, often called the "sell" currency.
+        sig { returns(ModernTreasury::Models::Currency::TaggedSymbol) }
+        attr_accessor :base_currency
+
+        # The exponent component of the rate. The decimal is calculated as `value` / (10 ^
+        #   `exponent`).
+        sig { returns(Integer) }
+        attr_accessor :exponent
+
+        # A string representation of the rate.
+        sig { returns(String) }
+        attr_accessor :rate_string
+
+        # Amount in the lowest denomination of the `target_currency`, often called the
+        #   "buy" amount.
+        sig { returns(Integer) }
+        attr_accessor :target_amount
+
+        # Currency to convert the `base_currency` to, often called the "buy" currency.
+        sig { returns(ModernTreasury::Models::Currency::TaggedSymbol) }
+        attr_accessor :target_currency
+
+        # The whole number component of the rate. The decimal is calculated as `value` /
+        #   (10 ^ `exponent`).
+        sig { returns(Integer) }
+        attr_accessor :value
+
+        # The serialized rate information represented by this quote.
+        sig do
+          params(
+            base_amount: Integer,
+            base_currency: ModernTreasury::Models::Currency::OrSymbol,
+            exponent: Integer,
+            rate_string: String,
+            target_amount: Integer,
+            target_currency: ModernTreasury::Models::Currency::OrSymbol,
+            value: Integer
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(base_amount:, base_currency:, exponent:, rate_string:, target_amount:, target_currency:, value:)
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                base_amount: Integer,
+                base_currency: ModernTreasury::Models::Currency::TaggedSymbol,
+                exponent: Integer,
+                rate_string: String,
+                target_amount: Integer,
+                target_currency: ModernTreasury::Models::Currency::TaggedSymbol,
+                value: Integer
+              }
+            )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lib/modern_treasury/models/foreign_exchange_quote_create_params.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class ForeignExchangeQuoteCreateParams < ModernTreasury::BaseModel
+      extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # The ID for the `InternalAccount` this quote is associated with.
+      sig { returns(String) }
+      attr_accessor :internal_account_id
+
+      # Currency to convert the `base_currency` to, often called the "buy" currency.
+      sig { returns(ModernTreasury::Models::Currency::OrSymbol) }
+      attr_accessor :target_currency
+
+      # Amount in the lowest denomination of the `base_currency` to convert, often
+      #   called the "sell" amount.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :base_amount
+
+      sig { params(base_amount: Integer).void }
+      attr_writer :base_amount
+
+      # Currency to convert, often called the "sell" currency.
+      sig { returns(T.nilable(ModernTreasury::Models::Currency::OrSymbol)) }
+      attr_reader :base_currency
+
+      sig { params(base_currency: ModernTreasury::Models::Currency::OrSymbol).void }
+      attr_writer :base_currency
+
+      # The timestamp until when the quoted rate is valid.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :effective_at
+
+      sig { params(effective_at: Time).void }
+      attr_writer :effective_at
+
+      # Amount in the lowest denomination of the `target_currency`, often called the
+      #   "buy" amount.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :target_amount
+
+      sig { params(target_amount: Integer).void }
+      attr_writer :target_amount
+
+      sig do
+        params(
+          internal_account_id: String,
+          target_currency: ModernTreasury::Models::Currency::OrSymbol,
+          base_amount: Integer,
+          base_currency: ModernTreasury::Models::Currency::OrSymbol,
+          effective_at: Time,
+          target_amount: Integer,
+          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        internal_account_id:,
+        target_currency:,
+        base_amount: nil,
+        base_currency: nil,
+        effective_at: nil,
+        target_amount: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              internal_account_id: String,
+              target_currency: ModernTreasury::Models::Currency::OrSymbol,
+              base_amount: Integer,
+              base_currency: ModernTreasury::Models::Currency::OrSymbol,
+              effective_at: Time,
+              target_amount: Integer,
+              request_options: ModernTreasury::RequestOptions
+            }
+          )
+      end
+      def to_hash
+      end
+    end
+  end
+end