intrinio-sdk 5.13.0 → 5.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61e78d656c3cada31a88763d640b310ea129a015d4f300add34e7fbad1380250
-  data.tar.gz: ea73099b39cdc4deda4940907a73319f88e45d9c34f4af792b41effa0fd3320d
+  metadata.gz: dd475f8d6e1339582f4cc3e43f98a91ecaeefab58b05c87e22a5a5f6b6054a46
+  data.tar.gz: c3b40b9d23c0eaa1a8c1d7cc8d595fcaeb701e3695e959a8fbe35c9f2774dde9
 SHA512:
-  metadata.gz: 0d2b20ca936cc466f82c009ba2b0c05bcb9804969a140e50f13f35824d697a13bf5d558464d4e1da8b9d8418b4bf3b38bcdcb99c368fd686c97fcf96886c5b01
-  data.tar.gz: 52f246e4a465d56ba75219362c2b705315ef226e93b3c9fe22f348a37a7bb842dba1c670758e5c9f760361a291cd230c57558cd53ff9025538816d5605ee6345
+  metadata.gz: 2db6f60ca2a27e023d21735f91dd8e8714f40e606e46e32425171b51eb652d7d620990afae20489f2ecf93372816106dee8d1eb93308a045c4b0a0bf91769b30
+  data.tar.gz: e3ac10f780b7c5c2101e4d7cabbaab75ddcdf83a304a290d24dd54f22edca3e4f4d8e8778c8b09b5dea9bec9b7a2417bafdd0dd9573ed8bf8c0912d9a383d409

data/README.md

@@ -9,7 +9,7 @@ Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.23.0
-- Package version: 5.13.0
+- Package version: 5.13.1
 
 
 ## Installation
