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

data/lib/modern_treasury/models/foreign_exchange_quote.rb

@@ -38,7 +38,7 @@ module ModernTreasury
       #   The serialized rate information represented by this quote.
       #
       #   @return [ModernTreasury::Models::ForeignExchangeQuote::ForeignExchangeRate]
-      required :foreign_exchange_rate, -> { ModernTreasury::Models::ForeignExchangeQuote::ForeignExchangeRate }
+      required :foreign_exchange_rate, -> { ModernTreasury::ForeignExchangeQuote::ForeignExchangeRate }
 
       # @!attribute internal_account_id
       #   The ID for the `InternalAccount` this quote is associated with.
@@ -70,49 +70,39 @@ module ModernTreasury
       #   @return [Time]
       required :updated_at, Time
 
-      # @!attribute [r] vendor_id
+      # @!attribute vendor_id
       #   This vendor assigned ID for this quote.
       #
       #   @return [String, nil]
       optional :vendor_id, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :vendor_id
-
-      # @!parse
-      #   # @param id [String]
-      #   # @param created_at [Time]
-      #   # @param effective_at [Time]
-      #   # @param expires_at [Time]
-      #   # @param foreign_exchange_indicator [String]
-      #   # @param foreign_exchange_rate [ModernTreasury::Models::ForeignExchangeQuote::ForeignExchangeRate]
-      #   # @param internal_account_id [String]
-      #   # @param live_mode [Boolean]
-      #   # @param metadata [Hash{Symbol=>String}]
-      #   # @param object [String]
-      #   # @param updated_at [Time]
-      #   # @param vendor_id [String]
-      #   #
-      #   def initialize(
-      #     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,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(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)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::ForeignExchangeQuote} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param created_at [Time]
+      #
+      #   @param effective_at [Time] The timestamp until when the quoted rate is valid.
+      #
+      #   @param expires_at [Time] The timestamp until which the quote must be booked by.
+      #
+      #   @param foreign_exchange_indicator [String] Either `fixed_to_variable` if the `base_amount` was specified, or `variable_to_f
+      #
+      #   @param foreign_exchange_rate [ModernTreasury::Models::ForeignExchangeQuote::ForeignExchangeRate] The serialized rate information represented by this quote.
+      #
+      #   @param internal_account_id [String] The ID for the `InternalAccount` this quote is associated with.
+      #
+      #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+      #
+      #   @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+      #
+      #   @param object [String]
+      #
+      #   @param updated_at [Time]
+      #
+      #   @param vendor_id [String] This vendor assigned ID for this quote.
 
       # @see ModernTreasury::Models::ForeignExchangeQuote#foreign_exchange_rate
       class ForeignExchangeRate < ModernTreasury::Internal::Type::BaseModel
@@ -127,7 +117,7 @@ module ModernTreasury
         #   Currency to convert, often called the "sell" currency.
         #
         #   @return [Symbol, ModernTreasury::Models::Currency]
-        required :base_currency, enum: -> { ModernTreasury::Models::Currency }
+        required :base_currency, enum: -> { ModernTreasury::Currency }
 
         # @!attribute exponent
         #   The exponent component of the rate. The decimal is calculated as `value` / (10 ^
@@ -153,7 +143,7 @@ module ModernTreasury
         #   Currency to convert the `base_currency` to, often called the "buy" currency.
         #
         #   @return [Symbol, ModernTreasury::Models::Currency]
-        required :target_currency, enum: -> { ModernTreasury::Models::Currency }
+        required :target_currency, enum: -> { ModernTreasury::Currency }
 
         # @!attribute value
         #   The whole number component of the rate. The decimal is calculated as `value` /
@@ -162,20 +152,26 @@ module ModernTreasury
         #   @return [Integer]
         required :value, Integer
 
-        # @!parse
-        #   # The serialized rate information represented by this quote.
-        #   #
-        #   # @param base_amount [Integer]
-        #   # @param base_currency [Symbol, ModernTreasury::Models::Currency]
-        #   # @param exponent [Integer]
-        #   # @param rate_string [String]
-        #   # @param target_amount [Integer]
-        #   # @param target_currency [Symbol, ModernTreasury::Models::Currency]
-        #   # @param value [Integer]
-        #   #
-        #   def initialize(base_amount:, base_currency:, exponent:, rate_string:, target_amount:, target_currency:, value:, **) = super
-
-        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+        # @!method initialize(base_amount:, base_currency:, exponent:, rate_string:, target_amount:, target_currency:, value:)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::ForeignExchangeQuote::ForeignExchangeRate} for more
+        #   details.
+        #
+        #   The serialized rate information represented by this quote.
+        #
+        #   @param base_amount [Integer] Amount in the lowest denomination of the `base_currency` to convert, often calle
+        #
+        #   @param base_currency [Symbol, ModernTreasury::Models::Currency] Currency to convert, often called the "sell" currency.
+        #
+        #   @param exponent [Integer] The exponent component of the rate. The decimal is calculated as `value` / (10 ^
+        #
+        #   @param rate_string [String] A string representation of the rate.
+        #
+        #   @param target_amount [Integer] Amount in the lowest denomination of the `target_currency`, often called the "bu
+        #
+        #   @param target_currency [Symbol, ModernTreasury::Models::Currency] Currency to convert the `base_currency` to, often called the "buy" currency.
+        #
+        #   @param value [Integer] The whole number component of the rate. The decimal is calculated as `value` / (
       end
     end
   end

