snaptrade 1.17.10 → 2.0.77

data/lib/snaptrade/models/snap_trade_register_user_request_body.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
@@ -14,7 +13,7 @@ require 'time'
 module SnapTrade
   # Data required to register a user via SnapTrade Partner
   class SnapTradeRegisterUserRequestBody
-    # SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
+    # SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
     attr_accessor :user_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/status.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/stop_loss.rb

@@ -0,0 +1,227 @@
+=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
+  # Details of the stop loss order. Only to be used when order_class = BRACKET. stop_price is required, limit_price is optional
+  class StopLoss
+    attr_accessor :stop_price
+
+    attr_accessor :limit_price
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'stop_price' => :'stop_price',
+        :'limit_price' => :'limit_price'
+      }
+    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
+      {
+        :'stop_price' => :'String',
+        :'limit_price' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'limit_price'
+      ])
+    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::StopLoss` 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::StopLoss`. 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?(:'stop_price')
+        self.stop_price = attributes[:'stop_price']
+      end
+
+      if attributes.key?(:'limit_price')
+        self.limit_price = attributes[:'limit_price']
+      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 &&
+          stop_price == o.stop_price &&
+          limit_price == o.limit_price
+    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
+      [stop_price, limit_price].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/strategy_order_record.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
@@ -24,8 +23,10 @@ module SnapTrade
 
     attr_accessor :closed_quantity
 
+    # Order Type potential values include (but are not limited to) - Limit - Market - StopLimit - Stop
     attr_accessor :order_type
 
+    # Trade time in force examples:   * FOK - Fill Or Kill   * Day - Day   * GTC - Good Til Canceled   * GTD - Good Til Date 
     attr_accessor :time_in_force
 
     # Trade Price if limit or stop limit order
@@ -70,8 +71,8 @@ module SnapTrade
         :'filled_quantity' => :'Float',
         :'open_quantity' => :'Float',
         :'closed_quantity' => :'Float',
-        :'order_type' => :'OrderType',
-        :'time_in_force' => :'TimeInForce',
+        :'order_type' => :'String',
+        :'time_in_force' => :'String',
         :'limit_price' => :'Float',
         :'execution_price' => :'Float',
         :'time_placed' => :'String',
@@ -82,6 +83,7 @@ module SnapTrade
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'order_type',
         :'limit_price',
         :'execution_price',
       ])

data/lib/snaptrade/models/strategy_order_record_status.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/strategy_quotes.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/strategy_quotes_greek.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/strategy_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/sub_period_return_rate.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
@@ -13,10 +12,10 @@ require 'time'
 
 module SnapTrade
   class SubPeriodReturnRate
-    # 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 :period_start
 
-    # 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 :period_end
 
     # The return rate for the given period

data/lib/snaptrade/models/symbol.rb

@@ -5,22 +5,25 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Symbol
+  # Uniquely describes a single security + exchange combination across all brokerages.
   class Symbol
+    # 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
 
-    attr_accessor :name
+    # A human-readable description of the security. This is usually the company name or ETF name.
+    attr_accessor :description
 
     attr_accessor :currency
 
@@ -28,16 +31,23 @@ module SnapTrade
 
     attr_accessor :type
 
+    # 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
       {
         :'id' => :'id',
         :'symbol' => :'symbol',
         :'raw_symbol' => :'raw_symbol',
-        :'name' => :'name',
+        :'description' => :'description',
         :'currency' => :'currency',
         :'exchange' => :'exchange',
-        :'type' => :'type'
+        :'type' => :'type',
+        :'figi_code' => :'figi_code',
+        :'figi_instrument' => :'figi_instrument'
       }
     end
 
@@ -52,16 +62,21 @@ module SnapTrade
         :'id' => :'String',
         :'symbol' => :'String',
         :'raw_symbol' => :'String',
-        :'name' => :'String',
-        :'currency' => :'Currency',
-        :'exchange' => :'Exchange',
-        :'type' => :'SecurityType'
+        :'description' => :'String',
+        :'currency' => :'SymbolCurrency',
+        :'exchange' => :'SymbolExchange',
+        :'type' => :'SecurityType',
+        :'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
 
@@ -92,8 +107,8 @@ module SnapTrade
         self.raw_symbol = attributes[:'raw_symbol']
       end
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
       end
 
       if attributes.key?(:'currency')
@@ -107,6 +122,14 @@ module SnapTrade
       if attributes.key?(:'type')
         self.type = attributes[:'type']
       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
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -130,10 +153,12 @@ module SnapTrade
           id == o.id &&
           symbol == o.symbol &&
           raw_symbol == o.raw_symbol &&
-          name == o.name &&
+          description == o.description &&
           currency == o.currency &&
           exchange == o.exchange &&
-          type == o.type
+          type == o.type &&
+          figi_code == o.figi_code &&
+          figi_instrument == o.figi_instrument
     end
 
     # @see the `==` method
@@ -145,7 +170,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, symbol, raw_symbol, name, currency, exchange, type].hash
+      [id, symbol, raw_symbol, description, currency, exchange, type, figi_code, figi_instrument].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/{portfolio_group.rb → symbol_currency.rb}

@@ -5,22 +5,28 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  class PortfolioGroup
+  # The currency in which the security is traded.
+  class SymbolCurrency
+    # 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.
     def self.attribute_map
       {
         :'id' => :'id',
+        :'code' => :'code',
         :'name' => :'name'
       }
     end
@@ -34,6 +40,7 @@ module SnapTrade
     def self.openapi_types
       {
         :'id' => :'String',
+        :'code' => :'String',
         :'name' => :'String'
       }
     end
@@ -44,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::PortfolioGroup` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::SymbolCurrency` 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::PortfolioGroup`. 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::SymbolCurrency`. 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
       }
@@ -63,6 +77,10 @@ module SnapTrade
         self.id = attributes[:'id']
       end
 
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
@@ -87,6 +105,7 @@ module SnapTrade
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
+          code == o.code &&
           name == o.name
     end
 
@@ -99,7 +118,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name].hash
+      [id, code, name].hash
     end
 
     # Builds the object from hash