intrinio-sdk 6.43.0 → 6.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6782b47fe96ebc67663f5a4544ec7bbc9925b308566d4cd6fe16f40cde2e7271
-  data.tar.gz: f8c761e19f7db14d2d7cbc40beb4c8bf55bff66802dba5f8a844bec815d9ccc7
+  metadata.gz: ac53db909d4c00a8bb0e5bab3ff7bd81e9e2cd214599b328a8e1d3498fc72f79
+  data.tar.gz: ea533f9103406307d7c0addb1a47f07d2e753b328d15ac16923640e9d91b2a93
 SHA512:
-  metadata.gz: 2d9ef6507df56e3138944d601df6475897d2414cce41581b9f1bc635f0be43719bc90face98a0a4bd86f89f3184d10e5000fc85562f6ad7e3822856ac3b94888
-  data.tar.gz: 23d951f97cd5e56c136de0e08175451efdd0d0a0f13cf889933a7a1547acfc77fbb9d775496c43d99aeeb80fa556afa7708c055792a7128b05729e8f4b8cd44c
+  metadata.gz: 49747ecb4f022134a2cbd6b4a14602a674b7ff8d48b0922ce8faf4ed683bc3c665560b6f6f8347e09b98b0b40b9d58655c114e0a2a324198a4ad6998158744e9
+  data.tar.gz: 4b549f4c58b4cc3bd8f238d42dc2a70ce8c636617e74aafa93dfba10e80cca9e7616ff79ee7a62bedd7cecd14f11e6e3b8c822b9bb90ec56b823d99bab5e82e1

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.115.0
-- Package version: 6.43.0
+- API version: 2.122.0
+- Package version: 6.44.0
 
 
 ## Installation
