intrinio-sdk 5.12.0 → 5.14.0

data/docs/OptionUnusualTrade.md

@@ -0,0 +1,26 @@
+
+
+[//]: # (CLASS:Intrinio::OptionUnusualTrade)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionUnusualTrade
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**symbol** | String | The underlying option security symbol for the trade  
+**timestamp** | Date | The UTC timestamp of order placement  
+**type** | String | The type of unusual trade  
+**total_value** | Float | The aggregated value of all option contract premiums included in the trade  
+**contract_type** | String | The type of Option (put or call)  
+**contract_expiration** | Date | The expiration date for the options contract  
+**contract_strike** | Float | The strike price of the option contract  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/OptionsApi.md

@@ -15,6 +15,7 @@ Method | HTTP request | Description
 [**get_options_prices_batch_realtime**](OptionsApi.md#get_options_prices_batch_realtime) | **POST** /options/prices/realtime/batch | Option Prices Batch Realtime
 [**get_options_prices_realtime**](OptionsApi.md#get_options_prices_realtime) | **GET** /options/prices/{identifier}/realtime | Option Prices Realtime
 [**get_options_stats_realtime**](OptionsApi.md#get_options_stats_realtime) | **GET** /options/prices/{identifier}/realtime/stats | Option Stats Realtime
+[**get_unusual_activity**](OptionsApi.md#get_unusual_activity) | **GET** /options/unusual_activity/{symbol} | Options Unusual Activity
 
 
 
@@ -991,3 +992,85 @@ Name | Type | Description  | Notes
 
 [//]: # (END_OPERATION)
 
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OptionsApi)
+
+[//]: # (METHOD:get_unusual_activity)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionsUnusualActivity)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsUnusualActivity.md)
+
+[//]: # (OPERATION:get_unusual_activity_v2)
+
+[//]: # (ENDPOINT:/options/unusual_activity/{symbol})
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#get_unusual_activity)
+
+## **get_unusual_activity**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_unusual_activity_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOptionsUnusualActivity get_unusual_activity(symbol, opts)
+
+#### Options Unusual Activity
+
+
+Returns unusual trades for a 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
+
+options_api = Intrinio::OptionsApi.new
+symbol = "AAPL"
+
+opts = {
+  source: nil
+}
+
+result = options_api.get_unusual_activity(symbol, opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **symbol** | String| The option symbol, corresponding to the underlying security. |   
+ **source** | String| Realtime or 15-minute delayed contracts. | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseOptionsUnusualActivity**](ApiResponseOptionsUnusualActivity.md)
+
+[//]: # (END_OPERATION)
+

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) | The documents from which Thea answer data is sourced  
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::TheaSourceDocument)
+
+
+

data/docs/TheaSourceDocument.md

@@ -0,0 +1,21 @@
+
+
+[//]: # (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<Object> | Entity identifying tags associated with the source document  
+
+[//]: # (END_DEFINITION)
+
+
+

data/intrinio-sdk.gemspec

@@ -3,9 +3,9 @@
 =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.
+#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://docs.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.22.0
+OpenAPI spec version: 2.25.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.email       = ["success@intrinio.com"]
   s.homepage    = "https://github.com/intrinio/ruby-sdk"
   s.summary     = "Access the Intrinio API"
-  s.description = "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."
+  s.description = "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://docs.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."
   s.license     = "GPL-3.0"
   s.required_ruby_version = ">= 1.9"
 

data/lib/intrinio-sdk.rb

@@ -1,9 +1,9 @@
 =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.
+#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://docs.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.22.0
+OpenAPI spec version: 2.25.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -21,11 +21,13 @@ 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'
 require 'intrinio-sdk/models/api_response_company_insider_transaction_filings'
 require 'intrinio-sdk/models/api_response_company_news'
+require 'intrinio-sdk/models/api_response_company_recognize'
 require 'intrinio-sdk/models/api_response_company_securities'
 require 'intrinio-sdk/models/api_response_company_shares_outstanding'
 require 'intrinio-sdk/models/api_response_data_tags'
@@ -35,6 +37,7 @@ require 'intrinio-sdk/models/api_response_et_fs'
 require 'intrinio-sdk/models/api_response_economic_index_historical_data'
 require 'intrinio-sdk/models/api_response_economic_indices'
 require 'intrinio-sdk/models/api_response_economic_indices_search'
+require 'intrinio-sdk/models/api_response_filing_answers'
 require 'intrinio-sdk/models/api_response_filing_fundamentals'
 require 'intrinio-sdk/models/api_response_filing_notes'
 require 'intrinio-sdk/models/api_response_filing_notes_search'
@@ -58,6 +61,7 @@ require 'intrinio-sdk/models/api_response_options_prices_batch_realtime'
 require 'intrinio-sdk/models/api_response_options_realtime'
 require 'intrinio-sdk/models/api_response_options_stats_realtime'
 require 'intrinio-sdk/models/api_response_options_tickers'
+require 'intrinio-sdk/models/api_response_options_unusual_activity'
 require 'intrinio-sdk/models/api_response_owner_insider_transaction_filings'
 require 'intrinio-sdk/models/api_response_owner_institutional_holdings'
 require 'intrinio-sdk/models/api_response_owners'
@@ -196,6 +200,7 @@ require 'intrinio-sdk/models/option_price_batch_realtime'
 require 'intrinio-sdk/models/option_price_realtime'
 require 'intrinio-sdk/models/option_realtime'
 require 'intrinio-sdk/models/option_stats_realtime'
+require 'intrinio-sdk/models/option_unusual_trade'
 require 'intrinio-sdk/models/owner'
 require 'intrinio-sdk/models/owner_summary'
 require 'intrinio-sdk/models/realtime_stock_price'
@@ -223,6 +228,8 @@ 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/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/bulk_downloads_api.rb

@@ -1,9 +1,9 @@
 =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.
+#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://docs.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.22.0
+OpenAPI spec version: 2.25.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

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

@@ -1,9 +1,9 @@
 =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.
+#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://docs.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.22.0
+OpenAPI spec version: 2.25.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -57,8 +57,8 @@ module Intrinio
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: CompanyApi.get_all_companies ..."
       end
-      if @api_client.config.client_side_validation && opts[:'template'] && !['industrial', 'financial'].include?(opts[:'template'])
-        fail ArgumentError, 'invalid value for "template", must be one of industrial, financial'
+      if @api_client.config.client_side_validation && opts[:'template'] && !['indu', 'fin'].include?(opts[:'template'])
+        fail ArgumentError, 'invalid value for "template", must be one of indu, fin'
       end
       if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
         fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CompanyApi.get_all_companies, must be smaller than or equal to 10000.'
@@ -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)
@@ -339,6 +399,7 @@ module Intrinio
     # @option opts [String] :report_type Filter by &lt;a href&#x3D;\&quot;https://docs.intrinio.com/documentation/sec_filing_report_types\&quot; target&#x3D;\&quot;_blank\&quot;&gt;report type&lt;/a&gt;. Separate values with commas to return multiple report types.
     # @option opts [Date] :start_date Filed on or after the given date
     # @option opts [Date] :end_date Filed before or after the given date
+    # @option opts [BOOLEAN] :thea_enabled Return filings that have been read by our Thea NLP and are ready for our answers endpoint
     # @option opts [Integer] :page_size The number of results to return (default to 100)
     # @option opts [String] :next_page Gets the next page of data from a previous API call
     # @return [ApiResponseCompanyFilings]
@@ -354,6 +415,7 @@ module Intrinio
     # @option opts [String] :report_type Filter by &lt;a href&#x3D;\&quot;https://docs.intrinio.com/documentation/sec_filing_report_types\&quot; target&#x3D;\&quot;_blank\&quot;&gt;report type&lt;/a&gt;. Separate values with commas to return multiple report types.
     # @option opts [Date] :start_date Filed on or after the given date
     # @option opts [Date] :end_date Filed before or after the given date
+    # @option opts [BOOLEAN] :thea_enabled Return filings that have been read by our Thea NLP and are ready for our answers endpoint
     # @option opts [Integer] :page_size The number of results to return
     # @option opts [String] :next_page Gets the next page of data from a previous API call
     # @return [Array<(ApiResponseCompanyFilings, Fixnum, Hash)>] ApiResponseCompanyFilings data, response status code and response headers
@@ -377,6 +439,7 @@ module Intrinio
       query_params[:'report_type'] = opts[:'report_type'] if !opts[:'report_type'].nil?
       query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
       query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
+      query_params[:'thea_enabled'] = opts[:'thea_enabled'] if !opts[:'thea_enabled'].nil?
       query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
       query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
 
@@ -994,6 +1057,60 @@ module Intrinio
       return data, status_code, headers
     end
 
+    # Recognize Company
+    # Returns a list of companies recognized by the Thea API in the given `text` query string parameter.
+    # @param text The text sent to the Thea API to analyze
+    # @param [Hash] opts the optional parameters
+    # @return [ApiResponseCompanyRecognize]
+    def recognize_company(text, opts = {})
+      data, _status_code, _headers = recognize_company_with_http_info(text, opts)
+      return data
+    end
+
+    # Recognize Company
+    # Returns a list of companies recognized by the Thea API in the given &#x60;text&#x60; query string parameter.
+    # @param text The text sent to the Thea API to analyze
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiResponseCompanyRecognize, Fixnum, Hash)>] ApiResponseCompanyRecognize data, response status code and response headers
+    def recognize_company_with_http_info(text, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: CompanyApi.recognize_company ..."
+      end
+      # verify the required parameter 'text' is set
+      if @api_client.config.client_side_validation && text.nil?
+        fail ArgumentError, "Missing the required parameter 'text' when calling CompanyApi.recognize_company"
+      end
+      # resource path
+      local_var_path = "/companies/recognize"
+
+      # query parameters
+      query_params = {}
+      query_params[:'text'] = text
+
+      # 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 => 'ApiResponseCompanyRecognize')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CompanyApi#recognize_company\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Search Companies
     # Searches for Companies matching the text `query`
     # @param query Search parameters

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

@@ -1,9 +1,9 @@
 =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.
+#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://docs.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.22.0
+OpenAPI spec version: 2.25.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset