snaptrade 1.17.10 → 2.0.77

data/lib/snaptrade/models/net_contributions.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
@@ -13,7 +12,7 @@ require 'time'
 
 module SnapTrade
   class NetContributions
-    # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
+    # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
     attr_accessor :date
 
     attr_accessor :contributions

data/lib/snaptrade/models/net_dividend.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/notional_value.rb

@@ -0,0 +1,103 @@
+=begin
+#SnapTrade
+
+#Connect brokerage accounts to your app for live positions and trading
+
+The version of the OpenAPI document: 1.0.0
+Contact: api@snaptrade.com
+=end
+
+require 'date'
+require 'time'
+
+module SnapTrade
+  # Total notional amount for the order. Must be `null` if `units` is provided. Can only work with `Market` for `order_type` and `Day` for `time_in_force`. This is only available for certain brokerages. Please check the [integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=e7bbcbf9f272441593f93decde660687) for more information.
+  module NotionalValue
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'Float',
+          :'String'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_one_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.parse(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = SnapTrade.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_one_of) # nested oneOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise unless (data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model && model.valid?
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end

data/lib/snaptrade/models/{options_holdings.rb → option_brokerage_symbol.rb}

@@ -5,39 +5,28 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Option Holdings
-  class OptionsHoldings
-    # Options information
-    attr_accessor :id
-
-    attr_accessor :symbol
-
+  # Uniquely describes a security for the option position within an account. The distinction between this and the `option_symbol` child property is that this object is specific to a position within an account, while the `option_symbol` child property is universal across all brokerage accounts. The caller should rely on the `option_symbol` child property for most use cases.
+  class OptionBrokerageSymbol
     attr_accessor :option_symbol
 
-    # Trade Price if limit or stop limit order
-    attr_accessor :price
-
-    attr_accessor :currency
+    # A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change.
+    attr_accessor :id
 
-    # Average purchase price for this position
-    attr_accessor :average_purchase_price
+    # This field is deprecated and the caller should use the `option_symbol` child property's `description` instead.
+    attr_accessor :description
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'symbol' => :'symbol',
         :'option_symbol' => :'option_symbol',
-        :'price' => :'price',
-        :'currency' => :'currency',
-        :'average_purchase_price' => :'average_purchase_price'
+        :'id' => :'id',
+        :'description' => :'description'
       }
     end
 
@@ -49,20 +38,15 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id' => :'String',
-        :'symbol' => :'String',
         :'option_symbol' => :'OptionsSymbol',
-        :'price' => :'Float',
-        :'currency' => :'Currency',
-        :'average_purchase_price' => :'Float'
+        :'id' => :'String',
+        :'description' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'price',
-        :'average_purchase_price'
       ])
     end
 
@@ -70,39 +54,27 @@ module SnapTrade
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::OptionsHoldings` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::OptionBrokerageSymbol` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::OptionsHoldings`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::OptionBrokerageSymbol`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'id')
-        self.id = attributes[:'id']
-      end
-
-      if attributes.key?(:'symbol')
-        self.symbol = attributes[:'symbol']
-      end
-
       if attributes.key?(:'option_symbol')
         self.option_symbol = attributes[:'option_symbol']
       end
 
-      if attributes.key?(:'price')
-        self.price = attributes[:'price']
-      end
-
-      if attributes.key?(:'currency')
-        self.currency = attributes[:'currency']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       end
 
-      if attributes.key?(:'average_purchase_price')
-        self.average_purchase_price = attributes[:'average_purchase_price']
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
       end
     end
 
@@ -124,12 +96,9 @@ module SnapTrade
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
-          symbol == o.symbol &&
           option_symbol == o.option_symbol &&
-          price == o.price &&
-          currency == o.currency &&
-          average_purchase_price == o.average_purchase_price
+          id == o.id &&
+          description == o.description
     end
 
     # @see the `==` method
