update v1.1.4

Finnhub-Stock-API · Jul 28, 2021 · f62cc50 · f62cc50
1 parent 40404ea
commit f62cc50
Show file tree

Hide file tree

Showing 31 changed files with 2,109 additions and 98 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -28,19 +28,18 @@ docs/Model/ETFsCountryExposure.md
 docs/Model/ETFsHoldings.md
 docs/Model/ETFsProfile.md
 docs/Model/ETFsSectorExposure.md
-docs/Model/EarningEstimate.md
 docs/Model/EarningRelease.md
 docs/Model/EarningResult.md
 docs/Model/EarningsCalendar.md
 docs/Model/EarningsCallTranscripts.md
 docs/Model/EarningsCallTranscriptsList.md
 docs/Model/EarningsEstimates.md
+docs/Model/EarningsEstimatesInfo.md
 docs/Model/EconomicCalendar.md
 docs/Model/EconomicCode.md
 docs/Model/EconomicData.md
 docs/Model/EconomicDataInfo.md
 docs/Model/EconomicEvent.md
-docs/Model/Estimate.md
 docs/Model/FDAComitteeMeeting.md
 docs/Model/Filing.md
 docs/Model/FilingSentiment.md
@@ -85,9 +84,11 @@ docs/Model/RedditSentimentContent.md
 docs/Model/Report.md
 docs/Model/RevenueBreakdown.md
 docs/Model/RevenueEstimates.md
+docs/Model/RevenueEstimatesInfo.md
 docs/Model/SECSentimentAnalysis.md
 docs/Model/Sentiment.md
 docs/Model/SimilarityIndex.md
+docs/Model/SimilarityIndexInfo.md
 docs/Model/SocialSentiment.md
 docs/Model/Split.md
 docs/Model/StockCandles.md
@@ -135,19 +136,18 @@ lib/Model/ETFsCountryExposure.php
 lib/Model/ETFsHoldings.php
 lib/Model/ETFsProfile.php
 lib/Model/ETFsSectorExposure.php
-lib/Model/EarningEstimate.php
 lib/Model/EarningRelease.php
 lib/Model/EarningResult.php
 lib/Model/EarningsCalendar.php
 lib/Model/EarningsCallTranscripts.php
 lib/Model/EarningsCallTranscriptsList.php
 lib/Model/EarningsEstimates.php
+lib/Model/EarningsEstimatesInfo.php
 lib/Model/EconomicCalendar.php
 lib/Model/EconomicCode.php
 lib/Model/EconomicData.php
 lib/Model/EconomicDataInfo.php
 lib/Model/EconomicEvent.php
-lib/Model/Estimate.php
 lib/Model/FDAComitteeMeeting.php
 lib/Model/Filing.php
 lib/Model/FilingSentiment.php
@@ -193,9 +193,11 @@ lib/Model/RedditSentimentContent.php
 lib/Model/Report.php
 lib/Model/RevenueBreakdown.php
 lib/Model/RevenueEstimates.php
+lib/Model/RevenueEstimatesInfo.php
 lib/Model/SECSentimentAnalysis.php
 lib/Model/Sentiment.php
 lib/Model/SimilarityIndex.php
+lib/Model/SimilarityIndexInfo.php
 lib/Model/SocialSentiment.php
 lib/Model/Split.php
 lib/Model/StockCandles.php
@@ -215,3 +217,6 @@ lib/Model/TwitterSentimentContent.php
 lib/Model/UpgradeDowngrade.php
 lib/ObjectSerializer.php
 phpunit.xml.dist
+test/Model/EarningsEstimatesInfoTest.php
+test/Model/RevenueEstimatesInfoTest.php
+test/Model/SimilarityIndexInfoTest.php
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Finnhub
 - Finnhub php api clent
 - API version: 1.0.0
-- Package version: 1.1.3
+- Package version: 1.1.4
 
 ## Requirements
 
@@ -14,7 +14,7 @@ In composer.json:
 ```json
 {
   "require": {
-    "finnhub/client": "1.1.3"
+    "finnhub/client": "1.1.4"
   }
 }
 ```
