intrinio-sdk 5.6.0 → 5.8.0

data/lib/intrinio-sdk/models/option_stats_realtime.rb

@@ -0,0 +1,229 @@
+=begin
+#Intrinio API
+
+#Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
+
+OpenAPI spec version: 2.18.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: unset
+
+=end
+
+require 'date'
+
+module Intrinio
+  # Realtime stats such as greeks and implied volatility for a specific options contract.
+  class OptionStatsRealtime
+    # The implied volatility of the contract calculated using the Black-Scholes Model.
+    attr_accessor :implied_volatility
+
+    # Delta represents the rate of change between the option's price and a $1 change in the underlying asset's price.
+    attr_accessor :delta
+
+    # Gamma represents the rate of change between an option's delta and the underlying asset's price.
+    attr_accessor :gamma
+
+    # Theta represents the rate of change between the option price and time, or time sensitivity - sometimes known as an option's time decay.
+    attr_accessor :theta
+
+    # Vega represents the rate of change between an option's value and the underlying asset's implied volatility.
+    attr_accessor :vega
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'implied_volatility' => :'implied_volatility',
+        :'delta' => :'delta',
+        :'gamma' => :'gamma',
+        :'theta' => :'theta',
+        :'vega' => :'vega'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'implied_volatility' => :'Float',
+        :'delta' => :'Float',
+        :'gamma' => :'Float',
+        :'theta' => :'Float',
+        :'vega' => :'Float'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'implied_volatility')
+        self.implied_volatility = attributes[:'implied_volatility']
+      end
+
+      if attributes.has_key?(:'delta')
+        self.delta = attributes[:'delta']
+      end
+
+      if attributes.has_key?(:'gamma')
+        self.gamma = attributes[:'gamma']
+      end
+
+      if attributes.has_key?(:'theta')
+        self.theta = attributes[:'theta']
+      end
+
+      if attributes.has_key?(:'vega')
+        self.vega = attributes[:'vega']
+      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
+      return 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 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 &&
+          implied_volatility == o.implied_volatility &&
+          delta == o.delta &&
+          gamma == o.gamma &&
+          theta == o.theta &&
+          vega == o.vega
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [implied_volatility, delta, gamma, theta, vega].hash
+    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)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        DateTime.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
+        temp_model = Intrinio.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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/intrinio-sdk/models/realtime_stock_price.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.14.0
+OpenAPI spec version: 2.18.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -21,6 +21,9 @@ module Intrinio
     # The date and time when the last trade occurred.
     attr_accessor :last_time
 
+    # The size of the last trade.
+    attr_accessor :last_size
+
     # The price of the top bid order.
     attr_accessor :bid_price
 
@@ -36,6 +39,9 @@ module Intrinio
     # The price at the open of the trading day.
     attr_accessor :open_price
 
+    # The price at the close of the trading day.
+    attr_accessor :close_price
+
     # The high price for the trading day.
     attr_accessor :high_price
 
