snaptrade 1.17.10 → 2.0.77

data/lib/snaptrade/models/{target_asset.rb → account_universal_activity_option_symbol.rb}

@@ -5,36 +5,44 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Target percentage of a certain asset
-  class TargetAsset
+  # The option security for the transaction. The field is `null` if the transaction is not related to an option security (like a deposit, withdrawal, fee, etc). SnapTrade does a best effort to map the brokerage's option symbol. In cases where the brokerage option symbol is not recognized, the field will be set to `null`.
+  class AccountUniversalActivityOptionSymbol
+    # Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
     attr_accessor :id
 
-    attr_accessor :symbol
+    # 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
 
-    attr_accessor :percent
+    # The option strike price.
+    attr_accessor :strike_price
 
-    attr_accessor :is_supported
+    # The option expiration date.
+    attr_accessor :expiration_date
 
-    attr_accessor :is_excluded
+    # 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 :meta
+    attr_accessor :underlying_symbol
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
-        :'symbol' => :'symbol',
-        :'percent' => :'percent',
-        :'is_supported' => :'is_supported',
-        :'is_excluded' => :'is_excluded',
-        :'meta' => :'meta'
+        :'ticker' => :'ticker',
+        :'option_type' => :'option_type',
+        :'strike_price' => :'strike_price',
+        :'expiration_date' => :'expiration_date',
+        :'is_mini_option' => :'is_mini_option',
+        :'underlying_symbol' => :'underlying_symbol'
       }
     end
 
@@ -47,32 +55,39 @@ module SnapTrade
     def self.openapi_types
       {
         :'id' => :'String',
-        :'symbol' => :'UniversalSymbol',
-        :'percent' => :'Float',
-        :'is_supported' => :'Boolean',
-        :'is_excluded' => :'Boolean',
-        :'meta' => :'Hash<String, Object>'
+        :'ticker' => :'String',
+        :'option_type' => :'OptionType',
+        :'strike_price' => :'Float',
+        :'expiration_date' => :'Date',
+        :'is_mini_option' => :'Boolean',
+        :'underlying_symbol' => :'UnderlyingSymbol'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'meta'
       ])
     end
 
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'OptionsSymbol'
+      ]
+    end
+
     # Initializes the object
     # @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::TargetAsset` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::AccountUniversalActivityOptionSymbol` 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::TargetAsset`. 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::AccountUniversalActivityOptionSymbol`. 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
       }
@@ -81,26 +96,28 @@ module SnapTrade
         self.id = attributes[:'id']
       end
 
-      if attributes.key?(:'symbol')
-        self.symbol = attributes[:'symbol']
+      if attributes.key?(:'ticker')
+        self.ticker = attributes[:'ticker']
       end
 
-      if attributes.key?(:'percent')
-        self.percent = attributes[:'percent']
+      if attributes.key?(:'option_type')
+        self.option_type = attributes[:'option_type']
       end
 
-      if attributes.key?(:'is_supported')
-        self.is_supported = attributes[:'is_supported']
+      if attributes.key?(:'strike_price')
+        self.strike_price = attributes[:'strike_price']
       end
 
-      if attributes.key?(:'is_excluded')
-        self.is_excluded = attributes[:'is_excluded']
+      if attributes.key?(:'expiration_date')
+        self.expiration_date = attributes[:'expiration_date']
       end
 
-      if attributes.key?(:'meta')
-        if (value = attributes[:'meta']).is_a?(Hash)
-          self.meta = value
-        end
+      if attributes.key?(:'is_mini_option')
+        self.is_mini_option = attributes[:'is_mini_option']
+      end
+
+      if attributes.key?(:'underlying_symbol')
+        self.underlying_symbol = attributes[:'underlying_symbol']
       end
     end
 
@@ -108,12 +125,28 @@ module SnapTrade
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if !@percent.nil? && @percent > 100
-        invalid_properties.push('invalid value for "percent", must be smaller than or equal to 100.')
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @ticker.nil?
+        invalid_properties.push('invalid value for "ticker", ticker cannot be nil.')
+      end
+
+      if @option_type.nil?
+        invalid_properties.push('invalid value for "option_type", option_type cannot be nil.')
       end
 
-      if !@percent.nil? && @percent < 0
-        invalid_properties.push('invalid value for "percent", must be greater than or equal to 0.')
+      if @strike_price.nil?
+        invalid_properties.push('invalid value for "strike_price", strike_price cannot be nil.')
+      end
+
+      if @expiration_date.nil?
+        invalid_properties.push('invalid value for "expiration_date", expiration_date cannot be nil.')
+      end
+
+      if @underlying_symbol.nil?
+        invalid_properties.push('invalid value for "underlying_symbol", underlying_symbol cannot be nil.')
       end
 
       invalid_properties
