intrinio-sdk 1.0.0 → 1.1.0

data/lib/intrinio-sdk/api/stock_exchange_api.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.0.0
+OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -21,7 +21,7 @@ module Intrinio
     end
 
     # Filter Stock Exchanges
-    # Return Stock Exchanges matching the given filters
+    # Returns Stock Exchanges matching the given filters
     # @param [Hash] opts the optional parameters
     # @option opts [String] :city Filter by city
     # @option opts [String] :country Filter by country
@@ -33,7 +33,7 @@ module Intrinio
     end
 
     # Filter Stock Exchanges
-    # Return Stock Exchanges matching the given filters
+    # Returns Stock Exchanges matching the given filters
     # @param [Hash] opts the optional parameters
     # @option opts [String] :city Filter by city
     # @option opts [String] :country Filter by country
@@ -76,8 +76,8 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Get All Stock Exchanges
-    # Return All Stock Exchanges
+    # All Stock Exchanges
+    # Returns all Stock Exchanges
     # @param [Hash] opts the optional parameters
     # @return [ApiResponseStockExchanges]
     def get_all_stock_exchanges(opts = {})
@@ -85,8 +85,8 @@ module Intrinio
       return data
     end
 
-    # Get All Stock Exchanges
-    # Return All Stock Exchanges
+    # All Stock Exchanges
+    # Returns all Stock Exchanges
     # @param [Hash] opts the optional parameters
     # @return [Array<(ApiResponseStockExchanges, Fixnum, Hash)>] ApiResponseStockExchanges data, response status code and response headers
     def get_all_stock_exchanges_with_http_info(opts = {})
@@ -123,8 +123,8 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Get Stock Exchange by ID
-    # 
+    # Lookup Stock Exchange
+    # Returns the Stock Exchange with the given `identifier`
     # @param identifier A Stock Exchange identifier (MIC or Intrinio ID)
     # @param [Hash] opts the optional parameters
     # @return [StockExchange]
@@ -133,8 +133,8 @@ module Intrinio
       return data
     end
 
-    # Get Stock Exchange by ID
-    # 
+    # Lookup Stock Exchange
+    # Returns the Stock Exchange with the given &#x60;identifier&#x60;
     # @param identifier A Stock Exchange identifier (MIC or Intrinio ID)
     # @param [Hash] opts the optional parameters
     # @return [Array<(StockExchange, Fixnum, Hash)>] StockExchange data, response status code and response headers
@@ -176,8 +176,8 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Get Stock Price Adjustments by Exchange
-    # Return stock price adjustments for the Stock Exchange with the given `identifier`
+    # Stock Price Adjustments by Exchange
+    # Returns stock price adjustments for the Stock Exchange with the given `identifier`
     # @param identifier A Stock Exchange identifier (MIC or Intrinio ID)
     # @param [Hash] opts the optional parameters
     # @option opts [Date] :date The date for which to return price adjustments
@@ -188,8 +188,8 @@ module Intrinio
       return data
     end
 
-    # Get Stock Price Adjustments by Exchange
-    # Return stock price adjustments for the Stock Exchange with the given &#x60;identifier&#x60;
+    # Stock Price Adjustments by Exchange
+    # Returns stock price adjustments for the Stock Exchange with the given &#x60;identifier&#x60;
     # @param identifier A Stock Exchange identifier (MIC or Intrinio ID)
     # @param [Hash] opts the optional parameters
     # @option opts [Date] :date The date for which to return price adjustments
@@ -235,8 +235,8 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Get Stock Prices by Exchange
-    # Return daily Stock Prices for Securities on the Stock Exchange with `identifier` and on the `price_date` (or the latest date that prices are available)
+    # Stock Prices by Exchange
+    # Returns end-of-day stock prices for Securities on the Stock Exchange with `identifier` and on the `price_date` (or the latest date that prices are available)
     # @param identifier A Stock Exchange identifier (MIC or Intrinio ID)
     # @param [Hash] opts the optional parameters
     # @option opts [Date] :date The date for which to return prices
@@ -247,8 +247,8 @@ module Intrinio
       return data
     end
 
-    # Get Stock Prices by Exchange
-    # Return daily Stock Prices for Securities on the Stock Exchange with &#x60;identifier&#x60; and on the &#x60;price_date&#x60; (or the latest date that prices are available)
+    # Stock Prices by Exchange
+    # Returns end-of-day stock prices for Securities on the Stock Exchange with &#x60;identifier&#x60; and on the &#x60;price_date&#x60; (or the latest date that prices are available)
     # @param identifier A Stock Exchange identifier (MIC or Intrinio ID)
     # @param [Hash] opts the optional parameters
     # @option opts [Date] :date The date for which to return prices
