intrinio-sdk 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bdb050c82c12f7a5742d6e1128f8d31222d3effd
-  data.tar.gz: 0d4a9fa97602b51dabaceb22e814546652b3dc7c
+  metadata.gz: 16cc6641801bbbc2a3279ee39892abc89241c8eb
+  data.tar.gz: cb92a8675488d2a32b5d987e0addac021a1bb31a
 SHA512:
-  metadata.gz: 2536a0ea8383af74ed5219f9a13c7f148e8b9d13a115281ce6dea15fa5ed1f058abef351e58657f4e23835d3ba667b0abb76fea8a35d8bc00690faa4f33e3afd
-  data.tar.gz: f373f11a6cdd98f6ce85dd5734363c47a8afd869f5944280d87796838f7a1372eb2691e4715b8274ae042522c85d3d786437b92e98e4aa50ba16ff2c37113a60
+  metadata.gz: d44bfdf94dd4e7671cf11f524002dc410d558f0d983716b07c87163e3354852e3abc70b78c3848ab08bb45deab4a7dc8a3eab77416e031d7e4f310fabb73b4da
+  data.tar.gz: 9bb1cb4130b46d6972c6a26a56705e5fc8fd19ffb933ddf7cdf3bd12df79cf7c926ce2fee42faa26c7723b6e916cc5b0a3c79f515d00e1f9d1ecaf237abe39de

data/README.md

@@ -8,8 +8,8 @@ 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.9.0
-- Package version: 5.2.0
+- API version: 2.10.0
+- Package version: 5.3.0
 
 
 ## Installation
