Skip to content

Commit d5df01e

Browse files
freelancing-solutionsfreelancing-solutions
committed
Update Documentation
1 parent 9045c27 commit d5df01e

File tree

15 files changed

+275
-274
lines changed

15 files changed

+275
-274
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ with IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
170170
```
171171

172172

173-
Get Financial News Articles By Ticker
173+
### Get Financial News Articles By Ticker
174174

175175
### Example
176176

‎src/IntelligentStockMarketAPI/api/eod_api.py‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -292,18 +292,18 @@ def v1_eod_date_exchange_code_stock_code_get_with_http_info(self, date, exchange
292292
_request_timeout=local_var_params.get('_request_timeout'),
293293
collection_formats=collection_formats)
294294

295-
def v1_eod_from_to_exchange_code_get(self, exchange_code, to, _from, **kwargs): # noqa: E501
295+
def v1_eod_from_to_exchange_code_get(self, exchange_code, _to, _from, **kwargs): # noqa: E501
296296
"""v1_eod_from_to_exchange_code_get # noqa: E501
297297
298298
return a list of eod historical data on exchange_code from one date to the other # noqa: E501
299299
This method makes a synchronous HTTP request by default. To make an
300300
asynchronous HTTP request, please pass async_req=True
301-
>>> thread = api.v1_eod_from_to_exchange_code_get(exchange_code, to, _from, async_req=True)
301+
>>> thread = api.v1_eod_from_to_exchange_code_get(exchange_code, _to, _from, async_req=True)
302302
>>> result = thread.get()
303303
304304
:param async_req bool: execute request asynchronously
305305
:param str exchange_code: (required)
306-
:param str to: (required)
306+
:param str _to: (required)
307307
:param str _from: (required)
308308
:param _preload_content: if False, the urllib3.HTTPResponse object will
309309
be returned without reading/decoding response
@@ -317,20 +317,20 @@ def v1_eod_from_to_exchange_code_get(self, exchange_code, to, _from, **kwargs):
317317
returns the request thread.
318318
"""
319319
kwargs['_return_http_data_only'] = True
320-
return self.v1_eod_from_to_exchange_code_get_with_http_info(exchange_code, to, _from, **kwargs) # noqa: E501
320+
return self.v1_eod_from_to_exchange_code_get_with_http_info(exchange_code, _to, _from, **kwargs) # noqa: E501
321321

322-
def v1_eod_from_to_exchange_code_get_with_http_info(self, exchange_code, to, _from, **kwargs): # noqa: E501
322+
def v1_eod_from_to_exchange_code_get_with_http_info(self, exchange_code, _to, _from, **kwargs): # noqa: E501
323323
"""v1_eod_from_to_exchange_code_get # noqa: E501
324324
325325
return a list of eod historical data on exchange_code from one date to the other # noqa: E501
326326
This method makes a synchronous HTTP request by default. To make an
327327
asynchronous HTTP request, please pass async_req=True
328-
>>> thread = api.v1_eod_from_to_exchange_code_get_with_http_info(exchange_code, to, _from, async_req=True)
328+
>>> thread = api.v1_eod_from_to_exchange_code_get_with_http_info(exchange_code, _to, _from, async_req=True)
329329
>>> result = thread.get()
330330
331331
:param async_req bool: execute request asynchronously
332332
:param str exchange_code: (required)
333-
:param str to: (required)
333+
:param str _to: (required)
334334
:param str _from: (required)
335335
:param _return_http_data_only: response data without head status code
336336
and headers
@@ -350,7 +350,7 @@ def v1_eod_from_to_exchange_code_get_with_http_info(self, exchange_code, to, _fr
350350

351351
all_params = [
352352
'exchange_code',
353-
'to',
353+
'_to',
354354
'_from'
355355
]
356356
all_params.extend(
@@ -388,8 +388,8 @@ def v1_eod_from_to_exchange_code_get_with_http_info(self, exchange_code, to, _fr
388388
path_params = {}
389389
if 'exchange_code' in local_var_params:
390390
path_params['exchange_code'] = local_var_params['exchange_code'] # noqa: E501
391-
if 'to' in local_var_params:
392-
path_params['_to'] = local_var_params['to'] # noqa: E501
391+
if '_to' in local_var_params:
392+
path_params['_to'] = local_var_params['_to'] # noqa: E501
393393
if '_from' in local_var_params:
394394
path_params['_from'] = local_var_params['_from'] # noqa: E501
395395

@@ -424,18 +424,18 @@ def v1_eod_from_to_exchange_code_get_with_http_info(self, exchange_code, to, _fr
424424
_request_timeout=local_var_params.get('_request_timeout'),
425425
collection_formats=collection_formats)
426426

427-
def v1_eod_from_to_stock_code_get(self, stock_code, to, _from, **kwargs): # noqa: E501
427+
def v1_eod_from_to_stock_code_get(self, stock_code, _to, _from, **kwargs): # noqa: E501
428428
"""v1_eod_from_to_stock_code_get # noqa: E501
429429
430430
will return end of day data for a certain stock at a given date # noqa: E501
431431
This method makes a synchronous HTTP request by default. To make an
432432
asynchronous HTTP request, please pass async_req=True
433-
>>> thread = api.v1_eod_from_to_stock_code_get(stock_code, to, _from, async_req=True)
433+
>>> thread = api.v1_eod_from_to_stock_code_get(stock_code, _to, _from, async_req=True)
434434
>>> result = thread.get()
435435
436436
:param async_req bool: execute request asynchronously
437437
:param str stock_code: (required)
438-
:param str to: (required)
438+
:param str _to: (required)
439439
:param str _from: (required)
440440
:param _preload_content: if False, the urllib3.HTTPResponse object will
441441
be returned without reading/decoding response
@@ -449,15 +449,15 @@ def v1_eod_from_to_stock_code_get(self, stock_code, to, _from, **kwargs): # noq
449449
returns the request thread.
450450
"""
451451
kwargs['_return_http_data_only'] = True
452-
return self.v1_eod_from_to_stock_code_get_with_http_info(stock_code, to, _from, **kwargs) # noqa: E501
452+
return self.v1_eod_from_to_stock_code_get_with_http_info(stock_code, _to, _from, **kwargs) # noqa: E501
453453

454-
def v1_eod_from_to_stock_code_get_with_http_info(self, stock_code, to, _from, **kwargs): # noqa: E501
454+
def v1_eod_from_to_stock_code_get_with_http_info(self, stock_code, _to, _from, **kwargs): # noqa: E501
455455
"""v1_eod_from_to_stock_code_get # noqa: E501
456456
457457
will return end of day data for a certain stock at a given date # noqa: E501
458458
This method makes a synchronous HTTP request by default. To make an
459459
asynchronous HTTP request, please pass async_req=True
460-
>>> thread = api.v1_eod_from_to_stock_code_get_with_http_info(stock_code, to, _from, async_req=True)
460+
>>> thread = api.v1_eod_from_to_stock_code_get_with_http_info(stock_code, _to, _from, async_req=True)
461461
>>> result = thread.get()
462462
463463
:param async_req bool: execute request asynchronously
@@ -482,7 +482,7 @@ def v1_eod_from_to_stock_code_get_with_http_info(self, stock_code, to, _from, **
482482

483483
all_params = [
484484
'stock_code',
485-
'to',
485+
'_to',
486486
'_from'
487487
]
488488
all_params.extend(
@@ -507,8 +507,8 @@ def v1_eod_from_to_stock_code_get_with_http_info(self, stock_code, to, _from, **
507507
local_var_params['stock_code'] is None): # noqa: E501
508508
raise ApiValueError("Missing the required parameter `stock_code` when calling `v1_eod_from_to_stock_code_get`") # noqa: E501
509509
# verify the required parameter 'to' is set
510-
if self.api_client.client_side_validation and ('to' not in local_var_params or # noqa: E501
511-
local_var_params['to'] is None): # noqa: E501
510+
if self.api_client.client_side_validation and ('_to' not in local_var_params or # noqa: E501
511+
local_var_params['_to'] is None): # noqa: E501
512512
raise ApiValueError("Missing the required parameter `to` when calling `v1_eod_from_to_stock_code_get`") # noqa: E501
513513
# verify the required parameter '_from' is set
514514
if self.api_client.client_side_validation and ('_from' not in local_var_params or # noqa: E501
@@ -520,8 +520,8 @@ def v1_eod_from_to_stock_code_get_with_http_info(self, stock_code, to, _from, **
520520
path_params = {}
521521
if 'stock_code' in local_var_params:
522522
path_params['stock_code'] = local_var_params['stock_code'] # noqa: E501
523-
if 'to' in local_var_params:
524-
path_params['_to'] = local_var_params['to'] # noqa: E501
523+
if '_to' in local_var_params:
524+
path_params['_to'] = local_var_params['_to'] # noqa: E501
525525
if '_from' in local_var_params:
526526
path_params['_from'] = local_var_params['_from'] # noqa: E501
527527

‎src/IntelligentStockMarketAPI/rest.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
import six
2525
from six.moves.urllib.parse import urlencode
2626
import urllib3
27+
from urllib3.exceptions import SSLError
2728

2829
from src.IntelligentStockMarketAPI.exceptions import ApiException, ApiValueError
2930

@@ -211,7 +212,7 @@ def request(self, method, url, query_params=None, headers=None,
211212
preload_content=_preload_content,
212213
timeout=timeout,
213214
headers=headers)
214-
except urllib3.exceptions.SSLError as e:
215+
except SSLError as e:
215216
msg = "{0}\n{1}".format(type(e).__name__, str(e))
216217
raise ApiException(status=0, reason=msg)
217218

‎src/docs/AddressResponse.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# AddressResponse
22

33
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
6-
**message** | **str** | message explaining the response | [optional]
7-
**payload** | [**GeneralAddress**](GeneralAddress.md) | Company Address | [optional]
8-
**status** | **bool** | if status is True data was found and payload contains valid data | [optional]
4+
| Name | Type | Description | Notes |
5+
|-------------|-----------------------------------------|------------------------------------------------------------------|------------|
6+
| **message** | **str** | message explaining the response | [optional] |
7+
| **payload** | [**GeneralAddress**](GeneralAddress.md) | Company Address | [optional] |
8+
| **status** | **bool** | if status is True data was found and payload contains valid data | [optional] |
99

10-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
1111

1212

‎src/docs/Analyst.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# Analyst
22

33
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
6-
**buy** | **int** | Buy Rating | [optional]
7-
**fundamental_id** | **str** | Fundamental id | [optional]
8-
**hold** | **int** | Hold Rating | [optional]
9-
**rating** | **float** | Analyst Overall Rating | [optional]
10-
**sell** | **int** | Sell Rating | [optional]
11-
**strong_buy** | **int** | Strong buy Rating | [optional]
12-
**strong_sell** | **int** | Strong sell Rating | [optional]
13-
**target_price** | **float** | Target Price | [optional]
4+
| Name | Type | Description | Notes |
5+
|--------------------|-----------|------------------------|------------|
6+
| **buy** | **int** | Buy Rating | [optional] |
7+
| **fundamental_id** | **str** | Fundamental id | [optional] |
8+
| **hold** | **int** | Hold Rating | [optional] |
9+
| **rating** | **float** | Analyst Overall Rating | [optional] |
10+
| **sell** | **int** | Sell Rating | [optional] |
11+
| **strong_buy** | **int** | Strong buy Rating | [optional] |
12+
| **strong_sell** | **int** | Strong sell Rating | [optional] |
13+
| **target_price** | **float** | Target Price | [optional] |
1414

15-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
1616

1717

‎src/docs/AnnualBalanceSheet.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# AnnualBalanceSheet
22

33
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
6-
**balance_sheet** | [**BalanceSheet**](BalanceSheet.md) | | [optional]
7-
**filing_date** | **date** | Date of filing | [optional]
4+
| Name | Type | Description | Notes |
5+
|-------------------|-------------------------------------|----------------|------------|
6+
| **balance_sheet** | [**BalanceSheet**](BalanceSheet.md) | | [optional] |
7+
| **filing_date** | **date** | Date of filing | [optional] |
88

9-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
1010

1111

‎src/docs/AnnualBalanceSheetResponse.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# AnnualBalanceSheetResponse
22

33
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
6-
**message** | **str** | message explaining the response | [optional]
7-
**payload** | [**AnnualBalanceSheet**](AnnualBalanceSheet.md) | | [optional]
8-
**status** | **bool** | if status is True data was found and payload contains valid data | [optional]
4+
| Name | Type | Description | Notes |
5+
|-------------|-------------------------------------------------|------------------------------------------------------------------|------------|
6+
| **message** | **str** | message explaining the response | [optional] |
7+
| **payload** | [**AnnualBalanceSheet**](AnnualBalanceSheet.md) | | [optional] |
8+
| **status** | **bool** | if status is True data was found and payload contains valid data | [optional] |
99

10-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
1111

1212

0 commit comments

Comments
 (0)