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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. fds/__init__.py +0 -0
  2. fds/sdk/EventsandTranscripts/__init__.py +28 -0
  3. fds/sdk/EventsandTranscripts/api/__init__.py +3 -0
  4. fds/sdk/EventsandTranscripts/api/calendar_events_api.py +309 -0
  5. fds/sdk/EventsandTranscripts/api/events_audio_api.py +1452 -0
  6. fds/sdk/EventsandTranscripts/api/near_real_time_transcripts_api.py +1190 -0
  7. fds/sdk/EventsandTranscripts/api/transcripts_api.py +1682 -0
  8. fds/sdk/EventsandTranscripts/api_client.py +929 -0
  9. fds/sdk/EventsandTranscripts/apis/__init__.py +20 -0
  10. fds/sdk/EventsandTranscripts/configuration.py +496 -0
  11. fds/sdk/EventsandTranscripts/exceptions.py +160 -0
  12. fds/sdk/EventsandTranscripts/model/__init__.py +5 -0
  13. fds/sdk/EventsandTranscripts/model/company_event_request.py +262 -0
  14. fds/sdk/EventsandTranscripts/model/company_event_request_data.py +294 -0
  15. fds/sdk/EventsandTranscripts/model/company_event_request_data_date_time.py +268 -0
  16. fds/sdk/EventsandTranscripts/model/company_event_request_data_universe.py +274 -0
  17. fds/sdk/EventsandTranscripts/model/company_event_response.py +262 -0
  18. fds/sdk/EventsandTranscripts/model/company_event_response_object.py +322 -0
  19. fds/sdk/EventsandTranscripts/model/error.py +262 -0
  20. fds/sdk/EventsandTranscripts/model/error_example.py +264 -0
  21. fds/sdk/EventsandTranscripts/model/events_audio_daily.py +268 -0
  22. fds/sdk/EventsandTranscripts/model/events_audio_daily_file_name.py +262 -0
  23. fds/sdk/EventsandTranscripts/model/events_audio_daily_file_name_data.py +328 -0
  24. fds/sdk/EventsandTranscripts/model/events_audio_daily_ids.py +262 -0
  25. fds/sdk/EventsandTranscripts/model/events_audio_daily_meta.py +262 -0
  26. fds/sdk/EventsandTranscripts/model/events_audio_daily_meta_pagination.py +260 -0
  27. fds/sdk/EventsandTranscripts/model/events_audio_daily_object.py +328 -0
  28. fds/sdk/EventsandTranscripts/model/events_audio_history.py +262 -0
  29. fds/sdk/EventsandTranscripts/model/events_audio_history_data.py +272 -0
  30. fds/sdk/EventsandTranscripts/model/events_audio_ids_object.py +328 -0
  31. fds/sdk/EventsandTranscripts/model/indexed_nrt.py +266 -0
  32. fds/sdk/EventsandTranscripts/model/nrt_calls.py +268 -0
  33. fds/sdk/EventsandTranscripts/model/nrt_calls_meta.py +262 -0
  34. fds/sdk/EventsandTranscripts/model/nrt_calls_meta_pagination.py +260 -0
  35. fds/sdk/EventsandTranscripts/model/nrt_calls_object.py +314 -0
  36. fds/sdk/EventsandTranscripts/model/nrt_speaker_id_object.py +272 -0
  37. fds/sdk/EventsandTranscripts/model/nrt_speaker_ids.py +268 -0
  38. fds/sdk/EventsandTranscripts/model/nrt_speaker_ids_meta.py +262 -0
  39. fds/sdk/EventsandTranscripts/model/nrt_speaker_ids_meta_pagination.py +260 -0
  40. fds/sdk/EventsandTranscripts/model/response_categories.py +262 -0
  41. fds/sdk/EventsandTranscripts/model/response_categories_object.py +264 -0
  42. fds/sdk/EventsandTranscripts/model/response_time.py +262 -0
  43. fds/sdk/EventsandTranscripts/model/response_time_object.py +256 -0
  44. fds/sdk/EventsandTranscripts/model/transcript_object.py +316 -0
  45. fds/sdk/EventsandTranscripts/model/transcript_object_one.py +320 -0
  46. fds/sdk/EventsandTranscripts/model/transcripts.py +268 -0
  47. fds/sdk/EventsandTranscripts/model/transcripts_meta.py +262 -0
  48. fds/sdk/EventsandTranscripts/model/transcripts_meta_pagination.py +260 -0
  49. fds/sdk/EventsandTranscripts/model/transcripts_one.py +268 -0
  50. fds/sdk/EventsandTranscripts/model/transcripts_one_meta.py +262 -0
  51. fds/sdk/EventsandTranscripts/model/transcripts_one_meta_pagination.py +260 -0
  52. fds/sdk/EventsandTranscripts/model_utils.py +2052 -0
  53. fds/sdk/EventsandTranscripts/models/__init__.py +50 -0
  54. fds/sdk/EventsandTranscripts/rest.py +347 -0
  55. fds/sdk/__init__.py +0 -0
  56. fds.sdk.EventsandTranscripts-0.20.0.dist-info/LICENSE +202 -0
  57. fds.sdk.EventsandTranscripts-0.20.0.dist-info/METADATA +369 -0
  58. fds.sdk.EventsandTranscripts-0.20.0.dist-info/RECORD +60 -0
  59. fds.sdk.EventsandTranscripts-0.20.0.dist-info/WHEEL +5 -0
  60. fds.sdk.EventsandTranscripts-0.20.0.dist-info/top_level.txt +1 -0