@@ -82,13 +82,13 @@ print_r($client->cryptoSymbols("BINANCE"));
 print_r($client->economicData("MA-USA-656880"));
 
 // Filings
-print_r($client->filings("AAPL", "2020-01-01", "2020-06-11"));
+print_r($client->filings($symbol = "AAPL", $from = "2020-01-01", $to = "2020-06-11"));
 
 // Financials
 print_r($client->financials("AAPL", "bs", "annual"));
 
 // Financials as reported
-print_r($client->financialsReported("AAPL", "annual"));
+print_r($client->financialsReported($symbol = "AAPL", $freq = "annual"));
 
 // Forex exchanges
 print_r($client->forexExchanges());
@@ -204,7 +204,7 @@ print_r($client->mutualFundSectorExposure("VTSAX"));
 print_r($client->mutualFundCountryExposure("VTSAX"));
 
 // Revenue Breakdown
-print_r($client->revenueBreakdown("AAPL"));
+print_r($client->revenueBreakdown($symbol = "AAPL"));
 
 // Social sentiment
 print_r($client->socialSentiment("GME"));
@@ -225,7 +225,10 @@ print_r($client->internationalFilings("AC.TO"));
 print_r($client->filingsSentiment("0000320193-20-000052"));
 
 // Similarity Index
-print_r($client->similarityIndex("AAPL"));
+print_r($client->similarityIndex($symbol = "AAPL"));
+
+//Symbol Search
+print_r($client->symbolSearch("AAPL"));
 
 ?>
 ```

diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
     "name": "finnhub/client",
-    "version": "1.1.3",
+    "version": "1.1.4",
     "description": "Official Finnhub stock API PHP library. https://finnhub.io/",
     "keywords": [
         "openapitools",

diff --git a/docs/Api/DefaultApi.md b/docs/Api/DefaultApi.md
@@ -2578,7 +2578,7 @@ $apiInstance = new Finnhub\Api\DefaultApi(
     $config
 );
 $category = 'category_example'; // string | This parameter can be 1 of the following values <code>general, forex, crypto, merger</code>.
-$min_id = 'min_id_example'; // string | Use this field to get only news after this ID. Default to 0
+$min_id = 56; // int | Use this field to get only news after this ID. Default to 0
 
 try {
     $result = $apiInstance->marketNews($category, $min_id);
@@ -2593,7 +2593,7 @@ try {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **category** | **string**| This parameter can be 1 of the following values &lt;code&gt;general, forex, crypto, merger&lt;/code&gt;. |
- **min_id** | **string**| Use this field to get only news after this ID. Default to 0 | [optional]
+ **min_id** | **int**| Use this field to get only news after this ID. Default to 0 | [optional]
 
 ### Return type
 
@@ -3631,12 +3631,12 @@ Name | Type | Description  | Notes
 ## `stockCandles()`
 
 ```php