@@ -141,7 +110,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, symbol, option_symbol, price, currency, average_purchase_price].hash
+      [option_symbol, id, description].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/option_chain_inner.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/option_leg.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/option_leg_action.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/option_strategy.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/option_strategy_legs_inner.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/option_type.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/options_get_option_strategy_request.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/options_place_option_strategy_request.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
@@ -13,8 +12,10 @@ require 'time'
 
 module SnapTrade
   class OptionsPlaceOptionStrategyRequest
+    # The type of order to place.  - For `Limit` and `StopLimit` orders, the `price` field is required. - For `Stop` and `StopLimit` orders, the `stop` field is required. 
     attr_accessor :order_type
 
+    # The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values:   - `Day` - Day. The order is valid only for the trading day on which it is placed.   - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.   - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. 
     attr_accessor :time_in_force
 
     # Trade Price if limit or stop limit order
@@ -37,8 +38,8 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'order_type' => :'OrderType',
-        :'time_in_force' => :'TimeInForce',
+        :'order_type' => :'OrderTypeStrict',
+        :'time_in_force' => :'TimeInForceStrict',
         :'price' => :'Float'
       }
     end

data/lib/snaptrade/models/options_position.rb

@@ -5,35 +5,35 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Option Holdings
+  # Describes a single option position in an account.
   class OptionsPosition
     attr_accessor :symbol
 
-    # Trade Price if limit or stop limit order
+    # Last known market price _per share_ of the option contract. The freshness of this price depends on the brokerage. Some brokerages provide real-time prices, while others provide delayed prices. It is recommended that you rely on your own third-party market data provider for most up to date prices.
     attr_accessor :price
 
+    # The number of contracts for this option position. A positive number indicates a long position, while a negative number indicates a short position.
     attr_accessor :units
 
-    attr_accessor :currency
-
-    # Average purchase price for this position
+    # Cost basis _per contract_ of this option position. To get the cost basis _per share_, divide this value by the number of shares per contract (usually 100).
     attr_accessor :average_purchase_price
 
+    attr_accessor :currency
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'symbol' => :'symbol',
         :'price' => :'price',
         :'units' => :'units',
-        :'currency' => :'currency',
-        :'average_purchase_price' => :'average_purchase_price'
+        :'average_purchase_price' => :'average_purchase_price',
+        :'currency' => :'currency'
       }
     end
 
@@ -45,11 +45,11 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'symbol' => :'BrokerageSymbol',
+        :'symbol' => :'OptionBrokerageSymbol',
         :'price' => :'Float',
         :'units' => :'Float',
-        :'currency' => :'OptionsPositionCurrency',
-        :'average_purchase_price' => :'Float'
+        :'average_purchase_price' => :'Float',
+        :'currency' => :'OptionsPositionCurrency'
       }
     end
 
@@ -57,8 +57,8 @@ module SnapTrade
     def self.openapi_nullable
       Set.new([
         :'price',
-        :'currency',
-        :'average_purchase_price'
+        :'average_purchase_price',
+        :'currency'
       ])
     end
 
@@ -89,13 +89,13 @@ module SnapTrade
         self.units = attributes[:'units']
       end
 
-      if attributes.key?(:'currency')
-        self.currency = attributes[:'currency']
-      end
-
       if attributes.key?(:'average_purchase_price')
         self.average_purchase_price = attributes[:'average_purchase_price']
       end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -119,8 +119,8 @@ module SnapTrade
           symbol == o.symbol &&
           price == o.price &&
           units == o.units &&
-          currency == o.currency &&
-          average_purchase_price == o.average_purchase_price
+          average_purchase_price == o.average_purchase_price &&
+          currency == o.currency
     end
 
     # @see the `==` method
@@ -132,7 +132,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [symbol, price, units, currency, average_purchase_price].hash
+      [symbol, price, units, average_purchase_price, currency].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/options_position_currency.rb