@@ -122,36 +155,27 @@ module SnapTrade
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if !@percent.nil? && @percent > 100
-      return false if !@percent.nil? && @percent < 0
+      return false if @id.nil?
+      return false if @ticker.nil?
+      return false if @option_type.nil?
+      return false if @strike_price.nil?
+      return false if @expiration_date.nil?
+      return false if @underlying_symbol.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] percent Value to be assigned
-    def percent=(percent)
-      if !percent.nil? && percent > 100
-        fail ArgumentError, 'invalid value for "percent", must be smaller than or equal to 100.'
-      end
-
-      if !percent.nil? && percent < 0
-        fail ArgumentError, 'invalid value for "percent", must be greater than or equal to 0.'
-      end
-
-      @percent = percent
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          symbol == o.symbol &&
-          percent == o.percent &&
-          is_supported == o.is_supported &&
-          is_excluded == o.is_excluded &&
-          meta == o.meta
+          ticker == o.ticker &&
+          option_type == o.option_type &&
+          strike_price == o.strike_price &&
+          expiration_date == o.expiration_date &&
+          is_mini_option == o.is_mini_option &&
+          underlying_symbol == o.underlying_symbol
     end
 
     # @see the `==` method
@@ -163,7 +187,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, symbol, percent, is_supported, is_excluded, meta].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/{universal_symbol_ticker.rb → account_universal_activity_symbol.rb}

@@ -5,21 +5,24 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Universal symbol
-  class UniversalSymbolTicker
+  # The security for the transaction. The field is `null` if the transaction is not related to a security (like a deposit, withdrawal, fee, etc). SnapTrade does a best effort to map the brokerage's symbol. In cases where the brokerage symbol is not recognized, the field will be set to `null`.
+  class AccountUniversalActivitySymbol
+    # Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
     attr_accessor :id
 
+    # The security's trading ticker symbol. For example \"AAPL\" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix.
     attr_accessor :symbol
 
+    # The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is \"VAB.TO\", then `raw_symbol` is \"VAB\".
     attr_accessor :raw_symbol
 
+    # A human-readable description of the security. This is usually the company name or ETF name.
     attr_accessor :description
 
     attr_accessor :currency
@@ -28,7 +31,10 @@ module SnapTrade
 
     attr_accessor :type
 
-    attr_accessor :currencies
+    # This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. This value should be the same as the `figi_code` in the `figi_instrument` child property.
+    attr_accessor :figi_code
+
+    attr_accessor :figi_instrument
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -40,7 +46,8 @@ module SnapTrade
         :'currency' => :'currency',
         :'exchange' => :'exchange',
         :'type' => :'type',
-        :'currencies' => :'currencies'
+        :'figi_code' => :'figi_code',
+        :'figi_instrument' => :'figi_instrument'
       }
     end
 
@@ -56,30 +63,41 @@ module SnapTrade
         :'symbol' => :'String',
         :'raw_symbol' => :'String',
         :'description' => :'String',
-        :'currency' => :'Currency',
-        :'exchange' => :'Exchange',
+        :'currency' => :'SymbolCurrency',
+        :'exchange' => :'SymbolExchange',
         :'type' => :'SecurityType',
-        :'currencies' => :'Array<Currency>'
+        :'figi_code' => :'String',
+        :'figi_instrument' => :'SymbolFigiInstrument'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'description',
+        :'figi_code',
+        :'figi_instrument'
       ])
     end
 
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'Symbol'
+      ]
+    end
+
     # Initializes the object
     # @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::UniversalSymbolTicker` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::AccountUniversalActivitySymbol` 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::UniversalSymbolTicker`. 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::AccountUniversalActivitySymbol`. 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
       }
@@ -112,10 +130,12 @@ module SnapTrade
         self.type = attributes[:'type']
       end
 
-      if attributes.key?(:'currencies')
-        if (value = attributes[:'currencies']).is_a?(Array)
-          self.currencies = value
-        end
+      if attributes.key?(:'figi_code')
+        self.figi_code = attributes[:'figi_code']
+      end
+
+      if attributes.key?(:'figi_instrument')
+        self.figi_instrument = attributes[:'figi_instrument']
       end
     end
 
@@ -144,7 +164,8 @@ module SnapTrade
           currency == o.currency &&
           exchange == o.exchange &&
           type == o.type &&
-          currencies == o.currencies
+          figi_code == o.figi_code &&
+          figi_instrument == o.figi_instrument
     end
 
     # @see the `==` method
@@ -156,7 +177,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, symbol, raw_symbol, description, currency, exchange, type, currencies].hash
+      [id, symbol, raw_symbol, description, currency, exchange, type, figi_code, figi_instrument].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/{trade_action.rb → action_strict.rb}

