fds.sdk.EventsandTranscripts 0.20.0__py3-none-any.whl

fds/sdk/EventsandTranscripts/__init__.py

@@ -0,0 +1,28 @@
+# flake8: noqa
+
+"""
+    EVENTS AND TRANSCRIPTS API
+
+    <p>The Calendar Events API provides access to FactSet’s Event Calendar data alongside business logic that allows users to replicate views and functionality consistent with the experience provided by the Workstation. This API provides the ability to pull Event Calendar data based on specific filters.</p> <p>Events Audio API provides access to historical as well as the latest audio recordings of various company events covered by FactSet. The events include, but are not limited to: earnings calls, conferences, and investor days. This API also provides relevant metadata such as timestamps and identifiers around each audio file.</p> <p>The  Near Real-time Transcripts API enables access to Near Real-time Transcripts provided by CallStreet to time-sensitive clients. This API also provides the relevant speaker metadata along with their confidence scores. This data caters to quant clients interested in building machine learning models. Clients can leverage this API to perform sentiment analysis through natural language processing or machine learning. It can also be used to complement analysis using FactSet's transcripts service.</p> <p>Transcripts API provides conference call transcripts for companies' publicly held conference calls and a wealth of information regarding upcoming corporate events, such as conference call date and time, phone number and password, type of conference call, and important company investor relations contact information.</p>    # noqa: E501
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: api@factset.com
+    Generated by: https://openapi-generator.tech
+"""
+
+
+__version__ = "0.20.0"
+
+# import ApiClient
+from fds.sdk.EventsandTranscripts.api_client import ApiClient
+
+# import Configuration
+from fds.sdk.EventsandTranscripts.configuration import Configuration
+
+# import exceptions
+from fds.sdk.EventsandTranscripts.exceptions import OpenApiException
+from fds.sdk.EventsandTranscripts.exceptions import ApiAttributeError
+from fds.sdk.EventsandTranscripts.exceptions import ApiTypeError
+from fds.sdk.EventsandTranscripts.exceptions import ApiValueError
+from fds.sdk.EventsandTranscripts.exceptions import ApiKeyError
+from fds.sdk.EventsandTranscripts.exceptions import ApiException

fds/sdk/EventsandTranscripts/api/__init__.py

@@ -0,0 +1,3 @@
+# do not import all apis into this module because that uses a lot of memory and stack frames
+# if you need the ability to import all apis from one package, import them with
+# from fds.sdk.EventsandTranscripts.apis import CalendarEventsApi

fds/sdk/EventsandTranscripts/api/calendar_events_api.py