@@ -65,6 +65,7 @@ Class | Method | HTTP request | Description
 *Intrinio::CompanyApi* | [**get_all_companies**](docs/CompanyApi.md#get_all_companies) | **GET** /companies | All Companies
 *Intrinio::CompanyApi* | [**get_all_company_news**](docs/CompanyApi.md#get_all_company_news) | **GET** /companies/news | All News
 *Intrinio::CompanyApi* | [**get_company**](docs/CompanyApi.md#get_company) | **GET** /companies/{identifier} | Lookup Company
+*Intrinio::CompanyApi* | [**get_company_answers**](docs/CompanyApi.md#get_company_answers) | **GET** /companies/{identifier}/answers | Company Answers
 *Intrinio::CompanyApi* | [**get_company_data_point_number**](docs/CompanyApi.md#get_company_data_point_number) | **GET** /companies/{identifier}/data_point/{tag}/number | Data Point (Number) for Company
 *Intrinio::CompanyApi* | [**get_company_data_point_text**](docs/CompanyApi.md#get_company_data_point_text) | **GET** /companies/{identifier}/data_point/{tag}/text | Data Point (Text) for Company
 *Intrinio::CompanyApi* | [**get_company_filings**](docs/CompanyApi.md#get_company_filings) | **GET** /companies/{identifier}/filings | All Filings by Company
@@ -252,6 +253,7 @@ Class | Method | HTTP request | Description
  - [Intrinio::ApiResponseBulkDownloadLinks](docs/ApiResponseBulkDownloadLinks.md)
  - [Intrinio::ApiResponseCompanies](docs/ApiResponseCompanies.md)
  - [Intrinio::ApiResponseCompaniesSearch](docs/ApiResponseCompaniesSearch.md)
+ - [Intrinio::ApiResponseCompanyAnswers](docs/ApiResponseCompanyAnswers.md)
  - [Intrinio::ApiResponseCompanyFilings](docs/ApiResponseCompanyFilings.md)
  - [Intrinio::ApiResponseCompanyFundamentals](docs/ApiResponseCompanyFundamentals.md)
  - [Intrinio::ApiResponseCompanyHistoricalData](docs/ApiResponseCompanyHistoricalData.md)
@@ -455,6 +457,9 @@ Class | Method | HTTP request | Description
  - [Intrinio::StockPriceInterval](docs/StockPriceInterval.md)
  - [Intrinio::StockPriceSummary](docs/StockPriceSummary.md)
  - [Intrinio::TechnicalIndicator](docs/TechnicalIndicator.md)
+ - [Intrinio::TheaEntityAnswer](docs/TheaEntityAnswer.md)
+ - [Intrinio::TheaSourceDocument](docs/TheaSourceDocument.md)
+ - [Intrinio::TheaSourceDocumentTags](docs/TheaSourceDocumentTags.md)
  - [Intrinio::TripleExponentialAverageTechnicalValue](docs/TripleExponentialAverageTechnicalValue.md)
  - [Intrinio::TrueStrengthIndexTechnicalValue](docs/TrueStrengthIndexTechnicalValue.md)
  - [Intrinio::UltimateOscillatorTechnicalValue](docs/UltimateOscillatorTechnicalValue.md)

data/docs/ApiResponseCompanyAnswers.md

@@ -0,0 +1,25 @@
+
+
+[//]: # (CLASS:Intrinio::ApiResponseCompanyAnswers)
+
+[//]: # (KIND:object)
+
+### Intrinio::ApiResponseCompanyAnswers
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**source** | String | The organziation the answer data was sourced from  
+**query** | String | The query posed to the Thea API  
+**answers** | [**Array<TheaEntityAnswer>**](TheaEntityAnswer.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::TheaEntityAnswer)
+
+
+

data/docs/CompanyApi.md

@@ -7,6 +7,7 @@ Method | HTTP request | Description
 [**get_all_companies**](CompanyApi.md#get_all_companies) | **GET** /companies | All Companies
 [**get_all_company_news**](CompanyApi.md#get_all_company_news) | **GET** /companies/news | All News
 [**get_company**](CompanyApi.md#get_company) | **GET** /companies/{identifier} | Lookup Company
+[**get_company_answers**](CompanyApi.md#get_company_answers) | **GET** /companies/{identifier}/answers | Company Answers
 [**get_company_data_point_number**](CompanyApi.md#get_company_data_point_number) | **GET** /companies/{identifier}/data_point/{tag}/number | Data Point (Number) for Company
 [**get_company_data_point_text**](CompanyApi.md#get_company_data_point_text) | **GET** /companies/{identifier}/data_point/{tag}/text | Data Point (Text) for Company
 [**get_company_filings**](CompanyApi.md#get_company_filings) | **GET** /companies/{identifier}/filings | All Filings by Company
@@ -281,6 +282,85 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::CompanyApi)
+
+[//]: # (METHOD:get_company_answers)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseCompanyAnswers)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseCompanyAnswers.md)
+
+[//]: # (OPERATION:get_company_answers_v2)
+
+[//]: # (ENDPOINT:/companies/{identifier}/answers)
+
+[//]: # (DOCUMENT_LINK:CompanyApi.md#get_company_answers)
+
+## **get_company_answers**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_company_answers_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseCompanyAnswers get_company_answers(identifier, query)
+
+#### Company Answers
+
+
+Returns answers for a question about the Company with the given `identifier`
+
+[//]: # (END_OVERVIEW)
+
+### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+require 'pp'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
+end
+
+company_api = Intrinio::CompanyApi.new
+identifier = "AAPL"
+query = "Where is the company headquartered?"
+
+result = company_api.get_company_answers(identifier, query)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   
+ **query** | String| The query to ask the Thea API |   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseCompanyAnswers**](ApiResponseCompanyAnswers.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::CompanyApi)

data/docs/TheaEntityAnswer.md

@@ -0,0 +1,25 @@
+
+
+[//]: # (CLASS:Intrinio::TheaEntityAnswer)
+
+[//]: # (KIND:object)
+
+### Intrinio::TheaEntityAnswer
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**answer** | String | The summarized answer returned from Thea  
+**content** | String | The underlying content the answer was sourced from  
+**source_documents** | [**Array<TheaSourceDocument>**](TheaSourceDocument.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::TheaSourceDocument)
+
+
+

data/docs/TheaSourceDocument.md

@@ -0,0 +1,24 @@
+
+
+[//]: # (CLASS:Intrinio::TheaSourceDocument)
+
+[//]: # (KIND:object)
+
+### Intrinio::TheaSourceDocument
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**id** | String | The unique id for the Thea source document  
+**tags** | [**Array<TheaSourceDocumentTags>**](TheaSourceDocumentTags.md) | Entity identifying tags associated with the source document  
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::TheaSourceDocumentTags)
+
+
+

data/docs/TheaSourceDocumentTags.md

@@ -0,0 +1,21 @@
+
+
+[//]: # (CLASS:Intrinio::TheaSourceDocumentTags)
+
+[//]: # (KIND:object)
+
+### Intrinio::TheaSourceDocumentTags
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**key** | String | Defintes whether the tag is a key or a value  
+**value** | String | The value of the tag  
+
+[//]: # (END_DEFINITION)
+
+
+

data/lib/intrinio-sdk.rb

@@ -21,6 +21,7 @@ require 'intrinio-sdk/models/accumulation_distribution_index_technical_value'
 require 'intrinio-sdk/models/api_response_bulk_download_links'
 require 'intrinio-sdk/models/api_response_companies'
 require 'intrinio-sdk/models/api_response_companies_search'
+require 'intrinio-sdk/models/api_response_company_answers'
 require 'intrinio-sdk/models/api_response_company_filings'
 require 'intrinio-sdk/models/api_response_company_fundamentals'
 require 'intrinio-sdk/models/api_response_company_historical_data'
@@ -224,6 +225,9 @@ require 'intrinio-sdk/models/stock_price_adjustment_summary'
 require 'intrinio-sdk/models/stock_price_interval'
 require 'intrinio-sdk/models/stock_price_summary'
 require 'intrinio-sdk/models/technical_indicator'
+require 'intrinio-sdk/models/thea_entity_answer'
+require 'intrinio-sdk/models/thea_source_document'
+require 'intrinio-sdk/models/thea_source_document_tags'
 require 'intrinio-sdk/models/triple_exponential_average_technical_value'
 require 'intrinio-sdk/models/true_strength_index_technical_value'
 require 'intrinio-sdk/models/ultimate_oscillator_technical_value'

data/lib/intrinio-sdk/api/company_api.rb

@@ -214,6 +214,66 @@ module Intrinio
       return data, status_code, headers
     end
 
+    # Company Answers
+    # Returns answers for a question about the Company with the given `identifier`
+    # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+    # @param query The query to ask the Thea API
+    # @param [Hash] opts the optional parameters
+    # @return [ApiResponseCompanyAnswers]
+    def get_company_answers(identifier, query, opts = {})
+      data, _status_code, _headers = get_company_answers_with_http_info(identifier, query, opts)
+      return data
+    end
+
+    # Company Answers
+    # Returns answers for a question about the Company with the given `identifier`
+    # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+    # @param query The query to ask the Thea API
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiResponseCompanyAnswers, Fixnum, Hash)>] ApiResponseCompanyAnswers data, response status code and response headers
+    def get_company_answers_with_http_info(identifier, query, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: CompanyApi.get_company_answers ..."
+      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 CompanyApi.get_company_answers"
+      end
+      # verify the required parameter 'query' is set
+      if @api_client.config.client_side_validation && query.nil?
+        fail ArgumentError, "Missing the required parameter 'query' when calling CompanyApi.get_company_answers"
+      end
+      # resource path
+      local_var_path = "/companies/{identifier}/answers".sub('{' + 'identifier' + '}', identifier.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'query'] = query
+
+      # 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 => 'ApiResponseCompanyAnswers')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CompanyApi#get_company_answers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Data Point (Number) for Company
     # Returns a numeric value for the given `tag` for the Company with the given `identifier`
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)

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

@@ -0,0 +1,210 @@
+=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.23.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: unset
+
+=end
+
+require 'date'
+
+module Intrinio
+
+  class ApiResponseCompanyAnswers
+    # The organziation the answer data was sourced from
+    attr_accessor :source
+
+    # The query posed to the Thea API
+    attr_accessor :query
+
+    attr_accessor :answers
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'source' => :'source',
+        :'query' => :'query',
+        :'answers' => :'answers'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'source' => :'String',
+        :'query' => :'String',
+        :'answers' => :'Array<TheaEntityAnswer>'
+      }
+    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?(:'source')
+        self.source = attributes[:'source']
+      end
+
+      if attributes.has_key?(:'query')
+        self.query = attributes[:'query']
+      end
+
+      if attributes.has_key?(:'answers')
+        if (value = attributes[:'answers']).is_a?(Array)
+          self.answers = value
+        end
+      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 &&
+          source == o.source &&
+          query == o.query &&
+          answers == o.answers
+    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
+      [source, query, answers].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