@@ -5,14 +5,13 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  class TradeAction
+  class ActionStrict
     BUY = "BUY".freeze
     SELL = "SELL".freeze
 
@@ -31,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 TradeAction.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #TradeAction"
+      return value if ActionStrict.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #ActionStrict"
     end
   end
 end

data/lib/snaptrade/models/{trade_execution_status_action.rb → action_strict_with_options.rb}

@@ -5,19 +5,22 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  class TradeExecutionStatusAction
+  class ActionStrictWithOptions
     BUY = "BUY".freeze
     SELL = "SELL".freeze
+    BUY_TO_OPEN = "BUY_TO_OPEN".freeze
+    BUY_TO_CLOSE = "BUY_TO_CLOSE".freeze
+    SELL_TO_OPEN = "SELL_TO_OPEN".freeze
+    SELL_TO_CLOSE = "SELL_TO_CLOSE".freeze
 
     def self.all_vars
-      @all_vars ||= [BUY, SELL].freeze
+      @all_vars ||= [BUY, SELL, BUY_TO_OPEN, BUY_TO_CLOSE, SELL_TO_OPEN, SELL_TO_CLOSE].freeze
     end
 
     # Builds the enum from string
@@ -31,8 +34,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 TradeExecutionStatusAction.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #TradeExecutionStatusAction"
+      return value if ActionStrictWithOptions.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #ActionStrictWithOptions"
     end
   end
 end

data/lib/snaptrade/models/auth_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/authentication_login_snap_trade_user200_response.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/balance.rb

@@ -5,24 +5,28 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Account Balance
+  # Holds balance information for a single currency in an account.
   class Balance
     attr_accessor :currency
 
+    # The amount of available cash in the account denominated in the currency of the `currency` field.
     attr_accessor :cash
 
+    # Buying power only applies to margin accounts. For non-margin accounts, buying power should be the same as cash. Please note that this field is not always available for all brokerages.
+    attr_accessor :buying_power
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'currency' => :'currency',
-        :'cash' => :'cash'
+        :'cash' => :'cash',
+        :'buying_power' => :'buying_power'
       }
     end
 
@@ -34,15 +38,17 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'currency' => :'Currency',
-        :'cash' => :'Float'
+        :'currency' => :'BalanceCurrency',
+        :'cash' => :'Float',
+        :'buying_power' => :'Float'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'cash'
+        :'cash',
+        :'buying_power'
       ])
     end
 
@@ -68,6 +74,10 @@ module SnapTrade
       if attributes.key?(:'cash')
         self.cash = attributes[:'cash']
       end
+
+      if attributes.key?(:'buying_power')
+        self.buying_power = attributes[:'buying_power']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -89,7 +99,8 @@ module SnapTrade
       return true if self.equal?(o)
       self.class == o.class &&
           currency == o.currency &&
-          cash == o.cash
+          cash == o.cash &&
+          buying_power == o.buying_power
     end
 
     # @see the `==` method
@@ -101,7 +112,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [currency, cash].hash
+      [currency, cash, buying_power].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/{model_portfolio.rb → balance_currency.rb}

@@ -5,26 +5,29 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  class ModelPortfolio
+  # The currency of the balance. This applies to both `cash` and `buying_power`.
+  class BalanceCurrency
+    # Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
     attr_accessor :id
 
-    attr_accessor :name
+    # The ISO-4217 currency code for the currency.
+    attr_accessor :code
 
-    attr_accessor :model_type
+    # A human-friendly name of the currency.
+    attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
-        :'name' => :'name',
-        :'model_type' => :'model_type'
+        :'code' => :'code',
+        :'name' => :'name'
       }
     end
 
@@ -37,8 +40,8 @@ module SnapTrade
     def self.openapi_types
       {
         :'id' => :'String',
-        :'name' => :'String',
-        :'model_type' => :'ModelType'
+        :'code' => :'String',
+        :'name' => :'String'
       }
     end
 
@@ -48,17 +51,24 @@ module SnapTrade
       ])
     end
 
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'Currency'
+      ]
+    end
+
     # Initializes the object
     # @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::ModelPortfolio` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::BalanceCurrency` 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::ModelPortfolio`. 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::BalanceCurrency`. 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
       }
@@ -67,14 +77,12 @@ module SnapTrade
         self.id = attributes[:'id']
       end
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
       end
 
-      if attributes.key?(:'model_type')
-        self.model_type = attributes[:'model_type']
-      else
-        self.model_type = ModelType::NMINUS_1
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
       end
     end
 
@@ -97,8 +105,8 @@ module SnapTrade
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          name == o.name &&
-          model_type == o.model_type
+          code == o.code &&
+          name == o.name
     end
 
     # @see the `==` method
@@ -110,7 +118,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, model_type].hash
+      [id, code, name].hash
     end
 
     # Builds the object from hash