snaptrade 1.17.10 → 2.0.77

data/lib/snaptrade/models/symbol_exchange.rb

@@ -0,0 +1,296 @@
+=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
+  # The exchange on which the security is listed and traded.
+  class SymbolExchange
+    # Unique ID for the exchange in SnapTrade.
+    attr_accessor :id
+
+    # A short name for the exchange. For standardized exchange code, please us the `mic_code` field.
+    attr_accessor :code
+
+    # The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange.
+    attr_accessor :mic_code
+
+    # The full name of the exchange.
+    attr_accessor :name
+
+    # The timezone for the trading hours (`start_time` and `close_time`) of the exchange.
+    attr_accessor :timezone
+
+    # The time when the exchange opens for trading.
+    attr_accessor :start_time
+
+    # The time when the exchange closes for trading.
+    attr_accessor :close_time
+
+    # The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail.
+    attr_accessor :suffix
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'code' => :'code',
+        :'mic_code' => :'mic_code',
+        :'name' => :'name',
+        :'timezone' => :'timezone',
+        :'start_time' => :'start_time',
+        :'close_time' => :'close_time',
+        :'suffix' => :'suffix'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'code' => :'String',
+        :'mic_code' => :'String',
+        :'name' => :'String',
+        :'timezone' => :'String',
+        :'start_time' => :'String',
+        :'close_time' => :'String',
+        :'suffix' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'suffix'
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'Exchange'
+      ]
+    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::SymbolExchange` 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::SymbolExchange`. 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?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.key?(:'mic_code')
+        self.mic_code = attributes[:'mic_code']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'timezone')
+        self.timezone = attributes[:'timezone']
+      end
+
+      if attributes.key?(:'start_time')
+        self.start_time = attributes[:'start_time']
+      end
+
+      if attributes.key?(:'close_time')
+        self.close_time = attributes[:'close_time']
+      end
+
+      if attributes.key?(:'suffix')
+        self.suffix = attributes[:'suffix']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    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 &&
+          code == o.code &&
+          mic_code == o.mic_code &&
+          name == o.name &&
+          timezone == o.timezone &&
+          start_time == o.start_time &&
+          close_time == o.close_time &&
+          suffix == o.suffix
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, code, mic_code, name, timezone, start_time, close_time, suffix].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = SnapTrade.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/snaptrade/models/{model_portfolio_security.rb → symbol_figi_instrument.rb}

@@ -5,23 +5,24 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  class ModelPortfolioSecurity
-    attr_accessor :symbol
+  class SymbolFigiInstrument
+    # 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.
+    attr_accessor :figi_code
 
-    attr_accessor :percent
+    # This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information.
+    attr_accessor :figi_share_class
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'symbol' => :'symbol',
-        :'percent' => :'percent'
+        :'figi_code' => :'figi_code',
+        :'figi_share_class' => :'figi_share_class'
       }
     end
 
@@ -33,38 +34,47 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'symbol' => :'UniversalSymbol',
-        :'percent' => :'Integer'
+        :'figi_code' => :'String',
+        :'figi_share_class' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'figi_code',
+        :'figi_share_class'
       ])
     end
 
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'FigiInstrument'
+      ]
+    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::ModelPortfolioSecurity` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::SymbolFigiInstrument` 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::ModelPortfolioSecurity`. 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::SymbolFigiInstrument`. 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?(:'symbol')
-        self.symbol = attributes[:'symbol']
+      if attributes.key?(:'figi_code')
+        self.figi_code = attributes[:'figi_code']
       end
 
-      if attributes.key?(:'percent')
-        self.percent = attributes[:'percent']
+      if attributes.key?(:'figi_share_class')
+        self.figi_share_class = attributes[:'figi_share_class']
       end
     end
 
@@ -72,46 +82,22 @@ 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.')
-      end
-
-      if !@percent.nil? && @percent < 0
-        invalid_properties.push('invalid value for "percent", must be greater than or equal to 0.')
-      end
-
       invalid_properties
     end
 
     # 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
       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 &&
-          symbol == o.symbol &&
-          percent == o.percent
+          figi_code == o.figi_code &&
+          figi_share_class == o.figi_share_class
     end
 
     # @see the `==` method
@@ -123,7 +109,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [symbol, percent].hash
+      [figi_code, figi_share_class].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/symbol_query.rb

@@ -5,15 +5,14 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Symbol query for searching for symbols
   class SymbolQuery
+    # The search query for symbols.
     attr_accessor :substring
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/symbols_quotes_inner.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
@@ -15,23 +14,28 @@ module SnapTrade
   class SymbolsQuotesInner
     attr_accessor :symbol
 
+    # The most recent trade price from the brokerage.
+    attr_accessor :last_trade_price
+
+    # The most recent bid price from the brokerage.
     attr_accessor :bid_price
 
+    # The most recent price from the brokerage.
     attr_accessor :ask_price
 