@@ -294,8 +294,70 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Get Securities by Exchange
-    # Return Securities traded on the Stock Exchange with `identifier`
+    # Realtime Stock Prices by Exchange
+    # Returns realtime stock prices for the Stock Exchange with the given `identifier`
+    # @param identifier A Stock Exchange identifier (MIC or Intrinio ID)
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :source Return realtime prices from the specified data source
+    # @option opts [String] :next_page Gets the next page of data from a previous API call
+    # @return [ApiResponseStockExchangeRealtimeStockPrices]
+    def get_stock_exchange_realtime_prices(identifier, opts = {})
+      data, _status_code, _headers = get_stock_exchange_realtime_prices_with_http_info(identifier, opts)
+      return data
+    end
+
+    # Realtime Stock Prices by Exchange
+    # Returns realtime stock prices for the Stock Exchange with the given &#x60;identifier&#x60;
+    # @param identifier A Stock Exchange identifier (MIC or Intrinio ID)
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :source Return realtime prices from the specified data source
+    # @option opts [String] :next_page Gets the next page of data from a previous API call
+    # @return [Array<(ApiResponseStockExchangeRealtimeStockPrices, Fixnum, Hash)>] ApiResponseStockExchangeRealtimeStockPrices data, response status code and response headers
+    def get_stock_exchange_realtime_prices_with_http_info(identifier, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: StockExchangeApi.get_stock_exchange_realtime_prices ..."
+      end
+      # verify the required parameter 'identifier' is set
+      if @api_client.config.client_side_validation && identifier.nil?
+        fail ArgumentError, "Missing the required parameter 'identifier' when calling StockExchangeApi.get_stock_exchange_realtime_prices"
+      end
+      if @api_client.config.client_side_validation && opts[:'source'] && !['iex', 'bats', 'bats_delayed'].include?(opts[:'source'])
+        fail ArgumentError, 'invalid value for "source", must be one of iex, bats, bats_delayed'
+      end
+      # resource path
+      local_var_path = "/stock_exchanges/{identifier}/prices/realtime".sub('{' + 'identifier' + '}', identifier.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?
+      query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ApiResponseStockExchangeRealtimeStockPrices')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StockExchangeApi#get_stock_exchange_realtime_prices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Securities by Exchange
+    # Returns Securities traded on the Stock Exchange with `identifier`
     # @param identifier A Stock Exchange identifier (MIC or Intrinio ID)
     # @param [Hash] opts the optional parameters
     # @option opts [String] :next_page Gets the next page of data from a previous API call
@@ -305,8 +367,8 @@ module Intrinio
       return data
     end
 
-    # Get Securities by Exchange
-    # Return Securities traded on the Stock Exchange with &#x60;identifier&#x60;
+    # Securities by Exchange
+    # Returns Securities traded on the Stock Exchange with &#x60;identifier&#x60;
     # @param identifier A Stock Exchange identifier (MIC or Intrinio ID)
     # @param [Hash] opts the optional parameters
     # @option opts [String] :next_page Gets the next page of data from a previous API call

data/lib/intrinio-sdk/api_client.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.0.0
+OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT

data/lib/intrinio-sdk/api_error.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.0.0
+OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT

data/lib/intrinio-sdk/configuration.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.0.0
+OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT

data/lib/intrinio-sdk/models/api_response_companies.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.0.0
+OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT

data/lib/intrinio-sdk/models/api_response_company_filings.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.0.0
+OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT

data/lib/intrinio-sdk/models/api_response_company_fundamentals.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.0.0
+OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT

data/lib/intrinio-sdk/models/api_response_company_historical_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.0.0
+OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT

data/lib/intrinio-sdk/models/api_response_company_news.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.0.0
+OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT

data/lib/intrinio-sdk/models/api_response_company_securities.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.0.0
+OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT

data/lib/intrinio-sdk/models/api_response_data_tags.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.0.0
+OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT

data/lib/intrinio-sdk/models/api_response_economic_index_historical_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.0.0
+OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT

data/lib/intrinio-sdk/models/api_response_economic_indices.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.0.0
+OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT

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

@@ -0,0 +1,200 @@
+=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.1.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+require 'date'
+
+module Intrinio
+
+  class ApiResponseFilingNotes
+    attr_accessor :filing_notes
+
+    # The token required to request the next page of the data
+    attr_accessor :next_page
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'filing_notes' => :'filing_notes',
+        :'next_page' => :'next_page'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'filing_notes' => :'Array<FilingNoteSummary>',
+        :'next_page' => :'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?(:'filing_notes')
+        if (value = attributes[:'filing_notes']).is_a?(Array)
+          self.filing_notes = value
+        end
+      end
+
+      if attributes.has_key?(:'next_page')
+        self.next_page = attributes[:'next_page']
+      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 &&
+          filing_notes == o.filing_notes &&
+          next_page == o.next_page
+    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
+      [filing_notes, next_page].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