Merge branch 'feature/implement-screening-profiles' into 'master'

Implement screening profiles See merge request babakloni/investor8.core!463
investoreight · Jul 27, 2023 · 98a3e36 · 98a3e36
1 parent 7134171
commit 98a3e36
Show file tree

Hide file tree

Showing 14 changed files with 1,064 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ Investoreight API Documentation:  https://api.investoreight.com/api-docs/index.h
 This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 1.0.1
-- Package version: 1.1.103
+- Package version: 1.1.104
 - Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
 For more information, please visit [https://www.investoreight.com](https://www.investoreight.com)
 
@@ -258,6 +258,9 @@ Class | Method | HTTP request | Description
 *ScreenerApi* | [**get_all_sectors_returns_today_sa**](docs/ScreenerApi.md#get_all_sectors_returns_today_sa) | **GET** /Screener/sa/sector/returns/today | 
 *ScreenerApi* | [**get_dow_tickers**](docs/ScreenerApi.md#get_dow_tickers) | **GET** /Screener/dow/tickers | 
 *ScreenerApi* | [**get_list_ip_os**](docs/ScreenerApi.md#get_list_ip_os) | **GET** /Screener/ipo/list | 
+*ScreenerApi* | [**get_list_screening_profiles**](docs/ScreenerApi.md#get_list_screening_profiles) | **GET** /Screener/profile/list | 
+*ScreenerApi* | [**get_screening_profile**](docs/ScreenerApi.md#get_screening_profile) | **GET** /Screener/profile/{id} | 
+*ScreenerApi* | [**get_screening_profile_by_name**](docs/ScreenerApi.md#get_screening_profile_by_name) | **GET** /Screener/profile/name/{name} | 
 *ScreenerApi* | [**get_top_stocks**](docs/ScreenerApi.md#get_top_stocks) | **GET** /Screener/top/{category} | 
 *ScreenerApi* | [**get_upcoming_ipos**](docs/ScreenerApi.md#get_upcoming_ipos) | **GET** /Screener/ipo/upcoming | 
 *ScreenerApi* | [**search**](docs/ScreenerApi.md#search) | **GET** /Screener/search | 
@@ -328,8 +331,10 @@ Class | Method | HTTP request | Description
  - [GetListMetricViewsDto](docs/GetListMetricViewsDto.md)
  - [GetListMetricsDescriptionDto](docs/GetListMetricsDescriptionDto.md)
  - [GetListMetricsMetadataDto](docs/GetListMetricsMetadataDto.md)
+ - [GetListScreeningProfilesDto](docs/GetListScreeningProfilesDto.md)
  - [GetMetricViewDto](docs/GetMetricViewDto.md)
  - [GetMetricsMetadataDto](docs/GetMetricsMetadataDto.md)
+ - [GetScreeningProfileDto](docs/GetScreeningProfileDto.md)
  - [GetScreensByUserDto](docs/GetScreensByUserDto.md)
  - [GetWatchlistsByUserDto](docs/GetWatchlistsByUserDto.md)
  - [HistoricalDailyMetricsDto](docs/HistoricalDailyMetricsDto.md)

diff --git a/docs/GetListScreeningProfilesDto.md b/docs/GetListScreeningProfilesDto.md
@@ -0,0 +1,13 @@
+# GetListScreeningProfilesDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** |  | [optional] 
+**profile_name** | **str** |  | [optional] 
+**conditions** | **str** |  | [optional] 
+**sort_metric** | **str** |  | [optional] 
+**sort_order** | **str** |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/GetScreeningProfileDto.md b/docs/GetScreeningProfileDto.md
@@ -0,0 +1,16 @@
+# GetScreeningProfileDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** |  | [optional] 
+**profile_name** | **str** |  | [optional] 
+**conditions** | **str** |  | [optional] 
+**user_id** | **str** |  | [optional] 
+**type** | **str** |  | [optional] 
+**sort_metric** | **str** |  | [optional] 
+**sort_order** | **str** |  | [optional] 
+**last_modified** | **int** |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/ScreenerApi.md b/docs/ScreenerApi.md
@@ -8,6 +8,9 @@ Method | HTTP request | Description
 [**get_all_sectors_returns_today_sa**](ScreenerApi.md#get_all_sectors_returns_today_sa) | **GET** /Screener/sa/sector/returns/today | 
 [**get_dow_tickers**](ScreenerApi.md#get_dow_tickers) | **GET** /Screener/dow/tickers | 
 [**get_list_ip_os**](ScreenerApi.md#get_list_ip_os) | **GET** /Screener/ipo/list | 
+[**get_list_screening_profiles**](ScreenerApi.md#get_list_screening_profiles) | **GET** /Screener/profile/list | 
+[**get_screening_profile**](ScreenerApi.md#get_screening_profile) | **GET** /Screener/profile/{id} | 
+[**get_screening_profile_by_name**](ScreenerApi.md#get_screening_profile_by_name) | **GET** /Screener/profile/name/{name} | 
 [**get_top_stocks**](ScreenerApi.md#get_top_stocks) | **GET** /Screener/top/{category} | 
 [**get_upcoming_ipos**](ScreenerApi.md#get_upcoming_ipos) | **GET** /Screener/ipo/upcoming | 
 [**search**](ScreenerApi.md#search) | **GET** /Screener/search | 
@@ -238,6 +241,170 @@ Name | Type | Description  | Notes
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **get_list_screening_profiles**
+> list[GetListScreeningProfilesDto] get_list_screening_profiles()
+
+
+
+### Example
+```python
+from __future__ import print_function
+import time
+import investor8_sdk
+from investor8_sdk.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: apiKey
+configuration = investor8_sdk.Configuration()
+configuration.api_key['apiKey'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['apiKey'] = 'Bearer'
+# Configure API key authorization: bearerCoreAuth
+configuration = investor8_sdk.Configuration()
+configuration.api_key['Authorization'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['Authorization'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = investor8_sdk.ScreenerApi(investor8_sdk.ApiClient(configuration))
+
+try:
+    api_response = api_instance.get_list_screening_profiles()
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling ScreenerApi->get_list_screening_profiles: %s\n" % e)
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**list[GetListScreeningProfilesDto]**](GetListScreeningProfilesDto.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey), [bearerCoreAuth](../README.md#bearerCoreAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/plain, application/json, text/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **get_screening_profile**
+> GetScreeningProfileDto get_screening_profile(id)
+
+
+
+### Example
+```python
+from __future__ import print_function
+import time
+import investor8_sdk
+from investor8_sdk.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: apiKey
+configuration = investor8_sdk.Configuration()
+configuration.api_key['apiKey'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['apiKey'] = 'Bearer'
+# Configure API key authorization: bearerCoreAuth
+configuration = investor8_sdk.Configuration()
+configuration.api_key['Authorization'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['Authorization'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = investor8_sdk.ScreenerApi(investor8_sdk.ApiClient(configuration))
+id = 'id_example' # str | 
+
+try:
+    api_response = api_instance.get_screening_profile(id)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling ScreenerApi->get_screening_profile: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **str**|  | 
+
+### Return type
+
+[**GetScreeningProfileDto**](GetScreeningProfileDto.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey), [bearerCoreAuth](../README.md#bearerCoreAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **get_screening_profile_by_name**
+> GetScreeningProfileDto get_screening_profile_by_name(name)
+
+
+
+### Example
+```python
+from __future__ import print_function
+import time
+import investor8_sdk
+from investor8_sdk.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: apiKey
+configuration = investor8_sdk.Configuration()
+configuration.api_key['apiKey'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['apiKey'] = 'Bearer'
+# Configure API key authorization: bearerCoreAuth
+configuration = investor8_sdk.Configuration()
+configuration.api_key['Authorization'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['Authorization'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = investor8_sdk.ScreenerApi(investor8_sdk.ApiClient(configuration))
+name = 'name_example' # str | 
+
+try:
+    api_response = api_instance.get_screening_profile_by_name(name)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling ScreenerApi->get_screening_profile_by_name: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **str**|  | 
+
+### Return type
+
+[**GetScreeningProfileDto**](GetScreeningProfileDto.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey), [bearerCoreAuth](../README.md#bearerCoreAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **get_top_stocks**
 > list[DetailedLatestPriceDto] get_top_stocks(category, _date=_date, sector=sector, count=count, exchange=exchange, index=index, refresh_cache=refresh_cache)
 

diff --git a/investor8_sdk/__init__.py b/investor8_sdk/__init__.py
@@ -52,8 +52,10 @@
 from investor8_sdk.models.get_list_metric_views_dto import GetListMetricViewsDto
 from investor8_sdk.models.get_list_metrics_description_dto import GetListMetricsDescriptionDto
 from investor8_sdk.models.get_list_metrics_metadata_dto import GetListMetricsMetadataDto
+from investor8_sdk.models.get_list_screening_profiles_dto import GetListScreeningProfilesDto
 from investor8_sdk.models.get_metric_view_dto import GetMetricViewDto
 from investor8_sdk.models.get_metrics_metadata_dto import GetMetricsMetadataDto
+from investor8_sdk.models.get_screening_profile_dto import GetScreeningProfileDto
 from investor8_sdk.models.get_screens_by_user_dto import GetScreensByUserDto
 from investor8_sdk.models.get_watchlists_by_user_dto import GetWatchlistsByUserDto
 from investor8_sdk.models.historical_daily_metrics_dto import HistoricalDailyMetricsDto