intrinio-sdk 5.6.1 → 5.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0bd6bcfb6990e71acd55bc8813d9f9ff20ae78fd
-  data.tar.gz: 592fe4084c9052893d947d4b00f01a516a345d08
+SHA256:
+  metadata.gz: 10612aec4776709f86ebcae1583e3a8f2df2f280d1a54e665fb7df8859f22ab2
+  data.tar.gz: c56bf2901e062e6da0c9ba5e6db88d7eb25d8cdad83a1d05056ec38abf2d6c26
 SHA512:
-  metadata.gz: 4334e412d1abc7c21987385da89bca5706b1c72fa53e0bbc8f77113ffc0f17b57ddf6da0cba16ed4126db9a13c593b50493e2ce3f65a4a80c61625a507ee789c
-  data.tar.gz: 505a4c435c4540652db9768f352df97bf1f188579ebcdc49873b582a23927b71f1e3016cbb9c087c6d69bd54531bfa25a7d2950e7a3404e187ba06762edac17e
+  metadata.gz: 8713e1633401fc33567baab298148c2175d182f972599aa6a295eabe233f2ee75b5d24fc848ae4b8f77d9d27d07a11bff44acbae48d7976da1abe351f5820479
+  data.tar.gz: 98de49c33fe99ac075dfaf722a3cc81c83cea548c31b237dda0ccd9e228dfdfa4e34a5c0db8f64d702f801cb8c2f105f5dd33a67df2d17d2a0f0304136f32772

data/Gemfile

@@ -2,6 +2,8 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'retriable', '~> 3.1'
+
 group :development, :test do
   gem 'rake', '~> 12.0.0'
 end

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.14.0
-- Package version: 5.6.1
+- API version: 2.15.3
+- Package version: 5.6.3
 
 
 ## Installation