@@ -62,11 +68,13 @@ module Intrinio
       {
         :'last_price' => :'last_price',
         :'last_time' => :'last_time',
+        :'last_size' => :'last_size',
         :'bid_price' => :'bid_price',
         :'bid_size' => :'bid_size',
         :'ask_price' => :'ask_price',
         :'ask_size' => :'ask_size',
         :'open_price' => :'open_price',
+        :'close_price' => :'close_price',
         :'high_price' => :'high_price',
         :'low_price' => :'low_price',
         :'exchange_volume' => :'exchange_volume',
@@ -82,11 +90,13 @@ module Intrinio
       {
         :'last_price' => :'Float',
         :'last_time' => :'DateTime',
+        :'last_size' => :'Float',
         :'bid_price' => :'Float',
         :'bid_size' => :'Float',
         :'ask_price' => :'Float',
         :'ask_size' => :'Float',
         :'open_price' => :'Float',
+        :'close_price' => :'Float',
         :'high_price' => :'Float',
         :'low_price' => :'Float',
         :'exchange_volume' => :'Float',
@@ -113,6 +123,10 @@ module Intrinio
         self.last_time = attributes[:'last_time']
       end
 
+      if attributes.has_key?(:'last_size')
+        self.last_size = attributes[:'last_size']
+      end
+
       if attributes.has_key?(:'bid_price')
         self.bid_price = attributes[:'bid_price']
       end
@@ -133,6 +147,10 @@ module Intrinio
         self.open_price = attributes[:'open_price']
       end
 
+      if attributes.has_key?(:'close_price')
+        self.close_price = attributes[:'close_price']
+      end
+
       if attributes.has_key?(:'high_price')
         self.high_price = attributes[:'high_price']
       end
@@ -183,11 +201,13 @@ module Intrinio
       self.class == o.class &&
           last_price == o.last_price &&
           last_time == o.last_time &&
+          last_size == o.last_size &&
           bid_price == o.bid_price &&
           bid_size == o.bid_size &&
           ask_price == o.ask_price &&
           ask_size == o.ask_size &&
           open_price == o.open_price &&
+          close_price == o.close_price &&
           high_price == o.high_price &&
           low_price == o.low_price &&
           exchange_volume == o.exchange_volume &&
@@ -206,7 +226,7 @@ module Intrinio
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [last_price, last_time, bid_price, bid_size, ask_price, ask_size, open_price, high_price, low_price, exchange_volume, market_volume, updated_on, source, security].hash
+      [last_price, last_time, last_size, bid_price, bid_size, ask_price, ask_size, open_price, close_price, high_price, low_price, exchange_volume, market_volume, updated_on, source, security].hash
     end
 
     # Builds the object from hash

data/lib/intrinio-sdk/models/realtime_stock_price_security.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.14.0
+OpenAPI spec version: 2.18.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/models/relative_strength_index_technical_value.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.14.0
+OpenAPI spec version: 2.18.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/models/reported_financial.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.14.0
+OpenAPI spec version: 2.18.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/models/reported_financial_dimension.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.14.0
+OpenAPI spec version: 2.18.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/models/reported_tag.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.14.0
+OpenAPI spec version: 2.18.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/models/security.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.14.0
+OpenAPI spec version: 2.18.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/models/security_screen_clause.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.14.0
+OpenAPI spec version: 2.18.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/models/security_screen_group.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.14.0
+OpenAPI spec version: 2.18.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/models/security_screen_result.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.14.0
+OpenAPI spec version: 2.18.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/models/security_screen_result_data.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.14.0
+OpenAPI spec version: 2.18.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/models/security_summary.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.14.0
+OpenAPI spec version: 2.18.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -45,6 +45,9 @@ module Intrinio
     # The global-composite OpenFIGI identifier
     attr_accessor :share_class_figi
 
+    # If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange
+    attr_accessor :primary_listing
+
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -58,7 +61,8 @@ module Intrinio
         :'composite_ticker' => :'composite_ticker',
         :'figi' => :'figi',
         :'composite_figi' => :'composite_figi',
-        :'share_class_figi' => :'share_class_figi'
+        :'share_class_figi' => :'share_class_figi',
+        :'primary_listing' => :'primary_listing'
       }
     end
 
@@ -74,7 +78,8 @@ module Intrinio
         :'composite_ticker' => :'String',
         :'figi' => :'String',
         :'composite_figi' => :'String',
-        :'share_class_figi' => :'String'
+        :'share_class_figi' => :'String',
+        :'primary_listing' => :'BOOLEAN'
       }
     end
 
@@ -126,6 +131,10 @@ module Intrinio
         self.share_class_figi = attributes[:'share_class_figi']
       end
 
+      if attributes.has_key?(:'primary_listing')
+        self.primary_listing = attributes[:'primary_listing']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -155,7 +164,8 @@ module Intrinio
           composite_ticker == o.composite_ticker &&
           figi == o.figi &&
           composite_figi == o.composite_figi &&
-          share_class_figi == o.share_class_figi
+          share_class_figi == o.share_class_figi &&
+          primary_listing == o.primary_listing
     end
 
     # @see the `==` method
@@ -167,7 +177,7 @@ module Intrinio
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, company_id, name, code, currency, ticker, composite_ticker, figi, composite_figi, share_class_figi].hash
+      [id, company_id, name, code, currency, ticker, composite_ticker, figi, composite_figi, share_class_figi, primary_listing].hash
     end
 
     # Builds the object from hash