@@ -0,0 +1,309 @@
+"""
+    EVENTS AND TRANSCRIPTS API
+
+    <p>The Calendar Events API provides access to FactSet’s Event Calendar data alongside business logic that allows users to replicate views and functionality consistent with the experience provided by the Workstation. This API provides the ability to pull Event Calendar data based on specific filters.</p> <p>Events Audio API provides access to historical as well as the latest audio recordings of various company events covered by FactSet. The events include, but are not limited to: earnings calls, conferences, and investor days. This API also provides relevant metadata such as timestamps and identifiers around each audio file.</p> <p>The  Near Real-time Transcripts API enables access to Near Real-time Transcripts provided by CallStreet to time-sensitive clients. This API also provides the relevant speaker metadata along with their confidence scores. This data caters to quant clients interested in building machine learning models. Clients can leverage this API to perform sentiment analysis through natural language processing or machine learning. It can also be used to complement analysis using FactSet's transcripts service.</p> <p>Transcripts API provides conference call transcripts for companies' publicly held conference calls and a wealth of information regarding upcoming corporate events, such as conference call date and time, phone number and password, type of conference call, and important company investor relations contact information.</p>    # noqa: E501
+
+    The version of the OpenAPI document: 1.0.0
+    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.EventsandTranscripts.api_client import ApiClient, Endpoint as _Endpoint
+from fds.sdk.EventsandTranscripts.model_utils import (  # noqa: F401
+    check_allowed_values,
+    check_validations,
+    date,
+    datetime,
+    file_type,
+    none_type,
+    validate_and_convert_types
+)
+from fds.sdk.EventsandTranscripts.exceptions import ApiException
+from fds.sdk.EventsandTranscripts.model.company_event_request import CompanyEventRequest
+from fds.sdk.EventsandTranscripts.model.company_event_response import CompanyEventResponse
+from fds.sdk.EventsandTranscripts.model.error import Error
+
+
+
+
+
+class CalendarEventsApi(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_company_event_endpoint = _Endpoint(
+            settings={
+                'response_type': (
+                  { 200: (CompanyEventResponse,), 400: (Error,), 401: (Error,), 404: (Error,), 500: (Error,),  },
+                  None
+                ),
+                'auth': [
+                    'FactSetApiKey',
+                    'FactSetOAuth2'
+                ],
+                'endpoint_path': '/calendar/events',
+                'operation_id': 'get_company_event',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'company_event_request',
+                ],
+                'required': [
+                    'company_event_request',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'company_event_request':
+                        (CompanyEventRequest,),
+                },
+                'attribute_map': {
+                },
+                'location_map': {
+                    'company_event_request': 'body',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [
+                    'application/json'
+                ]
+            },
+            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_company_event(
+        self,
+        company_event_request,
+        **kwargs
+    ) -> CompanyEventResponse:
+        """Retrieve Company Event data  # noqa: E501
+
+        This endpoint returns all company events with filters from the request.  # noqa: E501
+        This method makes a synchronous HTTP request. Returns the http data only
+
+        Args:
+            company_event_request (CompanyEventRequest): Company Event request body
+
+        Keyword Args:
+            _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:
+            CompanyEventResponse
+                Response Object
+        """
+        self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
+        kwargs['company_event_request'] = \
+            company_event_request
+        return self.get_company_event_endpoint.call_with_http_info(**kwargs)
+
+    def get_company_event_with_http_info(
+        self,
+        company_event_request,
+        **kwargs
+    ) -> typing.Tuple[CompanyEventResponse, int, typing.MutableMapping]:
+        """Retrieve Company Event data  # noqa: E501
+
+        This endpoint returns all company events with filters from the request.  # noqa: E501
+        This method makes a synchronous HTTP request. Returns http data, http status and headers
+
+        Args:
+            company_event_request (CompanyEventRequest): Company Event request body
+
+        Keyword Args:
+            _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:
+            CompanyEventResponse
+                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)
+        kwargs['company_event_request'] = \
+            company_event_request
+        return self.get_company_event_endpoint.call_with_http_info(**kwargs)
+
+    def get_company_event_async(
+        self,
+        company_event_request,
+        **kwargs
+    ) -> "ApplyResult[CompanyEventResponse]":
+        """Retrieve Company Event data  # noqa: E501
+
+        This endpoint returns all company events with filters from the request.  # noqa: E501
+        This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
+
+        Args:
+            company_event_request (CompanyEventRequest): Company Event request body
+
+        Keyword Args:
+            _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[CompanyEventResponse]
+        """
+        self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
+        kwargs['company_event_request'] = \
+            company_event_request
+        return self.get_company_event_endpoint.call_with_http_info(**kwargs)
+
+    def get_company_event_with_http_info_async(
+        self,
+        company_event_request,
+        **kwargs
+    ) -> "ApplyResult[typing.Tuple[CompanyEventResponse, int, typing.MutableMapping]]":
+        """Retrieve Company Event data  # noqa: E501
+
+        This endpoint returns all company events with filters from the request.  # noqa: E501
+        This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
+
+        Args:
+            company_event_request (CompanyEventRequest): Company Event request body
+
+        Keyword Args:
+            _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[(CompanyEventResponse, int, typing.Dict)]
+        """
+        self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
+        kwargs['company_event_request'] = \
+            company_event_request
+        return self.get_company_event_endpoint.call_with_http_info(**kwargs)
+
+