-    attr_accessor :last_trade_price
-
+    # The most recent bid size from the brokerage.
     attr_accessor :bid_size
 
+    # The most recent ask size from the brokerage.
     attr_accessor :ask_size
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'symbol' => :'symbol',
+        :'last_trade_price' => :'last_trade_price',
         :'bid_price' => :'bid_price',
         :'ask_price' => :'ask_price',
-        :'last_trade_price' => :'last_trade_price',
         :'bid_size' => :'bid_size',
         :'ask_size' => :'ask_size'
       }
@@ -46,9 +50,9 @@ module SnapTrade
     def self.openapi_types
       {
         :'symbol' => :'UniversalSymbol',
+        :'last_trade_price' => :'Float',
         :'bid_price' => :'Float',
         :'ask_price' => :'Float',
-        :'last_trade_price' => :'Float',
         :'bid_size' => :'Float',
         :'ask_size' => :'Float'
       }
@@ -79,6 +83,10 @@ module SnapTrade
         self.symbol = attributes[:'symbol']
       end
 
+      if attributes.key?(:'last_trade_price')
+        self.last_trade_price = attributes[:'last_trade_price']
+      end
+
       if attributes.key?(:'bid_price')
         self.bid_price = attributes[:'bid_price']
       end
@@ -87,10 +95,6 @@ module SnapTrade
         self.ask_price = attributes[:'ask_price']
       end
 
-      if attributes.key?(:'last_trade_price')
-        self.last_trade_price = attributes[:'last_trade_price']
-      end
-
       if attributes.key?(:'bid_size')
         self.bid_size = attributes[:'bid_size']
       end
@@ -119,9 +123,9 @@ module SnapTrade
       return true if self.equal?(o)
       self.class == o.class &&
           symbol == o.symbol &&
+          last_trade_price == o.last_trade_price &&
           bid_price == o.bid_price &&
           ask_price == o.ask_price &&
-          last_trade_price == o.last_trade_price &&
           bid_size == o.bid_size &&
           ask_size == o.ask_size
     end
@@ -135,7 +139,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [symbol, bid_price, ask_price, last_trade_price, bid_size, ask_size].hash
+      [symbol, last_trade_price, bid_price, ask_price, bid_size, ask_size].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/{excluded_asset.rb → take_profit.rb}

@@ -5,21 +5,20 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # An excluded asset in a portfolio group
-  class ExcludedAsset
-    attr_accessor :symbol
+  # Details of the take profit order. Only to be used when order_class = BRACKET.
+  class TakeProfit
+    attr_accessor :limit_price
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'symbol' => :'symbol'
+        :'limit_price' => :'limit_price'
       }
     end
 
@@ -31,7 +30,7 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'symbol' => :'UniversalSymbol'
+        :'limit_price' => :'String'
       }
     end
 
@@ -45,19 +44,19 @@ 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::ExcludedAsset` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::TakeProfit` 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::ExcludedAsset`. 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::TakeProfit`. 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?(:'symbol')
-        self.symbol = attributes[:'symbol']
+      if attributes.key?(:'limit_price')
+        self.limit_price = attributes[:'limit_price']
       end
     end
 
@@ -79,7 +78,7 @@ module SnapTrade
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          symbol == o.symbol
+          limit_price == o.limit_price
     end
 
     # @see the `==` method
@@ -91,7 +90,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [symbol].hash
+      [limit_price].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/{time_in_force.rb → time_in_force_strict.rb}

@@ -5,20 +5,19 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  class TimeInForce
-    DAY = "Day".freeze
+  class TimeInForceStrict
     FOK = "FOK".freeze
+    DAY = "Day".freeze
     GTC = "GTC".freeze
 
     def self.all_vars
-      @all_vars ||= [DAY, FOK, GTC].freeze
+      @all_vars ||= [FOK, DAY, GTC].freeze
     end
 
     # Builds the enum from string
@@ -32,8 +31,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 TimeInForce.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #TimeInForce"
+      return value if TimeInForceStrict.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #TimeInForceStrict"
     end
   end
 end

data/lib/snaptrade/models/{brokerage_authorization_type_type.rb → timeframe.rb}

@@ -5,19 +5,21 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  class BrokerageAuthorizationTypeType
-    READ = "read".freeze
-    TRADE = "trade".freeze
+  class Timeframe
+    ALL = "ALL".freeze
+    N1_Y = "1Y".freeze
+    N6_M = "6M".freeze
+    N3_M = "3M".freeze
+    N1_M = "1M".freeze
 
     def self.all_vars
-      @all_vars ||= [READ, TRADE].freeze
+      @all_vars ||= [ALL, N1_Y, N6_M, N3_M, N1_M].freeze
     end
 
     # Builds the enum from string
@@ -31,8 +33,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 BrokerageAuthorizationTypeType.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #BrokerageAuthorizationTypeType"
+      return value if Timeframe.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #Timeframe"
     end
   end
 end