RubyGems - intrinio-sdk - Versions diffs - 2.3.0 → 3.0.0 - Mend

intrinio-sdk 2.3.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (501) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d2e352a0ee451f016c397dacc4637edfae78c48
-  data.tar.gz: cc6e1663fa443744bad65b8ef3b5ab3b2d1bb939
+  metadata.gz: 16674923833bfb10667da31cb05354829557317a
+  data.tar.gz: 3afefca69eac6366244e63be16364902adb61351
 SHA512:
-  metadata.gz: a2997721793ad6e2b3aa048f22761a730aecc989bb2e20bbfca0ce23d42fb2ee1de342a8057964733d9ed8a30cf74eae447b9f5e21055bd14ca123a51cfe7013
-  data.tar.gz: ea0b4f259326125acf8b38f865339688347c347944ec28aa65ed6c93540432e9e12846368e54f08c9b6a4e9fcbccf4886fa4940967dcfca580cd0a6a562dfb7c
+  metadata.gz: 7a2074654c954cc0f0852a55975a09647a17737bc01b034185c362c20002d74c6bec3f9d84d2afe861abcafd306e8519b11dce80820eb7a6a4cb3476ea92cf56
+  data.tar.gz: 2820288ba24c96c71163e86725dba5c4b34c86e986dbb05d5b94daa2bd79467f30884202977e73f78790314a764d7eeaaa3032548f0ed3a6915a275b4480b627

data/README.md CHANGED Viewed

@@ -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.6.0
-- Package version: 2.3.0
+- API version: 2.6.2
+- Package version: 3.0.0
 ## Installation

data/docs/CompanyApi.md CHANGED Viewed