@@ -31,22 +31,26 @@ Please follow the [installation](#installation) procedure and then run the follo
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
-
+require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
-  config.api_key['api_key'] = 'YOUR API KEY'
+  config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 company_api = Intrinio::CompanyApi.new
+identifier = "AAPL"
 
-begin
-  result = company_api.filter_companies()
-  p result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->filter_companies: #{e}"
-end
+result = company_api.get_company(identifier)
+pp result
 ```
 
+## Retries
+
+By default, automatic retries are enabled for the Ruby SDK. Retries can be enabled/disabled by setting `allow_retries` on the configuration instance to `true`/`false` as seen in the code example above.
+
+If set to `true`, all calls to the API will attempt a successful completion up to 5 times with exponential backoff before failing. If set to `false`, calls to the API will attempt one successful call.
+
 ## API Endpoints
 
 Complete documentation for the Intrinio Ruby SDK is available on the Intrinio website.
@@ -131,8 +135,8 @@ Class | Method | HTTP request | Description
 *Intrinio::SecurityApi* | [**get_security_data_point_text**](docs/SecurityApi.md#get_security_data_point_text) | **GET** /securities/{identifier}/data_point/{tag}/text | Data Point (Text) for Security
 *Intrinio::SecurityApi* | [**get_security_historical_data**](docs/SecurityApi.md#get_security_historical_data) | **GET** /securities/{identifier}/historical_data/{tag} | Historical Data for Security
 *Intrinio::SecurityApi* | [**get_security_intraday_prices**](docs/SecurityApi.md#get_security_intraday_prices) | **GET** /securities/{identifier}/prices/intraday | Intraday Stock Prices for Security
-*Intrinio::SecurityApi* | [**get_security_latest_dividend_record**](docs/SecurityApi.md#get_security_latest_dividend_record) | **GET** /securities/{identifier}/dividends/latest | Lastest Dividend Record for Security
-*Intrinio::SecurityApi* | [**get_security_latest_earnings_record**](docs/SecurityApi.md#get_security_latest_earnings_record) | **GET** /securities/{identifier}/earnings/latest | Lastest Earnings Record for Security
+*Intrinio::SecurityApi* | [**get_security_latest_dividend_record**](docs/SecurityApi.md#get_security_latest_dividend_record) | **GET** /securities/{identifier}/dividends/latest | Latest Dividend Record for Security
+*Intrinio::SecurityApi* | [**get_security_latest_earnings_record**](docs/SecurityApi.md#get_security_latest_earnings_record) | **GET** /securities/{identifier}/earnings/latest | Latest Earnings Record for Security
 *Intrinio::SecurityApi* | [**get_security_price_technicals_adi**](docs/SecurityApi.md#get_security_price_technicals_adi) | **GET** /securities/{identifier}/prices/technicals/adi | Accumulation/Distribution Index
 *Intrinio::SecurityApi* | [**get_security_price_technicals_adtv**](docs/SecurityApi.md#get_security_price_technicals_adtv) | **GET** /securities/{identifier}/prices/technicals/adtv | Average Daily Trading Volume
 *Intrinio::SecurityApi* | [**get_security_price_technicals_adx**](docs/SecurityApi.md#get_security_price_technicals_adx) | **GET** /securities/{identifier}/prices/technicals/adx | Average Directional Index

data/docs/BulkDownloadsApi.md

@@ -53,16 +53,12 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 bulkDownloads_api = Intrinio::BulkDownloadsApi.new
-
-begin
-  result = bulkDownloads_api.get_bulk_download_links
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling BulkDownloadsApi->get_bulk_download_links: #{e}"
-end
+result = bulkDownloads_api.get_bulk_download_links
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)

data/docs/CompanyApi.md

@@ -65,29 +65,26 @@ 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
 
-opts = { 
-  latest_filing_date: nil, # Date | Return companies whose latest 10-Q or 10-K was filed on or after this date
-  sic: nil, # String | Return companies with the given Standard Industrial Classification code
-  template: nil, # String | Return companies with the given financial statement template
-  sector: nil, # String | Return companies in the given industry sector
-  industry_category: nil, # String | Return companies in the given industry category
-  industry_group: nil, # String | Return companies in the given industry group
-  has_fundamentals: true, # BOOLEAN | Return only companies that have fundamentals when true
-  has_stock_prices: true, # BOOLEAN | Return only companies that have stock prices when true
-  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
+opts = {
+  latest_filing_date: nil,
+  sic: nil,
+  template: nil,
+  sector: nil,
+  industry_category: nil,
+  industry_group: nil,
+  has_fundamentals: true,
+  has_stock_prices: true,
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = company_api.get_all_companies(opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_all_companies: #{e}"
-end
+result = company_api.get_all_companies(opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -166,21 +163,18 @@ 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
 
-opts = { 
-  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
+opts = {
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = company_api.get_all_company_news(opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_all_company_news: #{e}"
-end
+result = company_api.get_all_company_news(opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -251,19 +245,14 @@ 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"
 
-identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
-
-
-begin
-  result = company_api.get_company(identifier)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_company: #{e}"
-end
+result = company_api.get_company(identifier)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -333,21 +322,15 @@ 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"
+tag = "marketcap"
 
-identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
-
-tag = "marketcap" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
-
-
-begin
-  result = company_api.get_company_data_point_number(identifier, tag)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_company_data_point_number: #{e}"
-end
+result = company_api.get_company_data_point_number(identifier, tag)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -418,21 +401,15 @@ 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"
+tag = "ceo"
 
-identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
-
-tag = "ceo" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
-
-
-begin
-  result = company_api.get_company_data_point_text(identifier, tag)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_company_data_point_text: #{e}"
-end
+result = company_api.get_company_data_point_text(identifier, tag)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -503,26 +480,22 @@ 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" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
-
-opts = { 
-  report_type: nil, # String | Filter by <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report type</a>. 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
+identifier = "AAPL"
+
+opts = {
+  report_type: nil,
+  start_date: Date.parse("2015-01-01"),
+  end_date: nil,
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = company_api.get_company_filings(identifier, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_company_filings: #{e}"
-end
+result = company_api.get_company_filings(identifier, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -597,31 +570,27 @@ 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" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
-
-opts = { 
-  filed_after: nil, # Date | Filed on or after this date
-  filed_before: nil, # Date | Filed on or before this date
-  reported_only: false, # BOOLEAN | Only as-reported fundamentals
-  fiscal_year: nil, # Integer | Only for the given fiscal year
-  statement_code: nil, # String | Only of the given statement code
-  type: nil, # String | Only of the given type
-  start_date: nil, # Date | Only on or after the given date
-  end_date: nil, # Date | Only on or before 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
+identifier = "AAPL"
+
+opts = {
+  filed_after: nil,
+  filed_before: nil,
+  reported_only: false,
+  fiscal_year: nil,
+  statement_code: nil,
+  type: nil,
+  start_date: nil,
+  end_date: nil,
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = company_api.get_company_fundamentals(identifier, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_company_fundamentals: #{e}"
-end
+result = company_api.get_company_fundamentals(identifier, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -701,30 +670,25 @@ 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" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
-
-tag = "marketcap" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
-
-opts = { 
-  frequency: "daily", # String | Return historical data in the given frequency
-  type: nil, # String | Return historical data for given fiscal period type
-  start_date: Date.parse("2018-01-01"), # Date | Return historical data on or after this date
-  end_date: nil, # Date | Return historical data on or before this date
-  sort_order: "desc", # String | Sort by date `asc` or `desc`
-  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
+identifier = "AAPL"
+tag = "marketcap"
+
+opts = {
+  frequency: "daily",
+  type: nil,
+  start_date: Date.parse("2018-01-01"),
+  end_date: nil,
+  sort_order: "desc",
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = company_api.get_company_historical_data(identifier, tag, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_company_historical_data: #{e}"
-end
+result = company_api.get_company_historical_data(identifier, tag, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -802,27 +766,24 @@ 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
 
-opts = { 
-  ticker: nil, # String | Return IPOs with the given ticker (typically the IPO for the company)
-  status: nil, # String | Return IPOs with the given status. Upcoming IPOs are scheduled to occur in the future. Priced IPOs have occured and the company should be trading publicly. Withdrawn IPOs were planned to occurr but were withdrawn beforehand
-  start_date: nil, # Date | Return IPOs on or after the given date
-  end_date: nil, # Date | Return IPOs on or before the given date
-  offer_amount_greater_than: nil, # Integer | Return IPOs with an offer dollar amount greater than the given amount
-  offer_amount_less_than: nil, # Integer | Return IPOs with an offer dollar amount less than the given amount
-  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
+opts = {
+  ticker: "UBER",
+  status: nil,
+  start_date: nil,
+  end_date: nil,
+  offer_amount_greater_than: nil,
+  offer_amount_less_than: nil,
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = company_api.get_company_ipos(opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_company_ipos: #{e}"
-end
+result = company_api.get_company_ipos(opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -899,23 +860,19 @@ 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"
 
-identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
-
-opts = { 
-  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
+opts = {
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = company_api.get_company_news(identifier, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_company_news: #{e}"
-end
+result = company_api.get_company_news(identifier, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -987,22 +944,18 @@ 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"
 
-identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
-
-opts = { 
-  next_page: nil # String | Gets the next page of data from a previous API call
+opts = {
+  next_page: nil
 }
 
-begin
-  result = company_api.get_company_securities(identifier, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_company_securities: #{e}"
-end
+result = company_api.get_company_securities(identifier, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -1073,25 +1026,17 @@ 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"
+statement_code = "income_statement"
+fiscal_period = "FY"
+fiscal_year = 2017
 
-identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
-
-statement_code = "income_statement" # String | The statement code
-
-fiscal_period = "FY" # String | The fiscal period
-
-fiscal_year = 2017 # Integer | The fiscal year
-
-
-begin
-  result = company_api.lookup_company_fundamental(identifier, statement_code, fiscal_period, fiscal_year)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->lookup_company_fundamental: #{e}"
-end
+result = company_api.lookup_company_fundamental(identifier, statement_code, fiscal_period, fiscal_year)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -1164,22 +1109,18 @@ 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
+query = "Apple"
 
-query = "Apple" # String | Search parameters
-
-opts = { 
-  page_size: 100 # Integer | The number of results to return
+opts = {
+  page_size: 100
 }
 
-begin
-  result = company_api.search_companies(query, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->search_companies: #{e}"
-end
+result = company_api.search_companies(query, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)