@@ -5,18 +5,21 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
+  # The currency of the price. This field is deprecated and will be removed in a future version. The currency of the price is determined by the currency of the underlying security.
   class OptionsPositionCurrency
+    # Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
     attr_accessor :id
 
+    # The ISO-4217 currency code for the currency.
     attr_accessor :code
 
+    # A human-friendly name of the currency.
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/options_symbol.rb

@@ -5,33 +5,34 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Options Symbol
+  # Uniquely describes an option security + exchange combination across all brokerages.
   class OptionsSymbol
+    # Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
     attr_accessor :id
 
+    # The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option.
     attr_accessor :ticker
 
+    # The type of option. Either \"CALL\" or \"PUT\".
     attr_accessor :option_type
 
+    # The option strike price.
     attr_accessor :strike_price
 
+    # The option expiration date.
     attr_accessor :expiration_date
 
+    # Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100.
     attr_accessor :is_mini_option
 
     attr_accessor :underlying_symbol
 
-    attr_accessor :local_id
-
-    attr_accessor :exchange_id
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -41,9 +42,7 @@ module SnapTrade
         :'strike_price' => :'strike_price',
         :'expiration_date' => :'expiration_date',
         :'is_mini_option' => :'is_mini_option',
-        :'underlying_symbol' => :'underlying_symbol',
-        :'local_id' => :'local_id',
-        :'exchange_id' => :'exchange_id'
+        :'underlying_symbol' => :'underlying_symbol'
       }
     end
 
@@ -59,11 +58,9 @@ module SnapTrade
         :'ticker' => :'String',
         :'option_type' => :'OptionType',
         :'strike_price' => :'Float',
-        :'expiration_date' => :'String',
+        :'expiration_date' => :'Date',
         :'is_mini_option' => :'Boolean',
-        :'underlying_symbol' => :'UnderlyingSymbol',
-        :'local_id' => :'String',
-        :'exchange_id' => :'String'
+        :'underlying_symbol' => :'UnderlyingSymbol'
       }
     end
 
@@ -115,14 +112,6 @@ module SnapTrade
       if attributes.key?(:'underlying_symbol')
         self.underlying_symbol = attributes[:'underlying_symbol']
       end
-
-      if attributes.key?(:'local_id')
-        self.local_id = attributes[:'local_id']
-      end
-
-      if attributes.key?(:'exchange_id')
-        self.exchange_id = attributes[:'exchange_id']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -179,9 +168,7 @@ module SnapTrade
           strike_price == o.strike_price &&
           expiration_date == o.expiration_date &&
           is_mini_option == o.is_mini_option &&
-          underlying_symbol == o.underlying_symbol &&
-          local_id == o.local_id &&
-          exchange_id == o.exchange_id
+          underlying_symbol == o.underlying_symbol
     end
 
     # @see the `==` method
@@ -193,7 +180,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, ticker, option_type, strike_price, expiration_date, is_mini_option, underlying_symbol, local_id, exchange_id].hash
+      [id, ticker, option_type, strike_price, expiration_date, is_mini_option, underlying_symbol].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/{model_type.rb → order_class.rb}

@@ -5,20 +5,18 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  class ModelType
-    NMINUS_1 = -1.freeze
-    N0 = 0.freeze
-    N1 = 1.freeze
+  class OrderClass
+    SIMPLE = "SIMPLE".freeze
+    BRACKET = "BRACKET".freeze
 
     def self.all_vars
-      @all_vars ||= [NMINUS_1, N0, N1].freeze
+      @all_vars ||= [SIMPLE, BRACKET].freeze
     end
 
     # Builds the enum from string
@@ -32,8 +30,8 @@ module SnapTrade
     # @param [String] The enum value in the form of the string
     # @return [String] The enum value
     def build_from_hash(value)
-      return value if ModelType.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #ModelType"
+      return value if OrderClass.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #OrderClass"
     end
   end
 end