Merge branch 'feature/implement-get-list-metrics-description-api' int…

…o 'master' Implement GetListMetricsDescription API See merge request babakloni/investor8.core!448
investoreight · Jun 14, 2023 · 74cd9d7 · 74cd9d7
1 parent e10949b
commit 74cd9d7
Show file tree

Hide file tree

Showing 11 changed files with 399 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.89
+- Package version: 1.1.90
 - Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
 For more information, please visit [https://www.investoreight.com](https://www.investoreight.com)
 
@@ -223,6 +223,7 @@ Class | Method | HTTP request | Description
 *MetricsApi* | [**get_latest_growth_metrics**](docs/MetricsApi.md#get_latest_growth_metrics) | **GET** /Metrics/growth/latest/{ticker} | 
 *MetricsApi* | [**get_list_financial_metrics_metadata**](docs/MetricsApi.md#get_list_financial_metrics_metadata) | **GET** /Metrics/metadata/list/financials | 
 *MetricsApi* | [**get_list_metric_views**](docs/MetricsApi.md#get_list_metric_views) | **GET** /Metrics/view/list | 
+*MetricsApi* | [**get_list_metrics_description**](docs/MetricsApi.md#get_list_metrics_description) | **GET** /Metrics/description/list | 
 *MetricsApi* | [**get_list_metrics_metadata**](docs/MetricsApi.md#get_list_metrics_metadata) | **GET** /Metrics/metadata/list | 
 *MetricsApi* | [**get_market_index_returns**](docs/MetricsApi.md#get_market_index_returns) | **GET** /Metrics/merket/returns/{ticker} | 
 *MetricsApi* | [**get_metric_view**](docs/MetricsApi.md#get_metric_view) | **GET** /Metrics/view/{id} | 
@@ -324,6 +325,7 @@ Class | Method | HTTP request | Description
  - [FinancialTag](docs/FinancialTag.md)
  - [FinancialsGrowth](docs/FinancialsGrowth.md)
  - [GetListMetricViewsDto](docs/GetListMetricViewsDto.md)
+ - [GetListMetricsDescriptionDto](docs/GetListMetricsDescriptionDto.md)
  - [GetListMetricsMetadataDto](docs/GetListMetricsMetadataDto.md)
  - [GetMetricViewDto](docs/GetMetricViewDto.md)
  - [GetMetricsMetadataDto](docs/GetMetricsMetadataDto.md)

diff --git a/docs/GetListMetricsDescriptionDto.md b/docs/GetListMetricsDescriptionDto.md
@@ -0,0 +1,12 @@
+# GetListMetricsDescriptionDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** |  | [optional] 
+**metric_name** | **str** |  | [optional] 
+**display_name** | **str** |  | [optional] 
+**description** | **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/MetricsApi.md b/docs/MetricsApi.md
@@ -22,6 +22,7 @@ Method | HTTP request | Description
 [**get_latest_growth_metrics**](MetricsApi.md#get_latest_growth_metrics) | **GET** /Metrics/growth/latest/{ticker} | 
 [**get_list_financial_metrics_metadata**](MetricsApi.md#get_list_financial_metrics_metadata) | **GET** /Metrics/metadata/list/financials | 
 [**get_list_metric_views**](MetricsApi.md#get_list_metric_views) | **GET** /Metrics/view/list | 
+[**get_list_metrics_description**](MetricsApi.md#get_list_metrics_description) | **GET** /Metrics/description/list | 
 [**get_list_metrics_metadata**](MetricsApi.md#get_list_metrics_metadata) | **GET** /Metrics/metadata/list | 
 [**get_market_index_returns**](MetricsApi.md#get_market_index_returns) | **GET** /Metrics/merket/returns/{ticker} | 
 [**get_metric_view**](MetricsApi.md#get_metric_view) | **GET** /Metrics/view/{id} | 
@@ -1071,6 +1072,64 @@ This endpoint does not need any parameter.
 
 [[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_metrics_description**
+> list[GetListMetricsDescriptionDto] get_list_metrics_description(page_index=page_index, page_size=page_size)
+
+
+
+### 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.MetricsApi(investor8_sdk.ApiClient(configuration))
+page_index = 0 # int |  (optional) (default to 0)
+page_size = 50 # int |  (optional) (default to 50)
+
+try:
+    api_response = api_instance.get_list_metrics_description(page_index=page_index, page_size=page_size)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling MetricsApi->get_list_metrics_description: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page_index** | **int**|  | [optional] [default to 0]
+ **page_size** | **int**|  | [optional] [default to 50]
+
+### Return type
+
+[**list[GetListMetricsDescriptionDto]**](GetListMetricsDescriptionDto.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_list_metrics_metadata**
 > list[GetListMetricsMetadataDto] get_list_metrics_metadata(category=category, type=type, display_format=display_format, data_format=data_format, name=name, soft_delete=soft_delete, page_index=page_index, page_size=page_size, sort_by=sort_by, sort_direction=sort_direction)
 

diff --git a/investor8_sdk/__init__.py b/investor8_sdk/__init__.py
@@ -50,6 +50,7 @@
 from investor8_sdk.models.financial_tag import FinancialTag
 from investor8_sdk.models.financials_growth import FinancialsGrowth
 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_metric_view_dto import GetMetricViewDto
 from investor8_sdk.models.get_metrics_metadata_dto import GetMetricsMetadataDto

diff --git a/investor8_sdk/api/metrics_api.py b/investor8_sdk/api/metrics_api.py
@@ -1746,6 +1746,99 @@ def get_list_metric_views_with_http_info(self, **kwargs):  # noqa: E501
             _request_timeout=params.get('_request_timeout'),
             collection_formats=collection_formats)
 
+    def get_list_metrics_description(self, **kwargs):  # noqa: E501
+        """get_list_metrics_description  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_list_metrics_description(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int page_index:
+        :param int page_size:
+        :return: list[GetListMetricsDescriptionDto]
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.get_list_metrics_description_with_http_info(**kwargs)  # noqa: E501
+        else:
+            (data) = self.get_list_metrics_description_with_http_info(**kwargs)  # noqa: E501
+            return data
+
+    def get_list_metrics_description_with_http_info(self, **kwargs):  # noqa: E501
+        """get_list_metrics_description  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_list_metrics_description_with_http_info(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int page_index:
+        :param int page_size:
+        :return: list[GetListMetricsDescriptionDto]
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['page_index', 'page_size']  # noqa: E501
+        all_params.append('async_req')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_list_metrics_description" % key
+                )
+            params[key] = val
+        del params['kwargs']
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+        if 'page_index' in params:
+            query_params.append(('pageIndex', params['page_index']))  # noqa: E501
+        if 'page_size' in params:
+            query_params.append(('pageSize', params['page_size']))  # noqa: E501
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['text/plain', 'application/json', 'text/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['apiKey', 'bearerCoreAuth']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/Metrics/description/list', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='list[GetListMetricsDescriptionDto]',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=params.get('async_req'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
     def get_list_metrics_metadata(self, **kwargs):  # noqa: E501
         """get_list_metrics_metadata  # noqa: E501
 

diff --git a/investor8_sdk/api_client.py b/investor8_sdk/api_client.py
@@ -72,7 +72,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Swagger-Codegen/1.1.89/python'
+        self.user_agent = 'Swagger-Codegen/1.1.90/python'
 
     def __del__(self):
         self.pool.close()

diff --git a/investor8_sdk/configuration.py b/investor8_sdk/configuration.py
@@ -254,5 +254,5 @@ def to_debug_report(self):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 1.0.1\n"\
-               "SDK Package Version: 1.1.89".\
+               "SDK Package Version: 1.1.90".\
                format(env=sys.platform, pyversion=sys.version)
diff --git a/investor8_sdk/models/__init__.py b/investor8_sdk/models/__init__.py
@@ -34,6 +34,7 @@
 from investor8_sdk.models.financial_tag import FinancialTag
 from investor8_sdk.models.financials_growth import FinancialsGrowth
 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_metric_view_dto import GetMetricViewDto
 from investor8_sdk.models.get_metrics_metadata_dto import GetMetricsMetadataDto