fds.sdk.ProposalGenerationEngine 0.1.0__py3-none-any.whl

fds/sdk/ProposalGenerationEngine/api/lookup_api.py

@@ -0,0 +1,333 @@
+"""
+    Proposal Generation Engine API
+
+    Documentation on all available end points in the Proposal Generation API    # noqa: E501
+
+    The version of the OpenAPI document: 0.0.1
+    Contact: api@factset.com
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+from multiprocessing.pool import ApplyResult
+import typing
+
+from fds.sdk.ProposalGenerationEngine.api_client import ApiClient, Endpoint as _Endpoint
+from fds.sdk.ProposalGenerationEngine.model_utils import (  # noqa: F401
+    check_allowed_values,
+    check_validations,
+    date,
+    datetime,
+    file_type,
+    none_type,
+    validate_and_convert_types
+)
+from fds.sdk.ProposalGenerationEngine.exceptions import ApiException
+from fds.sdk.ProposalGenerationEngine.model.paged_securities import PagedSecurities
+
+
+
+
+
+class LookupApi(object):
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+
+        self.get_securities_endpoint = _Endpoint(
+            settings={
+                'response_type': (
+                  { 200: (PagedSecurities,),  },
+                  None
+                ),
+                'auth': [
+                    'FactSetApiKey',
+                    'FactSetOAuth2'
+                ],
+                'endpoint_path': '/securities',
+                'operation_id': 'get_securities',
+                'http_method': 'GET',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'name',
+                    'identifier',
+                    'as_of_date',
+                    'udfs',
+                    'pagination_offset',
+                    'pagination_limit',
+                ],
+                'required': [],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'name':
+                        (str,),
+                    'identifier':
+                        (str,),
+                    'as_of_date':
+                        (str,),
+                    'udfs':
+                        (str,),
+                    'pagination_offset':
+                        (int,),
+                    'pagination_limit':
+                        (int,),
+                },
+                'attribute_map': {
+                    'name': 'name',
+                    'identifier': 'identifier',
+                    'as_of_date': 'asOfDate',
+                    'udfs': 'udfs',
+                    'pagination_offset': '_paginationOffset',
+                    'pagination_limit': '_paginationLimit',
+                },
+                'location_map': {
+                    'name': 'query',
+                    'identifier': 'query',
+                    'as_of_date': 'query',
+                    'udfs': 'query',
+                    'pagination_offset': 'query',
+                    'pagination_limit': 'query',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
+
+
+    @staticmethod
+    def apply_kwargs_defaults(kwargs, return_http_data_only, async_req):
+        kwargs["async_req"] = async_req
+        kwargs["_return_http_data_only"] = return_http_data_only
+        kwargs["_preload_content"] = kwargs.get("_preload_content", True)
+        kwargs["_request_timeout"] = kwargs.get("_request_timeout", None)
+        kwargs["_check_input_type"] = kwargs.get("_check_input_type", True)
+        kwargs["_check_return_type"] = kwargs.get("_check_return_type", True)
+        kwargs["_spec_property_naming"] = kwargs.get("_spec_property_naming", False)
+        kwargs["_content_type"] = kwargs.get("_content_type")
+        kwargs["_host_index"] = kwargs.get("_host_index")
+
+
+    def get_securities(
+        self,
+        **kwargs
+    ) -> PagedSecurities:
+        """get_securities  # noqa: E501
+
+        search for securities within the security universe for the user/client  # noqa: E501
+        This method makes a synchronous HTTP request. Returns the http data only
+
+
+        Keyword Args:
+            name (str): search by (part of) security name. [optional]
+            identifier (str): search by security identifier (e.g. cusip or tradingSymbol).. [optional]
+            as_of_date (str): search only within valid securities for the specified asOfDate. The value should be in YYYY-MM-DD format. A special wildcard value 'latestMonthEnd' is supported as well. [optional]
+            udfs (str): specify list of UDFs to retrieve for every security in the result. [optional]
+            pagination_offset (int): Specifies the starting index for pagination.. [optional]
+            pagination_limit (int): Specifies the maximum number of results to return. [optional]
+            _preload_content (bool): if False, the urllib3.HTTPResponse object
+                will be returned without reading/decoding response data.
+                Default is True. NOTE: if this API returns a file, it is the responsibility
+                of the caller to close the file stream.
+            _request_timeout (int/float/tuple): timeout setting for this request. If
+                one number provided, it will be total request timeout. It can also
+                be a pair (tuple) of (connection, read) timeouts.
+                Default is None.
+            _check_input_type (bool): specifies if type checking
+                should be done one the data sent to the server.
+                Default is True.
+            _check_return_type (bool): specifies if type checking
+                should be done one the data received from the server.
+                Default is True.
+            _spec_property_naming (bool): True if the variable names in the input data
+                are serialized names, as specified in the OpenAPI document.
+                False if the variable names in the input data
+                are pythonic names, e.g. snake case (default)
+            _content_type (str/None): force body content-type.
+                Default is None and content-type will be predicted by allowed
+                content-types and body.
+            _host_index (int/None): specifies the index of the server
+                that we want to use.
+                Default is read from the configuration.
+        Returns:
+            PagedSecurities
+                Response Object
+        """
+        self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
+        return self.get_securities_endpoint.call_with_http_info(**kwargs)
+
+    def get_securities_with_http_info(
+        self,
+        **kwargs
+    ) -> typing.Tuple[PagedSecurities, int, typing.MutableMapping]:
+        """get_securities  # noqa: E501
+
+        search for securities within the security universe for the user/client  # noqa: E501
+        This method makes a synchronous HTTP request. Returns http data, http status and headers
+
+
+        Keyword Args:
+            name (str): search by (part of) security name. [optional]
+            identifier (str): search by security identifier (e.g. cusip or tradingSymbol).. [optional]
+            as_of_date (str): search only within valid securities for the specified asOfDate. The value should be in YYYY-MM-DD format. A special wildcard value 'latestMonthEnd' is supported as well. [optional]
+            udfs (str): specify list of UDFs to retrieve for every security in the result. [optional]
+            pagination_offset (int): Specifies the starting index for pagination.. [optional]
+            pagination_limit (int): Specifies the maximum number of results to return. [optional]
+            _preload_content (bool): if False, the urllib3.HTTPResponse object
+                will be returned without reading/decoding response data.
+                Default is True. NOTE: if this API returns a file, it is the responsibility
+                of the caller to close the file stream.
+            _request_timeout (int/float/tuple): timeout setting for this request. If
+                one number provided, it will be total request timeout. It can also
+                be a pair (tuple) of (connection, read) timeouts.
+                Default is None.
+            _check_input_type (bool): specifies if type checking
+                should be done one the data sent to the server.
+                Default is True.
+            _check_return_type (bool): specifies if type checking
+                should be done one the data received from the server.
+                Default is True.
+            _spec_property_naming (bool): True if the variable names in the input data
+                are serialized names, as specified in the OpenAPI document.
+                False if the variable names in the input data
+                are pythonic names, e.g. snake case (default)
+            _content_type (str/None): force body content-type.
+                Default is None and content-type will be predicted by allowed
+                content-types and body.
+            _host_index (int/None): specifies the index of the server
+                that we want to use.
+                Default is read from the configuration.
+        Returns:
+            PagedSecurities
+                Response Object
+            int
+                Http Status Code
+            dict
+                Dictionary of the response headers
+        """
+        self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
+        return self.get_securities_endpoint.call_with_http_info(**kwargs)
+
+    def get_securities_async(
+        self,
+        **kwargs
+    ) -> "ApplyResult[PagedSecurities]":
+        """get_securities  # noqa: E501
+
+        search for securities within the security universe for the user/client  # noqa: E501
+        This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
+
+
+        Keyword Args:
+            name (str): search by (part of) security name. [optional]
+            identifier (str): search by security identifier (e.g. cusip or tradingSymbol).. [optional]
+            as_of_date (str): search only within valid securities for the specified asOfDate. The value should be in YYYY-MM-DD format. A special wildcard value 'latestMonthEnd' is supported as well. [optional]
+            udfs (str): specify list of UDFs to retrieve for every security in the result. [optional]
+            pagination_offset (int): Specifies the starting index for pagination.. [optional]
+            pagination_limit (int): Specifies the maximum number of results to return. [optional]
+            _preload_content (bool): if False, the urllib3.HTTPResponse object
+                will be returned without reading/decoding response data.
+                Default is True. NOTE: if this API returns a file, it is the responsibility
+                of the caller to close the file stream.
+            _request_timeout (int/float/tuple): timeout setting for this request. If
+                one number provided, it will be total request timeout. It can also
+                be a pair (tuple) of (connection, read) timeouts.
+                Default is None.
+            _check_input_type (bool): specifies if type checking
+                should be done one the data sent to the server.
+                Default is True.
+            _check_return_type (bool): specifies if type checking
+                should be done one the data received from the server.
+                Default is True.
+            _spec_property_naming (bool): True if the variable names in the input data
+                are serialized names, as specified in the OpenAPI document.
+                False if the variable names in the input data
+                are pythonic names, e.g. snake case (default)
+            _content_type (str/None): force body content-type.
+                Default is None and content-type will be predicted by allowed
+                content-types and body.
+            _host_index (int/None): specifies the index of the server
+                that we want to use.
+                Default is read from the configuration.
+        Returns:
+            ApplyResult[PagedSecurities]
+        """
+        self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
+        return self.get_securities_endpoint.call_with_http_info(**kwargs)
+
+    def get_securities_with_http_info_async(
+        self,
+        **kwargs
+    ) -> "ApplyResult[typing.Tuple[PagedSecurities, int, typing.MutableMapping]]":
+        """get_securities  # noqa: E501
+
+        search for securities within the security universe for the user/client  # noqa: E501
+        This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
+
+
+        Keyword Args:
+            name (str): search by (part of) security name. [optional]
+            identifier (str): search by security identifier (e.g. cusip or tradingSymbol).. [optional]
+            as_of_date (str): search only within valid securities for the specified asOfDate. The value should be in YYYY-MM-DD format. A special wildcard value 'latestMonthEnd' is supported as well. [optional]
+            udfs (str): specify list of UDFs to retrieve for every security in the result. [optional]
+            pagination_offset (int): Specifies the starting index for pagination.. [optional]
+            pagination_limit (int): Specifies the maximum number of results to return. [optional]
+            _preload_content (bool): if False, the urllib3.HTTPResponse object
+                will be returned without reading/decoding response data.
+                Default is True. NOTE: if this API returns a file, it is the responsibility
+                of the caller to close the file stream.
+            _request_timeout (int/float/tuple): timeout setting for this request. If
+                one number provided, it will be total request timeout. It can also
+                be a pair (tuple) of (connection, read) timeouts.
+                Default is None.
+            _check_input_type (bool): specifies if type checking
+                should be done one the data sent to the server.
+                Default is True.
+            _check_return_type (bool): specifies if type checking
+                should be done one the data received from the server.
+                Default is True.
+            _spec_property_naming (bool): True if the variable names in the input data
+                are serialized names, as specified in the OpenAPI document.
+                False if the variable names in the input data
+                are pythonic names, e.g. snake case (default)
+            _content_type (str/None): force body content-type.
+                Default is None and content-type will be predicted by allowed
+                content-types and body.
+            _host_index (int/None): specifies the index of the server
+                that we want to use.
+                Default is read from the configuration.
+        Returns:
+            ApplyResult[(PagedSecurities, int, typing.Dict)]
+        """
+        self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
+        return self.get_securities_endpoint.call_with_http_info(**kwargs)
+
+