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

data/lib/modern_treasury/models/external_account_verify_params.rb

@@ -2,14 +2,15 @@
 
 module ModernTreasury
   module Models
-    class ExternalAccountVerifyParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::ExternalAccounts#verify
+    class ExternalAccountVerifyParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute originating_account_id
       #   The ID of the internal account where the micro-deposits originate from. Both
-      #     credit and debit capabilities must be enabled.
+      #   credit and debit capabilities must be enabled.
       #
       #   @return [String]
       required :originating_account_id, String
@@ -32,8 +33,8 @@ module ModernTreasury
 
       # @!attribute [r] fallback_type
       #   A payment type to fallback to if the original type is not valid for the
-      #     receiving account. Currently, this only supports falling back from RTP to ACH
-      #     (payment_type=rtp and fallback_type=ach)
+      #   receiving account. Currently, this only supports falling back from RTP to ACH
+      #   (payment_type=rtp and fallback_type=ach)
       #
       #   @return [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::FallbackType, nil]
       optional :fallback_type, enum: -> { ModernTreasury::Models::ExternalAccountVerifyParams::FallbackType }
@@ -44,7 +45,7 @@ module ModernTreasury
 
       # @!attribute [r] priority
       #   Either `normal` or `high`. For ACH payments, `high` represents a same-day ACH
-      #     transfer. This will apply to both `payment_type` and `fallback_type`.
+      #   transfer. This will apply to both `payment_type` and `fallback_type`.
       #
       #   @return [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::Priority, nil]
       optional :priority, enum: -> { ModernTreasury::Models::ExternalAccountVerifyParams::Priority }
@@ -73,30 +74,12 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # Can be `ach`, `eft`, or `rtp`.
-      #
-      # @example
-      # ```ruby
-      # case payment_type
-      # in :ach
-      #   # ...
-      # in :au_becs
-      #   # ...
-      # in :bacs
-      #   # ...
-      # in :book
-      #   # ...
-      # in :card
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class PaymentType < ModernTreasury::Enum
+      module PaymentType
+        extend ModernTreasury::Internal::Type::Enum
+
         ACH = :ach
         AU_BECS = :au_becs
         BACS = :bacs
@@ -132,49 +115,29 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # A payment type to fallback to if the original type is not valid for the
-      #   receiving account. Currently, this only supports falling back from RTP to ACH
-      #   (payment_type=rtp and fallback_type=ach)
-      #
-      # @example
-      # ```ruby
-      # case fallback_type
-      # in :ach
-      #   # ...
-      # end
-      # ```
-      class FallbackType < ModernTreasury::Enum
+      # receiving account. Currently, this only supports falling back from RTP to ACH
+      # (payment_type=rtp and fallback_type=ach)
+      module FallbackType
+        extend ModernTreasury::Internal::Type::Enum
+
         ACH = :ach
 
         finalize!
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # Either `normal` or `high`. For ACH payments, `high` represents a same-day ACH
-      #   transfer. This will apply to both `payment_type` and `fallback_type`.
-      #
-      # @example
-      # ```ruby
-      # case priority
-      # in :high
-      #   # ...
-      # in :normal
-      #   # ...
-      # end
-      # ```
-      class Priority < ModernTreasury::Enum
+      # transfer. This will apply to both `payment_type` and `fallback_type`.
+      module Priority
+        extend ModernTreasury::Internal::Type::Enum
+
         HIGH = :high
         NORMAL = :normal
 
@@ -182,7 +145,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/external_account_verify_response.rb

@@ -2,23 +2,15 @@
 
 module ModernTreasury
   module Models
-    # @abstract
-    #
-    # @example
-    # ```ruby
-    # case external_account_verify_response
-    # in ModernTreasury::Models::ExternalAccount
-    #   # ...
-    # in ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt
-    #   # ...
-    # end
-    # ```
-    class ExternalAccountVerifyResponse < ModernTreasury::Union
+    # @see ModernTreasury::Resources::ExternalAccounts#verify
+    module ExternalAccountVerifyResponse
+      extend ModernTreasury::Internal::Type::Union
+
       variant -> { ModernTreasury::Models::ExternalAccount }
 
       variant -> { ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt }
 