@@ -57,7 +57,7 @@ A listing of classes and methods is also provided below:
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*Intrinio::BulkDownloadsApi* | [**get_bulk_download_links**](docs/BulkDownloadsApi.md#get_bulk_download_links) | **GET** /bulk_downloads/links | Bulk Downloads
+*Intrinio::BulkDownloadsApi* | [**get_bulk_download_links**](docs/BulkDownloadsApi.md#get_bulk_download_links) | **GET** /bulk_downloads/links | All Links
 *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
@@ -80,6 +80,8 @@ Class | Method | HTTP request | Description
 *Intrinio::FilingApi* | [**get_all_notes**](docs/FilingApi.md#get_all_notes) | **GET** /filings/notes | All Filing Notes
 *Intrinio::FilingApi* | [**get_filing_by_id**](docs/FilingApi.md#get_filing_by_id) | **GET** /filings/{id} | Lookup Filing
 *Intrinio::FilingApi* | [**get_filing_fundamentals**](docs/FilingApi.md#get_filing_fundamentals) | **GET** /filings/{identifier}/fundamentals | All Fundamentals by Filing
+*Intrinio::FilingApi* | [**get_filing_html**](docs/FilingApi.md#get_filing_html) | **GET** /filings/{identifier}/html | Filing Html
+*Intrinio::FilingApi* | [**get_filing_text**](docs/FilingApi.md#get_filing_text) | **GET** /filings/{identifier}/text | Filing Text
 *Intrinio::FilingApi* | [**get_note**](docs/FilingApi.md#get_note) | **GET** /filings/notes/{identifier} | Filing Note by ID
 *Intrinio::FilingApi* | [**get_note_html**](docs/FilingApi.md#get_note_html) | **GET** /filings/notes/{identifier}/html | Filing Note HTML
 *Intrinio::FilingApi* | [**get_note_text**](docs/FilingApi.md#get_note_text) | **GET** /filings/notes/{identifier}/text | Filing Note Text

data/docs/BulkDownloadsApi.md

@@ -4,7 +4,7 @@ All URIs are relative to *https://api-v2.intrinio.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**get_bulk_download_links**](BulkDownloadsApi.md#get_bulk_download_links) | **GET** /bulk_downloads/links | Bulk Downloads
+[**get_bulk_download_links**](BulkDownloadsApi.md#get_bulk_download_links) | **GET** /bulk_downloads/links | All Links
 
 
 
@@ -34,7 +34,7 @@ Method | HTTP request | Description
 
 > ApiResponseBulkDownloadLinks get_bulk_download_links
 
-#### Bulk Downloads
+#### All Links
 
 
 Returns all active bulk downloads for your account with links to download.

data/docs/Filing.md

@@ -21,6 +21,9 @@ Name | Type | Description
 **filing_url** | String | The URL to the filing page on the SEC site  
 **report_url** | String | The URL to the actual report on the SEC site  
 **instance_url** | String | The URL for the XBRL filing for the report  
+**industry_category** | String | The company's operating industry category  
+**industry_group** | String | The company's operating industry group  
+**word_count** | Integer | The number of words in the filing  
 **company** | [**CompanySummary**](CompanySummary.md) |   
 
 [//]: # (END_DEFINITION)

data/docs/FilingApi.md

@@ -8,6 +8,8 @@ Method | HTTP request | Description
 [**get_all_notes**](FilingApi.md#get_all_notes) | **GET** /filings/notes | All Filing Notes
 [**get_filing_by_id**](FilingApi.md#get_filing_by_id) | **GET** /filings/{id} | Lookup Filing
 [**get_filing_fundamentals**](FilingApi.md#get_filing_fundamentals) | **GET** /filings/{identifier}/fundamentals | All Fundamentals by Filing
+[**get_filing_html**](FilingApi.md#get_filing_html) | **GET** /filings/{identifier}/html | Filing Html
+[**get_filing_text**](FilingApi.md#get_filing_text) | **GET** /filings/{identifier}/text | Filing Text
 [**get_note**](FilingApi.md#get_note) | **GET** /filings/notes/{identifier} | Filing Note by ID
 [**get_note_html**](FilingApi.md#get_note_html) | **GET** /filings/notes/{identifier}/html | Filing Note HTML
 [**get_note_text**](FilingApi.md#get_note_text) | **GET** /filings/notes/{identifier}/text | Filing Note Text
@@ -70,6 +72,8 @@ opts = {
   report_type: nil, # String | Filter by report type. Separate values with commas to return multiple The filing <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report types</a>.
   start_date: Date.parse("2015-01-01"), # Date | Filed on or after the given date
   end_date: nil, # Date | Filed before or after the given date
+  industry_category: nil, # String | Return companies in the given industry category
+  industry_group: nil, # String | Return companies in the given industry group
   page_size: 100, # Integer | The number of results to return
   next_page: nil # String | Gets the next page of data from a previous API call
 }
@@ -97,6 +101,8 @@ Name | Type | Description  | Notes
  **report_type** | String| Filter by report type. Separate values with commas to return multiple The filing &lt;a href&#x3D;\&quot;https://docs.intrinio.com/documentation/sec_filing_report_types\&quot; target&#x3D;\&quot;_blank\&quot;&gt;report types&lt;/a&gt;. | [optional]  &nbsp;
  **start_date** | Date| Filed on or after the given date | [optional]  &nbsp;
  **end_date** | Date| Filed before or after the given date | [optional]  &nbsp;
+ **industry_category** | String| Return companies in the given industry category | [optional]  &nbsp;
+ **industry_group** | String| Return companies in the given industry group | [optional]  &nbsp;
  **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp;
  **next_page** | String| Gets the next page of data from a previous API call | [optional]  &nbsp;
 
@@ -386,6 +392,168 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::FilingApi)
+
+[//]: # (METHOD:get_filing_html)
+
+[//]: # (RETURN_TYPE:String)
+
+[//]: # (RETURN_TYPE_KIND:primitive)
+
+[//]: # (RETURN_TYPE_DOC:)
+
+[//]: # (OPERATION:get_filing_html_v2)
+
+[//]: # (ENDPOINT:/filings/{identifier}/html)
+
+[//]: # (DOCUMENT_LINK:FilingApi.md#get_filing_html)
+
+## **get_filing_html**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_filing_html_v2)
+
+[//]: # (START_OVERVIEW)
+
+> String get_filing_html(identifier)
+
+#### Filing Html
+
+
+
+[//]: # (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'
+end
+
+filing_api = Intrinio::FilingApi.new
+
+identifier = "fil_B73xBG" # String | A Filing identifier
+
+
+begin
+  result = filing_api.get_filing_html(identifier)
+  pp result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling FilingApi->get_filing_html: #{e}"
+end
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| A Filing identifier |  &nbsp;
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+**String**
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::FilingApi)
+
+[//]: # (METHOD:get_filing_text)
+
+[//]: # (RETURN_TYPE:String)
+
+[//]: # (RETURN_TYPE_KIND:primitive)
+
+[//]: # (RETURN_TYPE_DOC:)
+
+[//]: # (OPERATION:get_filing_text_v2)
+
+[//]: # (ENDPOINT:/filings/{identifier}/text)
+
+[//]: # (DOCUMENT_LINK:FilingApi.md#get_filing_text)
+
+## **get_filing_text**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_filing_text_v2)
+
+[//]: # (START_OVERVIEW)
+
+> String get_filing_text(identifier)
+
+#### Filing Text
+
+
+
+[//]: # (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'
+end
+
+filing_api = Intrinio::FilingApi.new
+
+identifier = "fil_B73xBG" # String | A Filing identifier
+
+
+begin
+  result = filing_api.get_filing_text(identifier)
+  pp result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling FilingApi->get_filing_text: #{e}"
+end
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| A Filing identifier |  &nbsp;
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+**String**
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::FilingApi)

data/intrinio-sdk.gemspec

@@ -5,7 +5,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.9.0
+OpenAPI spec version: 2.10.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk.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.9.0
+OpenAPI spec version: 2.10.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/bulk_downloads_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.9.0
+OpenAPI spec version: 2.10.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -20,7 +20,7 @@ module Intrinio
       @api_client = api_client
     end
 
-    # Bulk Downloads
+    # All Links
     # Returns all active bulk downloads for your account with links to download.
     # @param [Hash] opts the optional parameters
     # @return [ApiResponseBulkDownloadLinks]
@@ -29,7 +29,7 @@ module Intrinio
       return data
     end
 
-    # Bulk Downloads
+    # All Links
     # Returns all active bulk downloads for your account with links to download.
     # @param [Hash] opts the optional parameters
     # @return [Array<(ApiResponseBulkDownloadLinks, Fixnum, Hash)>] ApiResponseBulkDownloadLinks data, response status code and response headers

data/lib/intrinio-sdk/api/company_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.9.0
+OpenAPI spec version: 2.10.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/data_point_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.9.0
+OpenAPI spec version: 2.10.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/data_tag_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.9.0
+OpenAPI spec version: 2.10.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/filing_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.9.0
+OpenAPI spec version: 2.10.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -27,6 +27,8 @@ module Intrinio
     # @option opts [String] :report_type Filter by report type. Separate values with commas to return multiple The filing <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report types</a>.
     # @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 [String] :industry_category Return companies in the given industry category
+    # @option opts [String] :industry_group Return companies in the given industry group
     # @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 [ApiResponseFilings]
@@ -42,6 +44,8 @@ module Intrinio
     # @option opts [String] :report_type Filter by report type. Separate values with commas to return multiple The filing <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report types</a>.
     # @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 [String] :industry_category Return companies in the given industry category
+    # @option opts [String] :industry_group Return companies in the given industry group
     # @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<(ApiResponseFilings, Fixnum, Hash)>] ApiResponseFilings data, response status code and response headers
@@ -66,6 +70,8 @@ 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[:'industry_category'] = opts[:'industry_category'] if !opts[:'industry_category'].nil?
+      query_params[:'industry_group'] = opts[:'industry_group'] if !opts[:'industry_group'].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?
 
@@ -307,6 +313,112 @@ module Intrinio
       return data, status_code, headers
     end
 
+    # Filing Html
+    # 
+    # @param identifier A Filing identifier
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def get_filing_html(identifier, opts = {})
+      data, _status_code, _headers = get_filing_html_with_http_info(identifier, opts)
+      return data
+    end
+
+    # Filing Html
+    # 
+    # @param identifier A Filing identifier
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def get_filing_html_with_http_info(identifier, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: FilingApi.get_filing_html ..."
+      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 FilingApi.get_filing_html"
+      end
+      # resource path
+      local_var_path = "/filings/{identifier}/html".sub('{' + 'identifier' + '}', identifier.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/html'])
+
+      # 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 => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FilingApi#get_filing_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Filing Text
+    # 
+    # @param identifier A Filing identifier
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def get_filing_text(identifier, opts = {})
+      data, _status_code, _headers = get_filing_text_with_http_info(identifier, opts)
+      return data
+    end
+
+    # Filing Text
+    # 
+    # @param identifier A Filing identifier
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def get_filing_text_with_http_info(identifier, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: FilingApi.get_filing_text ..."
+      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 FilingApi.get_filing_text"
+      end
+      # resource path
+      local_var_path = "/filings/{identifier}/text".sub('{' + 'identifier' + '}', identifier.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain; charset=utf-8'])
+
+      # 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 => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FilingApi#get_filing_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Filing Note by ID
     # 
     # @param identifier The Intrinio ID of the filing note