-stockCandles($symbol, $resolution, $from, $to, $adjusted): \Finnhub\Model\StockCandles
+stockCandles($symbol, $resolution, $from, $to): \Finnhub\Model\StockCandles
 ```
 
 Stock Candles
 
-<p>Get candlestick data (OHLCV) for stocks
+<p>Get candlestick data (OHLCV) for stocks.</p><p>Daily data will be adjusted for Splits. Intraday data will remain unadjusted.</p>
 
 ### Example
 
@@ -3661,10 +3661,9 @@ $symbol = 'symbol_example'; // string | Symbol.
 $resolution = 'resolution_example'; // string | Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.
 $from = 56; // int | UNIX timestamp. Interval initial value.
 $to = 56; // int | UNIX timestamp. Interval end value.
-$adjusted = 'adjusted_example'; // string | DEPRECATED: this option has been deprecated. All Daily data will be adjusted for Splits and intraday data will remain unadjusted.
 
 try {
-    $result = $apiInstance->stockCandles($symbol, $resolution, $from, $to, $adjusted);
+    $result = $apiInstance->stockCandles($symbol, $resolution, $from, $to);
     print_r($result);
 } catch (Exception $e) {
     echo 'Exception when calling DefaultApi->stockCandles: ', $e->getMessage(), PHP_EOL;
@@ -3679,7 +3678,6 @@ Name | Type | Description  | Notes
  **resolution** | **string**| Supported resolution includes &lt;code&gt;1, 5, 15, 30, 60, D, W, M &lt;/code&gt;.Some timeframes might not be available depending on the exchange. |
  **from** | **int**| UNIX timestamp. Interval initial value. |
  **to** | **int**| UNIX timestamp. Interval end value. |
- **adjusted** | **string**| DEPRECATED: this option has been deprecated. All Daily data will be adjusted for Splits and intraday data will remain unadjusted. | [optional]
 
 ### Return type
 

diff --git a/docs/Model/CompanyProfile.md b/docs/Model/CompanyProfile.md
@@ -29,7 +29,7 @@ Name | Type | Description | Notes
 **ipo** | [**\DateTime**](\DateTime.md) | IPO date. | [optional]
 **market_capitalization** | **float** | Market Capitalization. | [optional]
 **share_outstanding** | **float** | Number of oustanding shares. | [optional]
-**employee_total** | **int** | Number of employee. | [optional]
+**employee_total** | **float** | Number of employee. | [optional]
 **logo** | **string** | Logo image. | [optional]
 **finnhub_industry** | **string** | Finnhub industry classification. | [optional]
 

diff --git a/docs/Model/EarningRelease.md b/docs/Model/EarningRelease.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **quarter** | **int** | Earnings quarter. | [optional]
 **eps_estimate** | **float** | EPS estimate. | [optional]
 **eps_actual** | **float** | EPS actual. | [optional]
-**revenue_estimate** | **int** | Revenue estimate including Finnhub&#39;s proprietary estimates. | [optional]
-**revenue_actual** | **int** | Revenue actual. | [optional]
+**revenue_estimate** | **float** | Revenue estimate including Finnhub&#39;s proprietary estimates. | [optional]
+**revenue_actual** | **float** | Revenue actual. | [optional]
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/EarningsEstimates.md b/docs/Model/EarningsEstimates.md
@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data** | [**\Finnhub\Model\EarningEstimate[]**](EarningEstimate.md) | List of estimates | [optional]
+**data** | [**\Finnhub\Model\EarningsEstimatesInfo[]**](EarningsEstimatesInfo.md) | List of estimates | [optional]
 **freq** | **string** | Frequency: annual or quarterly. | [optional]
 **symbol** | **string** | Company symbol. | [optional]
 

diff --git a/docs/Model/EarningsEstimatesInfo.md b/docs/Model/EarningsEstimatesInfo.md
@@ -0,0 +1,13 @@
+# # EarningsEstimatesInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**eps_avg** | **float** | Average EPS estimates including Finnhub&#39;s proprietary estimates. | [optional]
+**eps_high** | **float** | Highest estimate. | [optional]
+**eps_low** | **float** | Lowest estimate. | [optional]
+**number_analysts** | **int** | Number of Analysts. | [optional]
+**period** | [**\DateTime**](\DateTime.md) | Period. | [optional]
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/IPOEvent.md b/docs/Model/IPOEvent.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **name** | **string** | Company&#39;s name. | [optional]
 **status** | **string** | IPO status. Can take 1 of the following values: &lt;code&gt;expected&lt;/code&gt;,&lt;code&gt;priced&lt;/code&gt;,&lt;code&gt;withdrawn&lt;/code&gt;,&lt;code&gt;filed&lt;/code&gt; | [optional]
 **price** | **string** | Projected price or price range. | [optional]
-**number_of_shares** | **int** | Number of shares offered during the IPO. | [optional]
-**total_shares_value** | **int** | Total shares value. | [optional]
+**number_of_shares** | **float** | Number of shares offered during the IPO. | [optional]
+**total_shares_value** | **float** | Total shares value. | [optional]
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/RevenueEstimates.md b/docs/Model/RevenueEstimates.md
@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data** | [**\Finnhub\Model\Estimate[]**](Estimate.md) | List of estimates | [optional]
+**data** | [**\Finnhub\Model\RevenueEstimatesInfo[]**](RevenueEstimatesInfo.md) | List of estimates | [optional]
 **freq** | **string** | Frequency: annual or quarterly. | [optional]
 **symbol** | **string** | Company symbol. | [optional]
 

diff --git a/docs/Model/RevenueEstimatesInfo.md b/docs/Model/RevenueEstimatesInfo.md
@@ -0,0 +1,13 @@
+# # RevenueEstimatesInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**revenue_avg** | **float** | Average revenue estimates including Finnhub&#39;s proprietary estimates. | [optional]
+**revenue_high** | **float** | Highest estimate. | [optional]
+**revenue_low** | **float** | Lowest estimate. | [optional]
+**number_analysts** | **int** | Number of Analysts. | [optional]
+**period** | [**\DateTime**](\DateTime.md) | Period. | [optional]
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/Sentiment.md b/docs/Model/Sentiment.md
@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**bearish_percent** | **int** |  | [optional]
-**bullish_percent** | **int** |  | [optional]
+**bearish_percent** | **float** |  | [optional]
+**bullish_percent** | **float** |  | [optional]
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/SimilarityIndex.md b/docs/Model/SimilarityIndex.md
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **symbol** | **string** | Symbol. | [optional]
 **cik** | **string** | CIK. | [optional]
-**similarity** | [**\Finnhub\Model\Filing[]**](Filing.md) | Array of filings with its cosine similarity compared to the same report of the previous year. | [optional]
+**similarity** | [**\Finnhub\Model\SimilarityIndexInfo[]**](SimilarityIndexInfo.md) | Array of filings with its cosine similarity compared to the same report of the previous year. | [optional]
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/SimilarityIndexInfo.md b/docs/Model/SimilarityIndexInfo.md
@@ -0,0 +1,20 @@
+# # SimilarityIndexInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cik** | **string** | CIK. | [optional]
+**item1** | **float** | Cosine similarity of Item 1 (Business). This number is only available for Annual reports. | [optional]
+**item1a** | **float** | Cosine similarity of Item 1A (Risk Factors). This number is available for both Annual and Quarterly reports. | [optional]
+**item2** | **float** | Cosine similarity of Item 2 (Management’s Discussion and Analysis of Financial Condition and Results of Operations). This number is only available for Quarterly reports. | [optional]
+**item7** | **float** | Cosine similarity of Item 7 (Management’s Discussion and Analysis of Financial Condition and Results of Operations). This number is only available for Annual reports. | [optional]
+**item7a** | **float** | Cosine similarity of Item 7A (Quantitative and Qualitative Disclosures About Market Risk). This number is only available for Annual reports. | [optional]
+**access_number** | **string** | Access number. | [optional]
+**form** | **string** | Form type. | [optional]
+**filed_date** | **string** | Filed date &lt;code&gt;%Y-%m-%d %H:%M:%S&lt;/code&gt;. | [optional]
+**accepted_date** | **string** | Accepted date &lt;code&gt;%Y-%m-%d %H:%M:%S&lt;/code&gt;. | [optional]
+**report_url** | **string** | Report&#39;s URL. | [optional]
+**filing_url** | **string** | Filing&#39;s URL. | [optional]
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/Transactions.md b/docs/Model/Transactions.md
@@ -10,6 +10,6 @@ Name | Type | Description | Notes
 **filing_date** | [**\DateTime**](\DateTime.md) | Filing date. | [optional]
 **transaction_date** | [**\DateTime**](\DateTime.md) | Transaction date. | [optional]
 **transaction_price** | **float** | Average transaction price. | [optional]
-**transaction_code** | [**\DateTime**](\DateTime.md) | Transaction code. A list of codes and their meanings can be found &lt;a href&#x3D;\&quot;https://www.sec.gov/about/forms/form4data.pdf\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener\&quot;&gt;here&lt;/a&gt;. | [optional]
+**transaction_code** | **string** | Transaction code. A list of codes and their meanings can be found &lt;a href&#x3D;\&quot;https://www.sec.gov/about/forms/form4data.pdf\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener\&quot;&gt;here&lt;/a&gt;. | [optional]
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)