intrinio-sdk 5.2.0 → 5.6.1

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

@@ -0,0 +1,199 @@
+=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.14.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: unset
+
+=end
+
+require 'date'
+
+module Intrinio
+  # The summary of a institutional owner
+  class ZacksInstitutionalHoldingOwnerSummary
+    # The owner's name
+    attr_accessor :name
+
+    # The Central Index Key (CIK) assigned to the company by the SEC as a unique identifier, used in SEC filings
+    attr_accessor :cik
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'cik' => :'cik'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'name' => :'String',
+        :'cik' => :'String'
+      }
+    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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'cik')
+        self.cik = attributes[:'cik']
+      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 &&
+          name == o.name &&
+          cik == o.cik
+    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
+      [name, cik].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/zacks_long_term_growth_rate.rb

@@ -0,0 +1,429 @@
+=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.14.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: unset
+
+=end
+
+require 'date'
+
+module Intrinio
+  # Zacks long term growth rates from analysts for thousands of stocks.  Zacks storied research team aggregates and validates the estimates.  Each Growth Rate includes metadata about the corresponding Security.
+  class ZacksLongTermGrowthRate
+    # The mean long term growth estimate
+    attr_accessor :mean
+
+    # The median long term growth estimate
+    attr_accessor :median
+
+    # The number of long term growth estimates
+    attr_accessor :count
+
+    # The high long term growth estimate
+    attr_accessor :high
+
+    # The low long term growth estimate
+    attr_accessor :low
+
+    # The standard deviation long term growth estimate
+    attr_accessor :std_dev
+
+    # The number of long term growth estimate revisions upward
+    attr_accessor :revisions_upward
+
+    # The number of long term growth estimate revisions downward
+    attr_accessor :revisions_downward
+
+    # The mean long term growth estimate 7 days ago
+    attr_accessor :mean_7_days_ago
+
+    # The mean long term growth estimate 30 days ago
+    attr_accessor :mean_30_days_ago
+
+    # The mean long term growth estimate 60 days ago
+    attr_accessor :mean_60_days_ago
+
+    # The mean long term growth estimate 90 days ago
+    attr_accessor :mean_90_days_ago
+
+    # The number of long term growth estimate revisions upward in the last 7 days
+    attr_accessor :revisions_upward_last_7_days
+
+    # The number of long term growth estimate revisions downward in the last 7 days
+    attr_accessor :revisions_downward_last_7_days
+
+    # The number of long term growth estimate revisions upward in the last 30 days
+    attr_accessor :revisions_upward_last_30_days
+
+    # The number of long term growth estimate revisions downward in the last 30 days
+    attr_accessor :revisions_downward_last_30_days
+
+    # The number of long term growth estimate revisions upward in the last 60 days
+    attr_accessor :revisions_upward_last_60_days
+
+    # The number of long term growth estimate revisions downward in the last 60 days
+    attr_accessor :revisions_downward_last_60_days
+
+    # The number of long term growth estimate revisions upward in the last 90 days
+    attr_accessor :revisions_upward_last_90_days
+
+    # The number of long term growth estimate revisions downward in the last 90 days
+    attr_accessor :revisions_downward_last_90_days
+
+    # The number of long term growth estimate revisions upward in the last 120 days
+    attr_accessor :revisions_upward_last_120_days
+
+    # The number of long term growth estimate revisions downward in the last 120 days
+    attr_accessor :revisions_downward_last_120_days
+
+    # The number of long term growth estimate revisions upward in the last 150 days
+    attr_accessor :revisions_upward_last_150_days
+
+    # The number of long term growth estimate revisions downward in the last 150 days
+    attr_accessor :revisions_downward_last_150_days
+
+    # The Security of the Zacks long term growth estimate
+    attr_accessor :security
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'mean' => :'mean',
+        :'median' => :'median',
+        :'count' => :'count',
+        :'high' => :'high',
+        :'low' => :'low',
+        :'std_dev' => :'std_dev',
+        :'revisions_upward' => :'revisions_upward',
+        :'revisions_downward' => :'revisions_downward',
+        :'mean_7_days_ago' => :'mean_7_days_ago',
+        :'mean_30_days_ago' => :'mean_30_days_ago',
+        :'mean_60_days_ago' => :'mean_60_days_ago',
+        :'mean_90_days_ago' => :'mean_90_days_ago',
+        :'revisions_upward_last_7_days' => :'revisions_upward_last_7_days',
+        :'revisions_downward_last_7_days' => :'revisions_downward_last_7_days',
+        :'revisions_upward_last_30_days' => :'revisions_upward_last_30_days',
+        :'revisions_downward_last_30_days' => :'revisions_downward_last_30_days',
+        :'revisions_upward_last_60_days' => :'revisions_upward_last_60_days',
+        :'revisions_downward_last_60_days' => :'revisions_downward_last_60_days',
+        :'revisions_upward_last_90_days' => :'revisions_upward_last_90_days',
+        :'revisions_downward_last_90_days' => :'revisions_downward_last_90_days',
+        :'revisions_upward_last_120_days' => :'revisions_upward_last_120_days',
+        :'revisions_downward_last_120_days' => :'revisions_downward_last_120_days',
+        :'revisions_upward_last_150_days' => :'revisions_upward_last_150_days',
+        :'revisions_downward_last_150_days' => :'revisions_downward_last_150_days',
+        :'security' => :'security'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'mean' => :'Float',
+        :'median' => :'Float',
+        :'count' => :'Integer',
+        :'high' => :'Float',
+        :'low' => :'Float',
+        :'std_dev' => :'String',
+        :'revisions_upward' => :'Integer',
+        :'revisions_downward' => :'Integer',
+        :'mean_7_days_ago' => :'String',
+        :'mean_30_days_ago' => :'String',
+        :'mean_60_days_ago' => :'String',
+        :'mean_90_days_ago' => :'String',
+        :'revisions_upward_last_7_days' => :'String',
+        :'revisions_downward_last_7_days' => :'String',
+        :'revisions_upward_last_30_days' => :'String',
+        :'revisions_downward_last_30_days' => :'String',
+        :'revisions_upward_last_60_days' => :'String',
+        :'revisions_downward_last_60_days' => :'String',
+        :'revisions_upward_last_90_days' => :'String',
+        :'revisions_downward_last_90_days' => :'String',
+        :'revisions_upward_last_120_days' => :'String',
+        :'revisions_downward_last_120_days' => :'String',
+        :'revisions_upward_last_150_days' => :'String',
+        :'revisions_downward_last_150_days' => :'String',
+        :'security' => :'SecuritySummary'
+      }
+    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?(:'mean')
+        self.mean = attributes[:'mean']
+      end
+
+      if attributes.has_key?(:'median')
+        self.median = attributes[:'median']
+      end
+
+      if attributes.has_key?(:'count')
+        self.count = attributes[:'count']
+      end
+
+      if attributes.has_key?(:'high')
+        self.high = attributes[:'high']
+      end
+
+      if attributes.has_key?(:'low')
+        self.low = attributes[:'low']
+      end
+
+      if attributes.has_key?(:'std_dev')
+        self.std_dev = attributes[:'std_dev']
+      end
+
+      if attributes.has_key?(:'revisions_upward')
+        self.revisions_upward = attributes[:'revisions_upward']
+      end
+
+      if attributes.has_key?(:'revisions_downward')
+        self.revisions_downward = attributes[:'revisions_downward']
+      end
+
+      if attributes.has_key?(:'mean_7_days_ago')
+        self.mean_7_days_ago = attributes[:'mean_7_days_ago']
+      end
+
+      if attributes.has_key?(:'mean_30_days_ago')
+        self.mean_30_days_ago = attributes[:'mean_30_days_ago']
+      end
+
+      if attributes.has_key?(:'mean_60_days_ago')
+        self.mean_60_days_ago = attributes[:'mean_60_days_ago']
+      end
+
+      if attributes.has_key?(:'mean_90_days_ago')
+        self.mean_90_days_ago = attributes[:'mean_90_days_ago']
+      end
+
+      if attributes.has_key?(:'revisions_upward_last_7_days')
+        self.revisions_upward_last_7_days = attributes[:'revisions_upward_last_7_days']
+      end
+
+      if attributes.has_key?(:'revisions_downward_last_7_days')
+        self.revisions_downward_last_7_days = attributes[:'revisions_downward_last_7_days']
+      end
+
+      if attributes.has_key?(:'revisions_upward_last_30_days')
+        self.revisions_upward_last_30_days = attributes[:'revisions_upward_last_30_days']
+      end
+
+      if attributes.has_key?(:'revisions_downward_last_30_days')
+        self.revisions_downward_last_30_days = attributes[:'revisions_downward_last_30_days']
+      end
+
+      if attributes.has_key?(:'revisions_upward_last_60_days')
+        self.revisions_upward_last_60_days = attributes[:'revisions_upward_last_60_days']
+      end
+
+      if attributes.has_key?(:'revisions_downward_last_60_days')
+        self.revisions_downward_last_60_days = attributes[:'revisions_downward_last_60_days']
+      end
+
+      if attributes.has_key?(:'revisions_upward_last_90_days')
+        self.revisions_upward_last_90_days = attributes[:'revisions_upward_last_90_days']
+      end
+
+      if attributes.has_key?(:'revisions_downward_last_90_days')
+        self.revisions_downward_last_90_days = attributes[:'revisions_downward_last_90_days']
+      end
+
+      if attributes.has_key?(:'revisions_upward_last_120_days')
+        self.revisions_upward_last_120_days = attributes[:'revisions_upward_last_120_days']
+      end
+
+      if attributes.has_key?(:'revisions_downward_last_120_days')
+        self.revisions_downward_last_120_days = attributes[:'revisions_downward_last_120_days']
+      end
+
+      if attributes.has_key?(:'revisions_upward_last_150_days')
+        self.revisions_upward_last_150_days = attributes[:'revisions_upward_last_150_days']
+      end
+
+      if attributes.has_key?(:'revisions_downward_last_150_days')
+        self.revisions_downward_last_150_days = attributes[:'revisions_downward_last_150_days']
+      end
+
+      if attributes.has_key?(:'security')
+        self.security = attributes[:'security']
+      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 &&
+          mean == o.mean &&
+          median == o.median &&
+          count == o.count &&
+          high == o.high &&
+          low == o.low &&
+          std_dev == o.std_dev &&
+          revisions_upward == o.revisions_upward &&
+          revisions_downward == o.revisions_downward &&
+          mean_7_days_ago == o.mean_7_days_ago &&
+          mean_30_days_ago == o.mean_30_days_ago &&
+          mean_60_days_ago == o.mean_60_days_ago &&
+          mean_90_days_ago == o.mean_90_days_ago &&
+          revisions_upward_last_7_days == o.revisions_upward_last_7_days &&
+          revisions_downward_last_7_days == o.revisions_downward_last_7_days &&
+          revisions_upward_last_30_days == o.revisions_upward_last_30_days &&
+          revisions_downward_last_30_days == o.revisions_downward_last_30_days &&
+          revisions_upward_last_60_days == o.revisions_upward_last_60_days &&
+          revisions_downward_last_60_days == o.revisions_downward_last_60_days &&
+          revisions_upward_last_90_days == o.revisions_upward_last_90_days &&
+          revisions_downward_last_90_days == o.revisions_downward_last_90_days &&
+          revisions_upward_last_120_days == o.revisions_upward_last_120_days &&
+          revisions_downward_last_120_days == o.revisions_downward_last_120_days &&
+          revisions_upward_last_150_days == o.revisions_upward_last_150_days &&
+          revisions_downward_last_150_days == o.revisions_downward_last_150_days &&
+          security == o.security
+    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
+      [mean, median, count, high, low, std_dev, revisions_upward, revisions_downward, mean_7_days_ago, mean_30_days_ago, mean_60_days_ago, mean_90_days_ago, revisions_upward_last_7_days, revisions_downward_last_7_days, revisions_upward_last_30_days, revisions_downward_last_30_days, revisions_upward_last_60_days, revisions_downward_last_60_days, revisions_upward_last_90_days, revisions_downward_last_90_days, revisions_upward_last_120_days, revisions_downward_last_120_days, revisions_upward_last_150_days, revisions_downward_last_150_days, security].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