@@ -18,17 +18,7 @@ Method | HTTP request | Description
 [**search_companies**](CompanyApi.md#search_companies) | **GET** /companies/search | Search Companies
-[//]: # (START_OPERTATION)
-[//]: # (ENDPOINT:/companies)
-[//]: # (DOC_LINK:CompanyApi.md#get_all_companies)
 # **get_all_companies**
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_companies_v2)
 > ApiResponseCompanies get_all_companies(opts)
 All Companies
@@ -36,9 +26,6 @@ All Companies
 Returns all Companies. When parameters are specified, returns matching companies.
 ### Example
-[//]: # (START_CODE_EXAMPLE)
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -69,8 +56,6 @@ rescue Intrinio::ApiError => e
 end
 ```
-[//]: # (END_CODE_EXAMPLE)
 ### Parameters
 Name | Type | Description  | Notes
@@ -88,19 +73,7 @@ Name | Type | Description  | Notes
 [**ApiResponseCompanies**](ApiResponseCompanies.md)
-[//]: # (END_OPERATION)
-[//]: # (START_OPERTATION)
-[//]: # (ENDPOINT:/companies/news)
-[//]: # (DOC_LINK:CompanyApi.md#get_all_company_news)
 # **get_all_company_news**
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_company_news_v2)
 > ApiResponseNews get_all_company_news(opts)
 All News
@@ -108,9 +81,6 @@ All News
 Returns all News for all Companies
 ### Example
-[//]: # (START_CODE_EXAMPLE)
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -135,8 +105,6 @@ rescue Intrinio::ApiError => e
 end
 ```
-[//]: # (END_CODE_EXAMPLE)
 ### Parameters
 Name | Type | Description  | Notes
@@ -148,19 +116,7 @@ Name | Type | Description  | Notes
 [**ApiResponseNews**](ApiResponseNews.md)
-[//]: # (END_OPERATION)
-[//]: # (START_OPERTATION)
-[//]: # (ENDPOINT:/companies/{identifier})
-[//]: # (DOC_LINK:CompanyApi.md#get_company)
 # **get_company**
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_v2)
 > Company get_company(identifier)
 Lookup Company
@@ -168,9 +124,6 @@ Lookup Company
 Returns the Company with the given `identifier`
 ### Example
-[//]: # (START_CODE_EXAMPLE)
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -193,8 +146,6 @@ rescue Intrinio::ApiError => e
 end
 ```
-[//]: # (END_CODE_EXAMPLE)
 ### Parameters
 Name | Type | Description  | Notes
@@ -205,19 +156,7 @@ Name | Type | Description  | Notes
 [**Company**](Company.md)
-[//]: # (END_OPERATION)
-[//]: # (START_OPERTATION)
-[//]: # (ENDPOINT:/companies/{identifier}/data_point/{tag}/number)
-[//]: # (DOC_LINK:CompanyApi.md#get_company_data_point_number)
 # **get_company_data_point_number**
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_data_point_number_v2)
 > Float get_company_data_point_number(identifier, tag)
 Data Point (Number) for Company
@@ -225,9 +164,6 @@ Data Point (Number) for Company
 Returns a numeric value for the given `tag` for the Company with the given `identifier`
 ### Example
-[//]: # (START_CODE_EXAMPLE)
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -252,8 +188,6 @@ rescue Intrinio::ApiError => e
 end
 ```
-[//]: # (END_CODE_EXAMPLE)
 ### Parameters
 Name | Type | Description  | Notes
@@ -265,19 +199,7 @@ Name | Type | Description  | Notes
 **Float**
-[//]: # (END_OPERATION)
-[//]: # (START_OPERTATION)
-[//]: # (ENDPOINT:/companies/{identifier}/data_point/{tag}/text)
-[//]: # (DOC_LINK:CompanyApi.md#get_company_data_point_text)
 # **get_company_data_point_text**
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_data_point_text_v2)
 > String get_company_data_point_text(identifier, tag)
 Data Point (Text) for Company
@@ -285,9 +207,6 @@ Data Point (Text) for Company
 Returns a text value for the given `tag` for the Company with the given `identifier`
 ### Example
-[//]: # (START_CODE_EXAMPLE)
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -312,8 +231,6 @@ rescue Intrinio::ApiError => e
 end
 ```
-[//]: # (END_CODE_EXAMPLE)
 ### Parameters
 Name | Type | Description  | Notes
@@ -325,19 +242,7 @@ Name | Type | Description  | Notes
 **String**
-[//]: # (END_OPERATION)
-[//]: # (START_OPERTATION)
-[//]: # (ENDPOINT:/companies/{identifier}/filings)
-[//]: # (DOC_LINK:CompanyApi.md#get_company_filings)
 # **get_company_filings**
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_filings_v2)
 > ApiResponseCompanyFilings get_company_filings(identifier, opts)
 All Filings by Company
@@ -345,9 +250,6 @@ All Filings by Company
 Returns a complete list of SEC filings for the Company with the given `identifier`
 ### Example
-[//]: # (START_CODE_EXAMPLE)
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -362,6 +264,9 @@ company_api = Intrinio::CompanyApi.new
 identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
 opts = {
+  report_type: nil, # String | Filter by report type. Separate values with commas to return multiple report types.
+  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
   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
 }
@@ -374,13 +279,14 @@ rescue Intrinio::ApiError => e
 end
 ```
-[//]: # (END_CODE_EXAMPLE)
 ### Parameters
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **identifier** | **String**| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |
+ **report_type** | **String**| Filter by report type. Separate values with commas to return multiple report types. | [optional]
+ **start_date** | **Date**| Filed on or after the given date | [optional]
+ **end_date** | **Date**| Filed before or after the given date | [optional]
  **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
  **next_page** | **String**| Gets the next page of data from a previous API call | [optional]
@@ -388,19 +294,7 @@ Name | Type | Description  | Notes
 [**ApiResponseCompanyFilings**](ApiResponseCompanyFilings.md)
-[//]: # (END_OPERATION)
-[//]: # (START_OPERTATION)
-[//]: # (ENDPOINT:/companies/{identifier}/fundamentals)
-[//]: # (DOC_LINK:CompanyApi.md#get_company_fundamentals)
 # **get_company_fundamentals**
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_fundamentals_v2)
 > ApiResponseCompanyFundamentals get_company_fundamentals(identifier, opts)
 All Fundamentals by Company
@@ -408,9 +302,6 @@ All Fundamentals by Company
 Returns all Fundamentals for the Company with the given `identifier`. Returns Fundamentals matching parameters when supplied.
 ### Example
-[//]: # (START_CODE_EXAMPLE)
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -445,8 +336,6 @@ rescue Intrinio::ApiError => e
 end
 ```
-[//]: # (END_CODE_EXAMPLE)
 ### Parameters
 Name | Type | Description  | Notes
@@ -467,19 +356,7 @@ Name | Type | Description  | Notes
 [**ApiResponseCompanyFundamentals**](ApiResponseCompanyFundamentals.md)
-[//]: # (END_OPERATION)
-[//]: # (START_OPERTATION)
-[//]: # (ENDPOINT:/companies/{identifier}/historical_data/{tag})
-[//]: # (DOC_LINK:CompanyApi.md#get_company_historical_data)
 # **get_company_historical_data**
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_historical_data_v2)
 > ApiResponseCompanyHistoricalData get_company_historical_data(identifier, tag, opts)
 Historical Data for Company
@@ -487,9 +364,6 @@ Historical Data for Company
 Returns historical values for the given `tag` and the Company with the given `identifier`
 ### Example
-[//]: # (START_CODE_EXAMPLE)
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -523,8 +397,6 @@ rescue Intrinio::ApiError => e
 end
 ```
-[//]: # (END_CODE_EXAMPLE)
 ### Parameters
 Name | Type | Description  | Notes
@@ -543,19 +415,7 @@ Name | Type | Description  | Notes
 [**ApiResponseCompanyHistoricalData**](ApiResponseCompanyHistoricalData.md)
-[//]: # (END_OPERATION)
-[//]: # (START_OPERTATION)
-[//]: # (ENDPOINT:/companies/{identifier}/news)
-[//]: # (DOC_LINK:CompanyApi.md#get_company_news)
 # **get_company_news**
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_news_v2)
 > ApiResponseCompanyNews get_company_news(identifier, opts)
 All News by Company
@@ -563,9 +423,6 @@ All News by Company
 Returns news for the Company with the given `identifier`
 ### Example
-[//]: # (START_CODE_EXAMPLE)
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -592,8 +449,6 @@ rescue Intrinio::ApiError => e
 end
 ```
-[//]: # (END_CODE_EXAMPLE)
 ### Parameters
 Name | Type | Description  | Notes
@@ -606,19 +461,7 @@ Name | Type | Description  | Notes
 [**ApiResponseCompanyNews**](ApiResponseCompanyNews.md)
-[//]: # (END_OPERATION)
-[//]: # (START_OPERTATION)
-[//]: # (ENDPOINT:/companies/{identifier}/securities)
-[//]: # (DOC_LINK:CompanyApi.md#get_company_securities)
 # **get_company_securities**
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_securities_v2)
 > ApiResponseCompanySecurities get_company_securities(identifier, opts)
 All Securities by Company
@@ -626,9 +469,6 @@ All Securities by Company
 Returns Securities for the Company with the given `identifier`
 ### Example
-[//]: # (START_CODE_EXAMPLE)
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -654,8 +494,6 @@ rescue Intrinio::ApiError => e
 end
 ```
-[//]: # (END_CODE_EXAMPLE)
 ### Parameters
 Name | Type | Description  | Notes
@@ -667,19 +505,7 @@ Name | Type | Description  | Notes
 [**ApiResponseCompanySecurities**](ApiResponseCompanySecurities.md)
-[//]: # (END_OPERATION)
-[//]: # (START_OPERTATION)
-[//]: # (ENDPOINT:/companies/{identifier}/fundamentals/lookup/{statement_code}/{fiscal_year}/{fiscal_period})
-[//]: # (DOC_LINK:CompanyApi.md#lookup_company_fundamental)
 # **lookup_company_fundamental**
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/lookup_company_fundamental_v2)
 > Fundamental lookup_company_fundamental(identifier, statement_code, fiscal_period, fiscal_year)
 Lookup Fundamental by Company
@@ -687,9 +513,6 @@ Lookup Fundamental by Company
 Returns the Fundamental for the Company with the given `identifier` and with the given parameters
 ### Example
-[//]: # (START_CODE_EXAMPLE)
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -718,8 +541,6 @@ rescue Intrinio::ApiError => e
 end
 ```
-[//]: # (END_CODE_EXAMPLE)
 ### Parameters
 Name | Type | Description  | Notes
@@ -733,19 +554,7 @@ Name | Type | Description  | Notes
 [**Fundamental**](Fundamental.md)
-[//]: # (END_OPERATION)
-[//]: # (START_OPERTATION)
-[//]: # (ENDPOINT:/companies/search)
-[//]: # (DOC_LINK:CompanyApi.md#search_companies)
 # **search_companies**
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_companies_v2)
 > ApiResponseCompaniesSearch search_companies(query, opts)
 Search Companies
@@ -753,9 +562,6 @@ Search Companies
 Searches for Companies matching the text `query`
 ### Example
-[//]: # (START_CODE_EXAMPLE)
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -781,8 +587,6 @@ rescue Intrinio::ApiError => e
 end
 ```
-[//]: # (END_CODE_EXAMPLE)
 ### Parameters
 Name | Type | Description  | Notes
@@ -794,5 +598,3 @@ Name | Type | Description  | Notes
 [**ApiResponseCompaniesSearch**](ApiResponseCompaniesSearch.md)
-[//]: # (END_OPERATION)