@@ -61,6 +61,7 @@ A listing of classes and methods is also provided below:
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*Intrinio::AccountApi* | [**get_account_current_usage**](docs/AccountApi.md#get_account_current_usage) | **GET** /account | Account Current Usage
 *Intrinio::BulkDownloadsApi* | [**get_bulk_download_links**](docs/BulkDownloadsApi.md#get_bulk_download_links) | **GET** /bulk_downloads/links | All Links
 *Intrinio::CompanyApi* | [**all_expected_earnings_dates**](docs/CompanyApi.md#all_expected_earnings_dates) | **GET** /companies/upcoming_earnings | All Expected Earnings Dates
 *Intrinio::CompanyApi* | [**expected_earnings_dates_by_company**](docs/CompanyApi.md#expected_earnings_dates_by_company) | **GET** /companies/{identifier}/upcoming_earnings | Expected Earnings Dates by Company
@@ -322,7 +323,10 @@ Class | Method | HTTP request | Description
 
 ## Models
 
+ - [Intrinio::AccountCurrentUsage](docs/AccountCurrentUsage.md)
  - [Intrinio::AccumulationDistributionIndexTechnicalValue](docs/AccumulationDistributionIndexTechnicalValue.md)
+ - [Intrinio::ApiResponseAccountUsages](docs/ApiResponseAccountUsages.md)
+ - [Intrinio::ApiResponseAccountUsagesAccount](docs/ApiResponseAccountUsagesAccount.md)
  - [Intrinio::ApiResponseAllExpectedEarningsDates](docs/ApiResponseAllExpectedEarningsDates.md)
  - [Intrinio::ApiResponseBulkDownloadLinks](docs/ApiResponseBulkDownloadLinks.md)
  - [Intrinio::ApiResponseCompanies](docs/ApiResponseCompanies.md)

data/docs/AccountApi.md

@@ -0,0 +1,81 @@
+# Intrinio::AccountApi
+
+All URIs are relative to *https://api-v2.intrinio.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_account_current_usage**](AccountApi.md#get_account_current_usage) | **GET** /account | Account Current Usage
+
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::AccountApi)
+
+[//]: # (METHOD:get_account_current_usage)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseAccountUsages)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseAccountUsages.md)
+
+[//]: # (OPERATION:get_account_current_usage_v2)
+
+[//]: # (ENDPOINT:/account)
+
+[//]: # (DOCUMENT_LINK:AccountApi.md#get_account_current_usage)
+
+## **get_account_current_usage**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_account_current_usage_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseAccountUsages get_account_current_usage
+
+#### Account Current Usage
+
+
+Returns a list of all access codes available with their current usage.
+
+[//]: # (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
+
+account_api = Intrinio::AccountApi.new
+result = account_api.get_account_current_usage
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+This endpoint does not need any parameter.
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseAccountUsages**](ApiResponseAccountUsages.md)
+
+[//]: # (END_OPERATION)
+

data/docs/AccountCurrentUsage.md

@@ -0,0 +1,25 @@
+
+
+[//]: # (CLASS:Intrinio::AccountCurrentUsage)
+
+[//]: # (KIND:object)
+
+### Intrinio::AccountCurrentUsage
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**access_code** | String | The access code.  
+**restriction** | String | Restrictions on this access code.  
+**count** | String | The current count of API calls using this access code for this period.  
+**limit** | String | The limit for this access code  
+**seconds_until_reset** | String | The period in seconds for count reset.  
+**percentage_used** | String | The percentage of limit used.  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/ApiResponseAccountUsages.md

@@ -0,0 +1,27 @@
+
+
+[//]: # (CLASS:Intrinio::ApiResponseAccountUsages)
+
+[//]: # (KIND:object)
+
+### Intrinio::ApiResponseAccountUsages
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**usage** | [**Array<AccountCurrentUsage>**](AccountCurrentUsage.md) | The usages on the account.  
+**account** | [**ApiResponseAccountUsagesAccount**](ApiResponseAccountUsagesAccount.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::AccountCurrentUsage)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::ApiResponseAccountUsagesAccount)
+
+
+

data/docs/ApiResponseAccountUsagesAccount.md

@@ -0,0 +1,20 @@
+
+
+[//]: # (CLASS:Intrinio::ApiResponseAccountUsagesAccount)
+
+[//]: # (KIND:object)
+
+### Intrinio::ApiResponseAccountUsagesAccount
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**email** | String | The email address for the account.  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/ApiResponseCompanyExpectedEarningsDates.md

@@ -12,7 +12,7 @@
 
 Name | Type | Description
 ------------ | ------------- | -------------
-**expected_earnings_dates** | [**Array<EarningsDateEstimate>**](EarningsDateEstimate.md) |   
+**expected_earnings_dates** | [**Array<EarningsDateEstimate>**](EarningsDateEstimate.md) | Expected earnings dates.  
 **company** | [**CompanySummary**](CompanySummary.md) |   
 **next_page** | String | The token required to request the next page of the data. If null, no further data is available.  
 

data/docs/CompanyApi.md

@@ -802,8 +802,8 @@ Intrinio.configure do |config|
 end
 
 company_api = Intrinio::CompanyApi.new
-identifier = "$$v2_company_data_point_identifier_default$$"
-tag = "$$v2_company_data_point_item_number_default$$"
+identifier = "AAPL"
+tag = "marketcap"
 
 result = company_api.get_company_data_point_number(identifier, tag)
 pp result
@@ -820,8 +820,8 @@ pp result
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **identifier** | String| $$v2_company_data_point_identifier_description$$ |   
- **tag** | String| $$v2_company_data_point_item_description$$ |   
+ **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   
+ **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |   
 
 [//]: # (END_PARAMETERS)
 
@@ -881,8 +881,8 @@ Intrinio.configure do |config|
 end
 
 company_api = Intrinio::CompanyApi.new
-identifier = "$$v2_company_data_point_identifier_default$$"
-tag = "$$v2_company_data_point_item_text_default$$"
+identifier = "AAPL"
+tag = "ceo"
 
 result = company_api.get_company_data_point_text(identifier, tag)
 pp result
@@ -899,8 +899,8 @@ pp result
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **identifier** | String| $$v2_company_data_point_identifier_description$$ |   
- **tag** | String| $$v2_company_data_point_item_description$$ |   
+ **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   
+ **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |   
 
 [//]: # (END_PARAMETERS)
 
@@ -1140,7 +1140,7 @@ Name | Type | Description  | Notes
 #### Historical Data for Company
 
 
-$$v2_company_historical_data_description$$
+Returns historical values for the given `tag` and the Company with the given `identifier`
 
 [//]: # (END_OVERVIEW)
 
@@ -1160,8 +1160,8 @@ Intrinio.configure do |config|
 end
 
 company_api = Intrinio::CompanyApi.new
-identifier = "$$v2_company_historical_data_identifier_default$$"
-tag = "$$v2_company_historical_data_item_default$$"
+identifier = "AAPL"
+tag = "marketcap"
 
 opts = {
   frequency: "daily",
@@ -1188,8 +1188,8 @@ pp result
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **identifier** | String| $$v2_company_historical_data_identifier_description$$ |   
- **tag** | String| $$v2_company_historical_data_item_description$$ |   
+ **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   
+ **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |   
  **frequency** | String| Return historical data in the given frequency | [optional] [default to daily]  
  **type** | String| Return historical data for given fiscal period type | [optional]   
  **start_date** | Date| Return historical data on or after this date | [optional]   

data/docs/DataPointApi.md

@@ -38,7 +38,7 @@ Method | HTTP request | Description
 #### Data Point (Number)
 
 
-$$v2_data_point_number_description$$
+Returns a numeric value for the given `tag` and the entity with the given `identifier`
 
 [//]: # (END_OVERVIEW)
 
@@ -58,8 +58,8 @@ Intrinio.configure do |config|
 end
 
 dataPoint_api = Intrinio::DataPointApi.new
-identifier = "$$v2_data_point_identifier_default$$"
-tag = "$$v2_data_point_item_number_default$$"
+identifier = "AAPL"
+tag = "marketcap"
 
 result = dataPoint_api.get_data_point_number(identifier, tag)
 pp result
@@ -76,8 +76,8 @@ pp result
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **identifier** | String| $$v2_data_point_identifier_description$$ |   
- **tag** | String| $$v2_data_point_item_description$$ |   
+ **identifier** | String| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) |   
+ **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |   
 
 [//]: # (END_PARAMETERS)
 
@@ -117,7 +117,7 @@ Name | Type | Description  | Notes
 #### Data Point (Text)
 
 
-$$v2_data_point_text_description$$
+Returns a text value for the given `tag` for the Security with the given `identifier`
 
 [//]: # (END_OVERVIEW)
 
@@ -137,8 +137,8 @@ Intrinio.configure do |config|
 end
 
 dataPoint_api = Intrinio::DataPointApi.new
-identifier = "$$v2_data_point_identifier_default$$"
-tag = "$$v2_data_point_item_text_default$$"
+identifier = "AAPL"
+tag = "ceo"
 
 result = dataPoint_api.get_data_point_text(identifier, tag)
 pp result
@@ -155,8 +155,8 @@ pp result
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **identifier** | String| $$v2_data_point_identifier_description$$ |   
- **tag** | String| $$v2_data_point_item_description$$ |   
+ **identifier** | String| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) |   
+ **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |   
 
 [//]: # (END_PARAMETERS)
 

data/docs/FundamentalsApi.md

@@ -398,7 +398,7 @@ end
 
 fundamentals_api = Intrinio::FundamentalsApi.new
 id = "AAPL-income_statement-2020-FY"
-tag = "$$v2_data_point_item_text_default$$"
+tag = "ceo"
 
 result = fundamentals_api.get_fundamental_standardized_financials_dimensions(id, tag)
 pp result
@@ -416,7 +416,7 @@ pp result
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | String| The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental |   
- **tag** | String| $$v2_data_point_item_description$$ |   
+ **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |   
 
 [//]: # (END_PARAMETERS)
 

data/docs/HistoricalDataApi.md

@@ -37,7 +37,7 @@ Method | HTTP request | Description
 #### Historical Data
 
 
-$$v2_historical_data_description$$
+Returns historical values for the given `tag` and the entity represented by the given `identifier`
 
 [//]: # (END_OVERVIEW)
 
@@ -57,8 +57,8 @@ Intrinio.configure do |config|
 end
 
 historicalData_api = Intrinio::HistoricalDataApi.new
-identifier = "$$v2_historical_data_identifier_default$$"
-tag = "$$v2_historical_data_item_default$$"
+identifier = "AAPL"
+tag = "marketcap"
 
 opts = {
   frequency: "daily",
@@ -85,8 +85,8 @@ pp result
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **identifier** | String| $$v2_historical_data_identifier_description$$ |   
- **tag** | String| $$v2_historical_data_item_description$$ |   
+ **identifier** | String| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) |   
+ **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |   
  **frequency** | String| Return historical data in the given frequency | [optional] [default to daily]  
  **type** | String| Filter by type, when applicable | [optional]   
  **start_date** | Date| Get historical data on or after this date | [optional]