-      class ExternalAccountVerificationAttempt < ModernTreasury::BaseModel
+      class ExternalAccountVerificationAttempt < ModernTreasury::Internal::Type::BaseModel
         # @!attribute id
         #
         #   @return [String]
@@ -37,10 +29,10 @@ module ModernTreasury
 
         # @!attribute live_mode
         #   This field will be true if this object exists in the live environment or false
-        #     if it exists in the test environment.
+        #   if it exists in the test environment.
         #
         #   @return [Boolean]
-        required :live_mode, ModernTreasury::BooleanModel
+        required :live_mode, ModernTreasury::Internal::Type::Boolean
 
         # @!attribute object
         #
@@ -55,7 +47,7 @@ module ModernTreasury
 
         # @!attribute payment_type
         #   The type of payment that can be made to this account. Can be `ach`, `eft`, or
-        #     `rtp`.
+        #   `rtp`.
         #
         #   @return [Symbol, ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType]
         required :payment_type,
@@ -71,7 +63,7 @@ module ModernTreasury
 
         # @!attribute status
         #   The status of the verification attempt. Can be `pending_verification`,
-        #     `verified`, `failed`, or `cancelled`.
+        #   `verified`, `failed`, or `cancelled`.
         #
         #   @return [Symbol, ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status]
         required :status,
@@ -110,31 +102,15 @@ module ModernTreasury
         #     super
         #   end
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-        # @abstract
-        #
         # The type of payment that can be made to this account. Can be `ach`, `eft`, or
-        #   `rtp`.
+        # `rtp`.
         #
-        # @example
-        # ```ruby
-        # case payment_type
-        # in :ach
-        #   # ...
-        # in :au_becs
-        #   # ...
-        # in :bacs
-        #   # ...
-        # in :book
-        #   # ...
-        # in :card
-        #   # ...
-        # in ...
-        #   #...
-        # end
-        # ```
-        class PaymentType < ModernTreasury::Enum
+        # @see ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt#payment_type
+        module PaymentType
+          extend ModernTreasury::Internal::Type::Enum
+
           ACH = :ach
           AU_BECS = :au_becs
           BACS = :bacs
@@ -170,24 +146,15 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
-        # @abstract
-        #
         # The priority of the payment. Can be `normal` or `high`.
         #
-        # @example
-        # ```ruby
-        # case priority
-        # in :high
-        #   # ...
-        # in :normal
-        #   # ...
-        # end
-        # ```
-        class Priority < ModernTreasury::Enum
+        # @see ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt#priority
+        module Priority
+          extend ModernTreasury::Internal::Type::Enum
+
           HIGH = :high
           NORMAL = :normal
 
@@ -195,29 +162,16 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
-        # @abstract
-        #
         # The status of the verification attempt. Can be `pending_verification`,
-        #   `verified`, `failed`, or `cancelled`.
+        # `verified`, `failed`, or `cancelled`.
         #
-        # @example
-        # ```ruby
-        # case status
-        # in :cancelled
-        #   # ...
-        # in :failed
-        #   # ...
-        # in :pending_verification
-        #   # ...
-        # in :verified
-        #   # ...
-        # end
-        # ```
-        class Status < ModernTreasury::Enum
+        # @see ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt#status
+        module Status
+          extend ModernTreasury::Internal::Type::Enum
+
           CANCELLED = :cancelled
           FAILED = :failed
           PENDING_VERIFICATION = :pending_verification
@@ -227,10 +181,13 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end
+
+      # @!parse
+      #   # @return [Array(ModernTreasury::Models::ExternalAccount, ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt)]
+      #   def self.variants; end
     end
   end
 end

data/lib/modern_treasury/models/foreign_exchange_quote.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class ForeignExchangeQuote < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::ForeignExchangeQuotes#create
+    class ForeignExchangeQuote < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -27,8 +28,8 @@ module ModernTreasury
 
       # @!attribute foreign_exchange_indicator
       #   Either `fixed_to_variable` if the `base_amount` was specified, or
-      #     `variable_to_fixed` if the `target_amount` was specified when requesting the
-      #     quote.
+      #   `variable_to_fixed` if the `target_amount` was specified when requesting the
+      #   quote.
       #
       #   @return [String]
       required :foreign_exchange_indicator, String