@@ -0,0 +1,272 @@
1
+ """
2
+ EVENTS AND TRANSCRIPTS API
3
+
4
+ <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
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: api@factset.com
8
+ Generated by: https://openapi-generator.tech
9
+ """
10
+
11
+
12
+ import re # noqa: F401
13
+ import sys # noqa: F401
14
+
15
+ from fds.sdk.EventsandTranscripts.model_utils import ( # noqa: F401
16
+ ApiTypeError,
17
+ ModelComposed,
18
+ ModelNormal,
19
+ ModelSimple,
20
+ cached_property,
21
+ change_keys_js_to_python,
22
+ convert_js_args_to_python_args,
23
+ date,
24
+ datetime,
25
+ file_type,
26
+ none_type,
27
+ validate_get_composed_info,
28
+ OpenApiModel
29
+ )
30
+ from fds.sdk.EventsandTranscripts.exceptions import ApiAttributeError
31
+
32
+
33
+
34
+ class EventsAudioHistoryData(ModelNormal):
35
+ """NOTE: This class is auto generated by OpenAPI Generator.
36
+ Ref: https://openapi-generator.tech
37
+
38
+ Do not edit the class manually.
39
+
40
+ Attributes:
41
+ allowed_values (dict): The key is the tuple path to the attribute
42
+ and the for var_name this is (var_name,). The value is a dict
43
+ with a capitalized key describing the allowed value and an allowed
44
+ value. These dicts store the allowed enum values.
45
+ attribute_map (dict): The key is attribute name
46
+ and the value is json key in definition.
47
+ discriminator_value_class_map (dict): A dict to go from the discriminator
48
+ variable value to the discriminator class name.
49
+ validations (dict): The key is the tuple path to the attribute
50
+ and the for var_name this is (var_name,). The value is a dict
51
+ that stores validations for max_length, min_length, max_items,
52
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
53
+ inclusive_minimum, and regex.
54
+ additional_properties_type (tuple): A tuple of classes accepted
55
+ as additional properties values.
56
+ """
57
+
58
+ allowed_values = {
59
+ }
60
+
61
+ validations = {
62
+ }
63
+
64
+ @cached_property
65
+ def additional_properties_type():
66
+ """
67
+ This must be a method because a model may have properties that are
68
+ of type self, this must run after the class is loaded
69
+ """
70
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
71
+
72
+ _nullable = False
73
+
74
+ @cached_property
75
+ def openapi_types():
76
+ """
77
+ This must be a method because a model may have properties that are
78
+ of type self, this must run after the class is loaded
79
+
80
+ Returns
81
+ openapi_types (dict): The key is attribute name
82
+ and the value is attribute type.
83
+ """
84
+ return {
85
+ 'year': (int,), # noqa: E501
86
+ 'trimmed': (bool,), # noqa: E501
87
+ 'file_name': (str,), # noqa: E501
88
+ 'file_size': (int,), # noqa: E501
89
+ 'url': (str,), # noqa: E501
90
+ }
91
+
92
+ @cached_property
93
+ def discriminator():
94
+ return None
95
+
96
+
97
+ attribute_map = {
98
+ 'year': 'year', # noqa: E501
99
+ 'trimmed': 'trimmed', # noqa: E501
100
+ 'file_name': 'fileName', # noqa: E501
101
+ 'file_size': 'fileSize', # noqa: E501
102
+ 'url': 'url', # noqa: E501
103
+ }
104
+
105
+ read_only_vars = {
106
+ }
107
+
108
+ _composed_schemas = {}
109
+
110
+ @classmethod
111
+ @convert_js_args_to_python_args
112
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
113
+ """EventsAudioHistoryData - a model defined in OpenAPI
114
+
115
+ Keyword Args:
116
+ _check_type (bool): if True, values for parameters in openapi_types
117
+ will be type checked and a TypeError will be
118
+ raised if the wrong type is input.
119
+ Defaults to True
120
+ _path_to_item (tuple/list): This is a list of keys or values to
121
+ drill down to the model in received_data
122
+ when deserializing a response
123
+ _spec_property_naming (bool): True if the variable names in the input data
124
+ are serialized names, as specified in the OpenAPI document.
125
+ False if the variable names in the input data
126
+ are pythonic names, e.g. snake case (default)
127
+ _configuration (Configuration): the instance to use when
128
+ deserializing a file_type parameter.
129
+ If passed, type conversion is attempted
130
+ If omitted no type conversion is done.
131
+ _visited_composed_classes (tuple): This stores a tuple of
132
+ classes that we have traveled through so that
133
+ if we see that class again we will not use its
134
+ discriminator again.
135
+ When traveling through a discriminator, the
136
+ composed schema that is
137
+ is traveled through is added to this set.
138
+ For example if Animal has a discriminator
139
+ petType and we pass in "Dog", and the class Dog
140
+ allOf includes Animal, we move through Animal
141
+ once using the discriminator, and pick Dog.
142
+ Then in Dog, we will make an instance of the
143
+ Animal class but this time we won't travel
144
+ through its discriminator because we passed in
145
+ _visited_composed_classes = (Animal,)
146
+ year (int): The year corresponding to the file containing historical audio recordings that can be downloaded via presigned URL.. [optional] # noqa: E501
147
+ trimmed (bool): True it signifies that the pre-signed URL for downloading includes trimmed historical audio recordings along with their metadata for a specific year. False it signifies that the pre-signed URL for downloading contains the untrimmed historical audio recordings along with their relevant metadata for a specific year.. [optional] # noqa: E501
148
+ file_name (str): The name of the file.. [optional] # noqa: E501
149
+ file_size (int): The size of the file, in bytes.. [optional] # noqa: E501
150
+ url (str): A pre-signed URL for downloading historical audio recordings and related metadata of a specific year. The URL provided in the response will expire after 3 hours.. [optional] # noqa: E501
151
+ """
152
+
153
+ _check_type = kwargs.pop('_check_type', True)
154
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
155
+ _path_to_item = kwargs.pop('_path_to_item', ())
156
+ _configuration = kwargs.pop('_configuration', None)
157
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
158
+
159
+ self = super(OpenApiModel, cls).__new__(cls)
160
+
161
+ if args:
162
+ raise ApiTypeError(
163
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
164
+ args,
165
+ self.__class__.__name__,
166
+ ),
167
+ path_to_item=_path_to_item,
168
+ valid_classes=(self.__class__,),
169
+ )
170
+
171
+ self._data_store = {}
172
+ self._check_type = _check_type
173
+ self._spec_property_naming = _spec_property_naming
174
+ self._path_to_item = _path_to_item
175
+ self._configuration = _configuration
176
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
177
+
178
+ for var_name, var_value in kwargs.items():
179
+ if var_name not in self.attribute_map and \
180
+ self._configuration is not None and \
181
+ self._configuration.discard_unknown_keys and \
182
+ self.additional_properties_type is None:
183
+ # discard variable.
184
+ continue
185
+ setattr(self, var_name, var_value)
186
+ return self
187
+
188
+ required_properties = set([
189
+ '_data_store',
190
+ '_check_type',
191
+ '_spec_property_naming',
192
+ '_path_to_item',
193
+ '_configuration',
194
+ '_visited_composed_classes',
195
+ ])
196
+
197
+ @convert_js_args_to_python_args
198
+ def __init__(self, *args, **kwargs): # noqa: E501
199
+ """EventsAudioHistoryData - a model defined in OpenAPI
200
+
201
+ Keyword Args:
202
+ _check_type (bool): if True, values for parameters in openapi_types
203
+ will be type checked and a TypeError will be
204
+ raised if the wrong type is input.
205
+ Defaults to True
206
+ _path_to_item (tuple/list): This is a list of keys or values to
207
+ drill down to the model in received_data
208
+ when deserializing a response
209
+ _spec_property_naming (bool): True if the variable names in the input data
210
+ are serialized names, as specified in the OpenAPI document.
211
+ False if the variable names in the input data
212
+ are pythonic names, e.g. snake case (default)
213
+ _configuration (Configuration): the instance to use when
214
+ deserializing a file_type parameter.
215
+ If passed, type conversion is attempted
216
+ If omitted no type conversion is done.
217
+ _visited_composed_classes (tuple): This stores a tuple of
218
+ classes that we have traveled through so that
219
+ if we see that class again we will not use its
220
+ discriminator again.
221
+ When traveling through a discriminator, the
222
+ composed schema that is
223
+ is traveled through is added to this set.
224
+ For example if Animal has a discriminator
225
+ petType and we pass in "Dog", and the class Dog
226
+ allOf includes Animal, we move through Animal
227
+ once using the discriminator, and pick Dog.
228
+ Then in Dog, we will make an instance of the
229
+ Animal class but this time we won't travel
230
+ through its discriminator because we passed in
231
+ _visited_composed_classes = (Animal,)
232
+ year (int): The year corresponding to the file containing historical audio recordings that can be downloaded via presigned URL.. [optional] # noqa: E501
233
+ trimmed (bool): True it signifies that the pre-signed URL for downloading includes trimmed historical audio recordings along with their metadata for a specific year. False it signifies that the pre-signed URL for downloading contains the untrimmed historical audio recordings along with their relevant metadata for a specific year.. [optional] # noqa: E501
234
+ file_name (str): The name of the file.. [optional] # noqa: E501
235
+ file_size (int): The size of the file, in bytes.. [optional] # noqa: E501
236
+ url (str): A pre-signed URL for downloading historical audio recordings and related metadata of a specific year. The URL provided in the response will expire after 3 hours.. [optional] # noqa: E501
237
+ """
238
+
239
+ _check_type = kwargs.pop('_check_type', True)
240
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
241
+ _path_to_item = kwargs.pop('_path_to_item', ())
242
+ _configuration = kwargs.pop('_configuration', None)
243
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
244
+
245
+ if args:
246
+ raise ApiTypeError(
247
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
248
+ args,
249
+ self.__class__.__name__,
250
+ ),
251
+ path_to_item=_path_to_item,
252
+ valid_classes=(self.__class__,),
253
+ )
254
+
255
+ self._data_store = {}
256
+ self._check_type = _check_type
257
+ self._spec_property_naming = _spec_property_naming
258
+ self._path_to_item = _path_to_item
259
+ self._configuration = _configuration
260
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
261
+
262
+ for var_name, var_value in kwargs.items():
263
+ if var_name not in self.attribute_map and \
264
+ self._configuration is not None and \
265
+ self._configuration.discard_unknown_keys and \
266
+ self.additional_properties_type is None:
267
+ # discard variable.
268
+ continue
269
+ setattr(self, var_name, var_value)
270
+ if var_name in self.read_only_vars:
271
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
272
+ f"class with read only attributes.")
@@ -0,0 +1,328 @@
1
+ """
2
+ EVENTS AND TRANSCRIPTS API
3
+
4
+ <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
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: api@factset.com
8
+ Generated by: https://openapi-generator.tech
9
+ """
10
+
11
+
12
+ import re # noqa: F401
13
+ import sys # noqa: F401
14
+
15
+ from fds.sdk.EventsandTranscripts.model_utils import ( # noqa: F401
16
+ ApiTypeError,
17
+ ModelComposed,
18
+ ModelNormal,
19
+ ModelSimple,
20
+ cached_property,
21
+ change_keys_js_to_python,
22
+ convert_js_args_to_python_args,
23
+ date,
24
+ datetime,
25
+ file_type,
26
+ none_type,
27
+ validate_get_composed_info,
28
+ OpenApiModel
29
+ )
30
+ from fds.sdk.EventsandTranscripts.exceptions import ApiAttributeError
31
+
32
+
33
+
34
+ class EventsAudioIdsObject(ModelNormal):
35
+ """NOTE: This class is auto generated by OpenAPI Generator.
36
+ Ref: https://openapi-generator.tech
37
+
38
+ Do not edit the class manually.
39
+
40
+ Attributes:
41
+ allowed_values (dict): The key is the tuple path to the attribute
42
+ and the for var_name this is (var_name,). The value is a dict
43
+ with a capitalized key describing the allowed value and an allowed
44
+ value. These dicts store the allowed enum values.
45
+ attribute_map (dict): The key is attribute name
46
+ and the value is json key in definition.
47
+ discriminator_value_class_map (dict): A dict to go from the discriminator
48
+ variable value to the discriminator class name.
49
+ validations (dict): The key is the tuple path to the attribute
50
+ and the for var_name this is (var_name,). The value is a dict
51
+ that stores validations for max_length, min_length, max_items,
52
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
53
+ inclusive_minimum, and regex.
54
+ additional_properties_type (tuple): A tuple of classes accepted
55
+ as additional properties values.
56
+ """
57
+
58
+ allowed_values = {
59
+ ('source_code',): {
60
+ 'WEBCAST': "Webcast",
61
+ 'VENDOR': "Vendor",
62
+ 'WEBCASTREPLAY': "WebcastReplay",
63
+ 'FLASH': "Flash",
64
+ 'REPLAY': "Replay",
65
+ 'PHONE': "Phone",
66
+ },
67
+ }
68
+
69
+ validations = {
70
+ }
71
+
72
+ @cached_property
73
+ def additional_properties_type():
74
+ """
75
+ This must be a method because a model may have properties that are
76
+ of type self, this must run after the class is loaded
77
+ """
78
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
79
+
80
+ _nullable = False
81
+
82
+ @cached_property
83
+ def openapi_types():
84
+ """
85
+ This must be a method because a model may have properties that are
86
+ of type self, this must run after the class is loaded
87
+
88
+ Returns
89
+ openapi_types (dict): The key is attribute name
90
+ and the value is attribute type.
91
+ """
92
+ return {
93
+ 'report_id': (int,), # noqa: E501
94
+ 'file_name': (str,), # noqa: E501
95
+ 'url': (str,), # noqa: E501
96
+ 'file_size': (float,), # noqa: E501
97
+ 'audio_source_id': (int, none_type,), # noqa: E501
98
+ 'ticker': (str, none_type,), # noqa: E501
99
+ 'entity_id': (str,), # noqa: E501
100
+ 'source_code': (str,), # noqa: E501
101
+ 'trimmed': (bool,), # noqa: E501
102
+ 'duration_secs': (float, none_type,), # noqa: E501
103
+ 'start_offset_seconds': (float, none_type,), # noqa: E501
104
+ 'end_offset_seconds': (float, none_type,), # noqa: E501
105
+ 'start_time': (str, none_type,), # noqa: E501
106
+ 'end_time': (str, none_type,), # noqa: E501
107
+ 'upload_time': (str, none_type,), # noqa: E501
108
+ 'sample_rate': (float, none_type,), # noqa: E501
109
+ 'bitrate': (float, none_type,), # noqa: E501
110
+ }
111
+
112
+ @cached_property
113
+ def discriminator():
114
+ return None
115
+
116
+
117
+ attribute_map = {
118
+ 'report_id': 'reportId', # noqa: E501
119
+ 'file_name': 'fileName', # noqa: E501
120
+ 'url': 'url', # noqa: E501
121
+ 'file_size': 'fileSize', # noqa: E501
122
+ 'audio_source_id': 'audioSourceId', # noqa: E501
123
+ 'ticker': 'ticker', # noqa: E501
124
+ 'entity_id': 'entityId', # noqa: E501
125
+ 'source_code': 'sourceCode', # noqa: E501
126
+ 'trimmed': 'trimmed', # noqa: E501
127
+ 'duration_secs': 'durationSecs', # noqa: E501
128
+ 'start_offset_seconds': 'startOffsetSeconds', # noqa: E501
129
+ 'end_offset_seconds': 'endOffsetSeconds', # noqa: E501
130
+ 'start_time': 'startTime', # noqa: E501
131
+ 'end_time': 'endTime', # noqa: E501
132
+ 'upload_time': 'uploadTime', # noqa: E501
133
+ 'sample_rate': 'sampleRate', # noqa: E501
134
+ 'bitrate': 'bitrate', # noqa: E501
135
+ }
136
+
137
+ read_only_vars = {
138
+ }
139
+
140
+ _composed_schemas = {}
141
+
142
+ @classmethod
143
+ @convert_js_args_to_python_args
144
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
145
+ """EventsAudioIdsObject - a model defined in OpenAPI
146
+
147
+ Keyword Args:
148
+ _check_type (bool): if True, values for parameters in openapi_types
149
+ will be type checked and a TypeError will be
150
+ raised if the wrong type is input.
151
+ Defaults to True
152
+ _path_to_item (tuple/list): This is a list of keys or values to
153
+ drill down to the model in received_data
154
+ when deserializing a response
155
+ _spec_property_naming (bool): True if the variable names in the input data
156
+ are serialized names, as specified in the OpenAPI document.
157
+ False if the variable names in the input data
158
+ are pythonic names, e.g. snake case (default)
159
+ _configuration (Configuration): the instance to use when
160
+ deserializing a file_type parameter.
161
+ If passed, type conversion is attempted
162
+ If omitted no type conversion is done.
163
+ _visited_composed_classes (tuple): This stores a tuple of
164
+ classes that we have traveled through so that
165
+ if we see that class again we will not use its
166
+ discriminator again.
167
+ When traveling through a discriminator, the
168
+ composed schema that is
169
+ is traveled through is added to this set.
170
+ For example if Animal has a discriminator
171
+ petType and we pass in "Dog", and the class Dog
172
+ allOf includes Animal, we move through Animal
173
+ once using the discriminator, and pick Dog.
174
+ Then in Dog, we will make an instance of the
175
+ Animal class but this time we won't travel
176
+ through its discriminator because we passed in
177
+ _visited_composed_classes = (Animal,)
178
+ report_id (int): The unique ID of the audio file for an event. The same ID is used for the transcript of the same event. This report ID can also be used to map to the Event details in SDF tables.. [optional] # noqa: E501
179
+ file_name (str): The filename of the audio file.. [optional] # noqa: E501
180
+ url (str): A pre-signed URL that allows downloading the audio file, expiring after 24 hours.. [optional] # noqa: E501
181
+ file_size (float): Size of the Audio file, in bytes.. [optional] # noqa: E501
182
+ audio_source_id (int, none_type): Unique ID for an Internal recording specific to reportID. For example, ReportID X would have multiple recordings from different source (Phone or Webcast or Vendor or Replay). One ReportID can have multiple AudioSourceIDs. The audioSourceId identifier is available for audio calls since November 29, 2022. Only un-trimmed audio files contain an audioSourceId value. All the vendor and trimmed audio files will have an audioSourceId value of null.. [optional] # noqa: E501
183
+ ticker (str, none_type): Ticker-region identifier for the company hosting the event.. [optional] # noqa: E501
184
+ entity_id (str): FactSet entity level identifier for the company hosting the event.. [optional] # noqa: E501
185
+ source_code (str): This parameter filters the results based on Source of the Audio file. Below are the descriptions for each Source Code - * Phone = Originated from phone call * Webcast = Originated from a webcast * Vendor = Received from vendor * WebcastReplay = Replay of a webcast * Flash = Identical to webcast; can merge with \"Webcast\" in the future * Replay = Phone replay. [optional] # noqa: E501
186
+ trimmed (bool): The trimmed attribute indicates whether the audio is the trimmed version. If `sourceCode` is set to vendor, this attribute will always be true. . [optional] # noqa: E501
187
+ duration_secs (float, none_type): Total duration of the recording in seconds based on startOffsetSeconds to endOffsetSeconds.. [optional] # noqa: E501
188
+ start_offset_seconds (float, none_type): The delta in seconds between start of audio file to when FactSet marks the beginning of the call.. [optional] # noqa: E501
189
+ end_offset_seconds (float, none_type): The delta in seconds between startTime to when FactSet marks the end of the call.. [optional] # noqa: E501
190
+ start_time (str, none_type): The official timestamp when FactSet begins the recording.. [optional] # noqa: E501
191
+ end_time (str, none_type): The official timestamp when FactSet ends the recording.. [optional] # noqa: E501
192
+ upload_time (str, none_type): The official timestamp when FactSet publishes the audio file externally.. [optional] # noqa: E501
193
+ sample_rate (float, none_type): The number of samples of audio carried per second in Kbps.. [optional] # noqa: E501
194
+ bitrate (float, none_type): The total number of bits of information stored per second of sound in Kbps.. [optional] # noqa: E501
195
+ """
196
+
197
+ _check_type = kwargs.pop('_check_type', True)
198
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
199
+ _path_to_item = kwargs.pop('_path_to_item', ())
200
+ _configuration = kwargs.pop('_configuration', None)
201
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
202
+
203
+ self = super(OpenApiModel, cls).__new__(cls)
204
+
205
+ if args:
206
+ raise ApiTypeError(
207
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
208
+ args,
209
+ self.__class__.__name__,
210
+ ),
211
+ path_to_item=_path_to_item,
212
+ valid_classes=(self.__class__,),
213
+ )
214
+
215
+ self._data_store = {}
216
+ self._check_type = _check_type
217
+ self._spec_property_naming = _spec_property_naming
218
+ self._path_to_item = _path_to_item
219
+ self._configuration = _configuration
220
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
221
+
222
+ for var_name, var_value in kwargs.items():
223
+ if var_name not in self.attribute_map and \
224
+ self._configuration is not None and \
225
+ self._configuration.discard_unknown_keys and \
226
+ self.additional_properties_type is None:
227
+ # discard variable.
228
+ continue
229
+ setattr(self, var_name, var_value)
230
+ return self
231
+
232
+ required_properties = set([
233
+ '_data_store',
234
+ '_check_type',
235
+ '_spec_property_naming',
236
+ '_path_to_item',
237
+ '_configuration',
238
+ '_visited_composed_classes',
239
+ ])
240
+
241
+ @convert_js_args_to_python_args
242
+ def __init__(self, *args, **kwargs): # noqa: E501
243
+ """EventsAudioIdsObject - a model defined in OpenAPI
244
+
245
+ Keyword Args:
246
+ _check_type (bool): if True, values for parameters in openapi_types
247
+ will be type checked and a TypeError will be
248
+ raised if the wrong type is input.
249
+ Defaults to True
250
+ _path_to_item (tuple/list): This is a list of keys or values to
251
+ drill down to the model in received_data
252
+ when deserializing a response
253
+ _spec_property_naming (bool): True if the variable names in the input data
254
+ are serialized names, as specified in the OpenAPI document.
255
+ False if the variable names in the input data
256
+ are pythonic names, e.g. snake case (default)
257
+ _configuration (Configuration): the instance to use when
258
+ deserializing a file_type parameter.
259
+ If passed, type conversion is attempted
260
+ If omitted no type conversion is done.
261
+ _visited_composed_classes (tuple): This stores a tuple of
262
+ classes that we have traveled through so that
263
+ if we see that class again we will not use its
264
+ discriminator again.
265
+ When traveling through a discriminator, the
266
+ composed schema that is
267
+ is traveled through is added to this set.
268
+ For example if Animal has a discriminator
269
+ petType and we pass in "Dog", and the class Dog
270
+ allOf includes Animal, we move through Animal
271
+ once using the discriminator, and pick Dog.
272
+ Then in Dog, we will make an instance of the
273
+ Animal class but this time we won't travel
274
+ through its discriminator because we passed in
275
+ _visited_composed_classes = (Animal,)
276
+ report_id (int): The unique ID of the audio file for an event. The same ID is used for the transcript of the same event. This report ID can also be used to map to the Event details in SDF tables.. [optional] # noqa: E501
277
+ file_name (str): The filename of the audio file.. [optional] # noqa: E501
278
+ url (str): A pre-signed URL that allows downloading the audio file, expiring after 24 hours.. [optional] # noqa: E501
279
+ file_size (float): Size of the Audio file, in bytes.. [optional] # noqa: E501
280
+ audio_source_id (int, none_type): Unique ID for an Internal recording specific to reportID. For example, ReportID X would have multiple recordings from different source (Phone or Webcast or Vendor or Replay). One ReportID can have multiple AudioSourceIDs. The audioSourceId identifier is available for audio calls since November 29, 2022. Only un-trimmed audio files contain an audioSourceId value. All the vendor and trimmed audio files will have an audioSourceId value of null.. [optional] # noqa: E501
281
+ ticker (str, none_type): Ticker-region identifier for the company hosting the event.. [optional] # noqa: E501
282
+ entity_id (str): FactSet entity level identifier for the company hosting the event.. [optional] # noqa: E501
283
+ source_code (str): This parameter filters the results based on Source of the Audio file. Below are the descriptions for each Source Code - * Phone = Originated from phone call * Webcast = Originated from a webcast * Vendor = Received from vendor * WebcastReplay = Replay of a webcast * Flash = Identical to webcast; can merge with \"Webcast\" in the future * Replay = Phone replay. [optional] # noqa: E501
284
+ trimmed (bool): The trimmed attribute indicates whether the audio is the trimmed version. If `sourceCode` is set to vendor, this attribute will always be true. . [optional] # noqa: E501
285
+ duration_secs (float, none_type): Total duration of the recording in seconds based on startOffsetSeconds to endOffsetSeconds.. [optional] # noqa: E501
286
+ start_offset_seconds (float, none_type): The delta in seconds between start of audio file to when FactSet marks the beginning of the call.. [optional] # noqa: E501
287
+ end_offset_seconds (float, none_type): The delta in seconds between startTime to when FactSet marks the end of the call.. [optional] # noqa: E501
288
+ start_time (str, none_type): The official timestamp when FactSet begins the recording.. [optional] # noqa: E501
289
+ end_time (str, none_type): The official timestamp when FactSet ends the recording.. [optional] # noqa: E501
290
+ upload_time (str, none_type): The official timestamp when FactSet publishes the audio file externally.. [optional] # noqa: E501
291
+ sample_rate (float, none_type): The number of samples of audio carried per second in Kbps.. [optional] # noqa: E501
292
+ bitrate (float, none_type): The total number of bits of information stored per second of sound in Kbps.. [optional] # noqa: E501
293
+ """
294
+
295
+ _check_type = kwargs.pop('_check_type', True)
296
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
297
+ _path_to_item = kwargs.pop('_path_to_item', ())
298
+ _configuration = kwargs.pop('_configuration', None)
299
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
300
+
301
+ if args:
302
+ raise ApiTypeError(
303
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
304
+ args,
305
+ self.__class__.__name__,
306
+ ),
307
+ path_to_item=_path_to_item,
308
+ valid_classes=(self.__class__,),
309
+ )
310
+
311
+ self._data_store = {}
312
+ self._check_type = _check_type
313
+ self._spec_property_naming = _spec_property_naming
314
+ self._path_to_item = _path_to_item
315
+ self._configuration = _configuration
316
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
317
+
318
+ for var_name, var_value in kwargs.items():
319
+ if var_name not in self.attribute_map and \
320
+ self._configuration is not None and \
321
+ self._configuration.discard_unknown_keys and \
322
+ self.additional_properties_type is None:
323
+ # discard variable.
324
+ continue
325
+ setattr(self, var_name, var_value)
326
+ if var_name in self.read_only_vars:
327
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
328
+ f"class with read only attributes.")