data/lib/modern_treasury/models/foreign_exchange_quote_create_params.rb

@@ -4,8 +4,7 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::ForeignExchangeQuotes#create
     class ForeignExchangeQuoteCreateParams < ModernTreasury::Internal::Type::BaseModel
-      # @!parse
-      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute internal_account_id
@@ -18,73 +17,51 @@ module ModernTreasury
       #   Currency to convert the `base_currency` to, often called the "buy" currency.
       #
       #   @return [Symbol, ModernTreasury::Models::Currency]
-      required :target_currency, enum: -> { ModernTreasury::Models::Currency }
+      required :target_currency, enum: -> { ModernTreasury::Currency }
 
-      # @!attribute [r] base_amount
+      # @!attribute base_amount
       #   Amount in the lowest denomination of the `base_currency` to convert, often
       #   called the "sell" amount.
       #
       #   @return [Integer, nil]
       optional :base_amount, Integer
 
-      # @!parse
-      #   # @return [Integer]
-      #   attr_writer :base_amount
-
-      # @!attribute [r] base_currency
+      # @!attribute base_currency
       #   Currency to convert, often called the "sell" currency.
       #
       #   @return [Symbol, ModernTreasury::Models::Currency, nil]
-      optional :base_currency, enum: -> { ModernTreasury::Models::Currency }
-
-      # @!parse
-      #   # @return [Symbol, ModernTreasury::Models::Currency]
-      #   attr_writer :base_currency
+      optional :base_currency, enum: -> { ModernTreasury::Currency }
 
-      # @!attribute [r] effective_at
+      # @!attribute effective_at
       #   The timestamp until when the quoted rate is valid.
       #
       #   @return [Time, nil]
       optional :effective_at, Time
 
-      # @!parse
-      #   # @return [Time]
-      #   attr_writer :effective_at
-
-      # @!attribute [r] target_amount
+      # @!attribute target_amount
       #   Amount in the lowest denomination of the `target_currency`, often called the
       #   "buy" amount.
       #
       #   @return [Integer, nil]
       optional :target_amount, Integer
 