@@ -47,17 +48,17 @@ module ModernTreasury
 
       # @!attribute live_mode
       #   This field will be true if this object exists in the live environment or false
-      #     if it exists in the test environment.
+      #   if it exists in the test environment.
       #
       #   @return [Boolean]
-      required :live_mode, ModernTreasury::BooleanModel
+      required :live_mode, ModernTreasury::Internal::Type::Boolean
 
       # @!attribute metadata
       #   Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
+      #   strings.
       #
       #   @return [Hash{Symbol=>String}]
-      required :metadata, ModernTreasury::HashOf[String]
+      required :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!attribute object
       #
@@ -111,12 +112,13 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      class ForeignExchangeRate < ModernTreasury::BaseModel
+      # @see ModernTreasury::Models::ForeignExchangeQuote#foreign_exchange_rate
+      class ForeignExchangeRate < ModernTreasury::Internal::Type::BaseModel
         # @!attribute base_amount
         #   Amount in the lowest denomination of the `base_currency` to convert, often
-        #     called the "sell" amount.
+        #   called the "sell" amount.
         #
         #   @return [Integer]
         required :base_amount, Integer
@@ -129,7 +131,7 @@ module ModernTreasury
 
         # @!attribute exponent
         #   The exponent component of the rate. The decimal is calculated as `value` / (10 ^
-        #     `exponent`).
+        #   `exponent`).
         #
         #   @return [Integer]
         required :exponent, Integer
@@ -142,7 +144,7 @@ module ModernTreasury
 
         # @!attribute target_amount
         #   Amount in the lowest denomination of the `target_currency`, often called the
-        #     "buy" amount.
+        #   "buy" amount.
         #
         #   @return [Integer]
         required :target_amount, Integer
@@ -155,7 +157,7 @@ module ModernTreasury
 
         # @!attribute value
         #   The whole number component of the rate. The decimal is calculated as `value` /
-        #     (10 ^ `exponent`).
+        #   (10 ^ `exponent`).
         #
         #   @return [Integer]
         required :value, Integer
@@ -173,7 +175,7 @@ module ModernTreasury
         #   #
         #   def initialize(base_amount:, base_currency:, exponent:, rate_string:, target_amount:, target_currency:, value:, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
     end
   end

data/lib/modern_treasury/models/foreign_exchange_quote_create_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class ForeignExchangeQuoteCreateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::ForeignExchangeQuotes#create
+    class ForeignExchangeQuoteCreateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute internal_account_id
       #   The ID for the `InternalAccount` this quote is associated with.
@@ -21,7 +22,7 @@ module ModernTreasury
 
       # @!attribute [r] base_amount
       #   Amount in the lowest denomination of the `base_currency` to convert, often
-      #     called the "sell" amount.
+      #   called the "sell" amount.
       #
       #   @return [Integer, nil]
       optional :base_amount, Integer
@@ -52,7 +53,7 @@ module ModernTreasury
 
       # @!attribute [r] target_amount
       #   Amount in the lowest denomination of the `target_currency`, often called the
-      #     "buy" amount.
+      #   "buy" amount.
       #
       #   @return [Integer, nil]
       optional :target_amount, Integer
@@ -83,7 +84,7 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/foreign_exchange_quote_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class ForeignExchangeQuoteListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::ForeignExchangeQuotes#list
+    class ForeignExchangeQuoteListParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute after_cursor
       #
@@ -64,11 +65,11 @@ module ModernTreasury
 
       # @!attribute [r] metadata
       #   For example, if you want to query for records with metadata key `Type` and value
-      #     `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
-      #     parameters.
+      #   `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
+      #   parameters.
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :metadata, ModernTreasury::HashOf[String]
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!parse
       #   # @return [Hash{Symbol=>String}]
@@ -121,7 +122,7 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/foreign_exchange_quote_retrieve_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class ForeignExchangeQuoteRetrieveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::ForeignExchangeQuotes#retrieve
+    class ForeignExchangeQuoteRetrieveParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!parse
       #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
       #   #
       #   def initialize(request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end