-      # @!parse
-      #   # @return [Integer]
-      #   attr_writer :target_amount
-
-      # @!parse
-      #   # @param internal_account_id [String]
-      #   # @param target_currency [Symbol, ModernTreasury::Models::Currency]
-      #   # @param base_amount [Integer]
-      #   # @param base_currency [Symbol, ModernTreasury::Models::Currency]
-      #   # @param effective_at [Time]
-      #   # @param target_amount [Integer]
-      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(
-      #     internal_account_id:,
-      #     target_currency:,
-      #     base_amount: nil,
-      #     base_currency: nil,
-      #     effective_at: nil,
-      #     target_amount: nil,
-      #     request_options: {},
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(internal_account_id:, target_currency:, base_amount: nil, base_currency: nil, effective_at: nil, target_amount: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::ForeignExchangeQuoteCreateParams} for more details.
+      #
+      #   @param internal_account_id [String] The ID for the `InternalAccount` this quote is associated with.
+      #
+      #   @param target_currency [Symbol, ModernTreasury::Models::Currency] Currency to convert the `base_currency` to, often called the "buy" currency.
+      #
+      #   @param base_amount [Integer] Amount in the lowest denomination of the `base_currency` to convert, often calle
+      #
+      #   @param base_currency [Symbol, ModernTreasury::Models::Currency] Currency to convert, often called the "sell" currency.
+      #
+      #   @param effective_at [Time] The timestamp until when the quoted rate is valid.
+      #
+      #   @param target_amount [Integer] Amount in the lowest denomination of the `target_currency`, often called the "bu
+      #
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/modern_treasury/models/foreign_exchange_quote_list_params.rb

@@ -4,8 +4,7 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::ForeignExchangeQuotes#list
     class ForeignExchangeQuoteListParams < ModernTreasury::Internal::Type::BaseModel
-      # @!parse
-      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute after_cursor
@@ -13,57 +12,37 @@ module ModernTreasury
       #   @return [String, nil]
       optional :after_cursor, String, nil?: true
 
-      # @!attribute [r] base_currency
+      # @!attribute base_currency
       #   Currency to convert, often called the "sell" currency.
       #
       #   @return [String, nil]
       optional :base_currency, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :base_currency
-
-      # @!attribute [r] effective_at_end
+      # @!attribute effective_at_end
       #   An inclusive upper bound for searching effective_at
       #
       #   @return [Date, nil]
       optional :effective_at_end, Date
 
-      # @!parse
-      #   # @return [Date]
-      #   attr_writer :effective_at_end
-
-      # @!attribute [r] effective_at_start
+      # @!attribute effective_at_start
       #   An inclusive lower bound for searching effective_at
       #
       #   @return [Date, nil]
       optional :effective_at_start, Date
 
-      # @!parse
-      #   # @return [Date]
-      #   attr_writer :effective_at_start
-
-      # @!attribute [r] expires_at
+      # @!attribute expires_at
       #   The timestamp until which the quote must be booked by.
       #
       #   @return [Time, nil]
       optional :expires_at, Time
 
-      # @!parse
-      #   # @return [Time]
-      #   attr_writer :expires_at
-
-      # @!attribute [r] internal_account_id
+      # @!attribute internal_account_id
       #   The ID for the `InternalAccount` this quote is associated with.
       #
       #   @return [String, nil]
       optional :internal_account_id, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :internal_account_id
-
-      # @!attribute [r] metadata
+      # @!attribute 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.
@@ -71,58 +50,40 @@ module ModernTreasury
       #   @return [Hash{Symbol=>String}, nil]
       optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
-      # @!parse
-      #   # @return [Hash{Symbol=>String}]
-      #   attr_writer :metadata
-
-      # @!attribute [r] per_page
+      # @!attribute per_page
       #
       #   @return [Integer, nil]
       optional :per_page, Integer
 
-      # @!parse
-      #   # @return [Integer]
-      #   attr_writer :per_page
-
-      # @!attribute [r] target_currency
+      # @!attribute target_currency
       #   Currency to convert the `base_currency` to, often called the "buy" currency.
       #
       #   @return [String, nil]
       optional :target_currency, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :target_currency
-
-      # @!parse
-      #   # @param after_cursor [String, nil]
-      #   # @param base_currency [String]
-      #   # @param effective_at_end [Date]
-      #   # @param effective_at_start [Date]
-      #   # @param expires_at [Time]
-      #   # @param internal_account_id [String]
-      #   # @param metadata [Hash{Symbol=>String}]
-      #   # @param per_page [Integer]
-      #   # @param target_currency [String]
-      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(
-      #     after_cursor: nil,
-      #     base_currency: nil,
-      #     effective_at_end: nil,
-      #     effective_at_start: nil,
-      #     expires_at: nil,
-      #     internal_account_id: nil,
-      #     metadata: nil,
-      #     per_page: nil,
-      #     target_currency: nil,
-      #     request_options: {},
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(after_cursor: nil, base_currency: nil, effective_at_end: nil, effective_at_start: nil, expires_at: nil, internal_account_id: nil, metadata: nil, per_page: nil, target_currency: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::ForeignExchangeQuoteListParams} for more details.
+      #
+      #   @param after_cursor [String, nil]
+      #
+      #   @param base_currency [String] Currency to convert, often called the "sell" currency.
+      #
+      #   @param effective_at_end [Date] An inclusive upper bound for searching effective_at
+      #
+      #   @param effective_at_start [Date] An inclusive lower bound for searching effective_at
+      #
+      #   @param expires_at [Time] The timestamp until which the quote must be booked by.
+      #
+      #   @param internal_account_id [String] The ID for the `InternalAccount` this quote is associated with.
+      #
+      #   @param metadata [Hash{Symbol=>String}] For example, if you want to query for records with metadata key `Type` and value
+      #
+      #   @param per_page [Integer]
+      #
+      #   @param target_currency [String] Currency to convert the `base_currency` to, often called the "buy" currency.
+      #
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/modern_treasury/models/foreign_exchange_quote_retrieve_params.rb

@@ -4,16 +4,11 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::ForeignExchangeQuotes#retrieve
     class ForeignExchangeQuoteRetrieveParams < ModernTreasury::Internal::Type::BaseModel
-      # @!parse
-      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      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::Internal::Type::BaseModel) -> void
+      # @!method initialize(request_options: {})
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end