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,1190 @@
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
+ from multiprocessing.pool import ApplyResult
15
+ import typing
16
+
17
+ from fds.sdk.EventsandTranscripts.api_client import ApiClient, Endpoint as _Endpoint
18
+ from fds.sdk.EventsandTranscripts.model_utils import ( # noqa: F401
19
+ check_allowed_values,
20
+ check_validations,
21
+ date,
22
+ datetime,
23
+ file_type,
24
+ none_type,
25
+ validate_and_convert_types
26
+ )
27
+ from fds.sdk.EventsandTranscripts.exceptions import ApiException
28
+ from fds.sdk.EventsandTranscripts.model.error import Error
29
+ from fds.sdk.EventsandTranscripts.model.indexed_nrt import IndexedNrt
30
+ from fds.sdk.EventsandTranscripts.model.nrt_calls import NrtCalls
31
+ from fds.sdk.EventsandTranscripts.model.nrt_speaker_ids import NrtSpeakerIds
32
+
33
+
34
+
35
+
36
+
37
+ class NearRealTimeTranscriptsApi(object):
38
+ """NOTE: This class is auto generated by OpenAPI Generator
39
+ Ref: https://openapi-generator.tech
40
+
41
+ Do not edit the class manually.
42
+ """
43
+
44
+ def __init__(self, api_client=None):
45
+ if api_client is None:
46
+ api_client = ApiClient()
47
+ self.api_client = api_client
48
+
49
+ self.get_bulk_documents_nrt_v1_calls_endpoint = _Endpoint(
50
+ settings={
51
+ 'response_type': (
52
+ { 200: (NrtCalls,), 400: (Error,), 401: (Error,), 403: (Error,), 500: (Error,), },
53
+ None
54
+ ),
55
+ 'auth': [
56
+ 'FactSetApiKey',
57
+ 'FactSetOAuth2'
58
+ ],
59
+ 'endpoint_path': '/nrt/by-ticker',
60
+ 'operation_id': 'get_bulk_documents_nrt_v1_calls',
61
+ 'http_method': 'GET',
62
+ 'servers': None,
63
+ },
64
+ params_map={
65
+ 'all': [
66
+ 'ticker',
67
+ 'entity_id',
68
+ 'call_status',
69
+ 'sort',
70
+ 'pagination_limit',
71
+ 'pagination_offset',
72
+ ],
73
+ 'required': [],
74
+ 'nullable': [
75
+ ],
76
+ 'enum': [
77
+ 'call_status',
78
+ 'sort',
79
+ ],
80
+ 'validation': [
81
+ 'sort',
82
+ ]
83
+ },
84
+ root_map={
85
+ 'validations': {
86
+ ('sort',): {
87
+
88
+ 'max_items': 2,
89
+ },
90
+ },
91
+ 'allowed_values': {
92
+ ('call_status',): {
93
+
94
+ "INPROGRESS": "InProgress",
95
+ "ENDED": "Ended",
96
+ "EWN": "EWN",
97
+ "ISSUEATSOURCE": "IssueAtSource"
98
+ },
99
+ ('sort',): {
100
+
101
+ "EVENTDATETIMEUTC": "eventDatetimeUtc",
102
+ "-EVENTDATETIMEUTC": "-eventDatetimeUtc"
103
+ },
104
+ },
105
+ 'openapi_types': {
106
+ 'ticker':
107
+ (str,),
108
+ 'entity_id':
109
+ (str,),
110
+ 'call_status':
111
+ (str,),
112
+ 'sort':
113
+ ([str],),
114
+ 'pagination_limit':
115
+ (int,),
116
+ 'pagination_offset':
117
+ (int,),
118
+ },
119
+ 'attribute_map': {
120
+ 'ticker': 'ticker',
121
+ 'entity_id': 'entityId',
122
+ 'call_status': 'callStatus',
123
+ 'sort': '_sort',
124
+ 'pagination_limit': '_paginationLimit',
125
+ 'pagination_offset': '_paginationOffset',
126
+ },
127
+ 'location_map': {
128
+ 'ticker': 'query',
129
+ 'entity_id': 'query',
130
+ 'call_status': 'query',
131
+ 'sort': 'query',
132
+ 'pagination_limit': 'query',
133
+ 'pagination_offset': 'query',
134
+ },
135
+ 'collection_format_map': {
136
+ 'sort': 'csv',
137
+ }
138
+ },
139
+ headers_map={
140
+ 'accept': [
141
+ 'application/json'
142
+ ],
143
+ 'content_type': [],
144
+ },
145
+ api_client=api_client
146
+ )
147
+
148
+ self.get_bulk_documents_nrt_v1_calls_by_audio_source_id_endpoint = _Endpoint(
149
+ settings={
150
+ 'response_type': (
151
+ { 200: (NrtCalls,), 400: (Error,), 401: (Error,), 403: (Error,), 500: (Error,), },
152
+ None
153
+ ),
154
+ 'auth': [
155
+ 'FactSetApiKey',
156
+ 'FactSetOAuth2'
157
+ ],
158
+ 'endpoint_path': '/nrt/by-ids',
159
+ 'operation_id': 'get_bulk_documents_nrt_v1_calls_by_audio_source_id',
160
+ 'http_method': 'GET',
161
+ 'servers': None,
162
+ },
163
+ params_map={
164
+ 'all': [
165
+ 'audio_source_id',
166
+ 'report_id',
167
+ 'sort',
168
+ 'pagination_limit',
169
+ 'pagination_offset',
170
+ ],
171
+ 'required': [],
172
+ 'nullable': [
173
+ ],
174
+ 'enum': [
175
+ 'sort',
176
+ ],
177
+ 'validation': [
178
+ 'sort',
179
+ ]
180
+ },
181
+ root_map={
182
+ 'validations': {
183
+ ('sort',): {
184
+
185
+ 'max_items': 2,
186
+ },
187
+ },
188
+ 'allowed_values': {
189
+ ('sort',): {
190
+
191
+ "EVENTDATETIMEUTC": "eventDatetimeUtc",
192
+ "-EVENTDATETIMEUTC": "-eventDatetimeUtc"
193
+ },
194
+ },
195
+ 'openapi_types': {
196
+ 'audio_source_id':
197
+ (int,),
198
+ 'report_id':
199
+ (int,),
200
+ 'sort':
201
+ ([str],),
202
+ 'pagination_limit':
203
+ (int,),
204
+ 'pagination_offset':
205
+ (int,),
206
+ },
207
+ 'attribute_map': {
208
+ 'audio_source_id': 'audioSourceId',
209
+ 'report_id': 'reportId',
210
+ 'sort': '_sort',
211
+ 'pagination_limit': '_paginationLimit',
212
+ 'pagination_offset': '_paginationOffset',
213
+ },
214
+ 'location_map': {
215
+ 'audio_source_id': 'query',
216
+ 'report_id': 'query',
217
+ 'sort': 'query',
218
+ 'pagination_limit': 'query',
219
+ 'pagination_offset': 'query',
220
+ },
221
+ 'collection_format_map': {
222
+ 'sort': 'csv',
223
+ }
224
+ },
225
+ headers_map={
226
+ 'accept': [
227
+ 'application/json'
228
+ ],
229
+ 'content_type': [],
230
+ },
231
+ api_client=api_client
232
+ )
233
+
234
+ self.get_bulk_documents_nrt_v1_indexedrt_endpoint = _Endpoint(
235
+ settings={
236
+ 'response_type': (
237
+ { 200: (IndexedNrt,), 400: (Error,), 401: (Error,), 403: (Error,), 500: (Error,), },
238
+ None
239
+ ),
240
+ 'auth': [
241
+ 'FactSetApiKey',
242
+ 'FactSetOAuth2'
243
+ ],
244
+ 'endpoint_path': '/nrt/indexed',
245
+ 'operation_id': 'get_bulk_documents_nrt_v1_indexedrt',
246
+ 'http_method': 'GET',
247
+ 'servers': None,
248
+ },
249
+ params_map={
250
+ 'all': [
251
+ 'audio_source_id',
252
+ 'pagination_limit',
253
+ 'pagination_offset',
254
+ ],
255
+ 'required': [
256
+ 'audio_source_id',
257
+ ],
258
+ 'nullable': [
259
+ ],
260
+ 'enum': [
261
+ ],
262
+ 'validation': [
263
+ 'pagination_limit',
264
+ ]
265
+ },
266
+ root_map={
267
+ 'validations': {
268
+ ('pagination_limit',): {
269
+
270
+ 'inclusive_maximum': 50,
271
+ 'inclusive_minimum': 0,
272
+ },
273
+ },
274
+ 'allowed_values': {
275
+ },
276
+ 'openapi_types': {
277
+ 'audio_source_id':
278
+ (int,),
279
+ 'pagination_limit':
280
+ (int,),
281
+ 'pagination_offset':
282
+ (int,),
283
+ },
284
+ 'attribute_map': {
285
+ 'audio_source_id': 'audioSourceId',
286
+ 'pagination_limit': '_paginationLimit',
287
+ 'pagination_offset': '_paginationOffset',
288
+ },
289
+ 'location_map': {
290
+ 'audio_source_id': 'query',
291
+ 'pagination_limit': 'query',
292
+ 'pagination_offset': 'query',
293
+ },
294
+ 'collection_format_map': {
295
+ }
296
+ },
297
+ headers_map={
298
+ 'accept': [
299
+ 'application/json'
300
+ ],
301
+ 'content_type': [],
302
+ },
303
+ api_client=api_client
304
+ )
305
+
306
+ self.get_bulk_documents_nrt_v1_speaker_ids_endpoint = _Endpoint(
307
+ settings={
308
+ 'response_type': (
309
+ { 200: (NrtSpeakerIds,), 400: (Error,), 401: (Error,), 403: (Error,), 500: (Error,), },
310
+ None
311
+ ),
312
+ 'auth': [
313
+ 'FactSetApiKey',
314
+ 'FactSetOAuth2'
315
+ ],
316
+ 'endpoint_path': '/nrt/speakerids',
317
+ 'operation_id': 'get_bulk_documents_nrt_v1_speaker_ids',
318
+ 'http_method': 'GET',
319
+ 'servers': None,
320
+ },
321
+ params_map={
322
+ 'all': [
323
+ 'audio_source_id',
324
+ 'sort',
325
+ 'pagination_limit',
326
+ 'pagination_offset',
327
+ ],
328
+ 'required': [
329
+ 'audio_source_id',
330
+ ],
331
+ 'nullable': [
332
+ ],
333
+ 'enum': [
334
+ 'sort',
335
+ ],
336
+ 'validation': [
337
+ 'sort',
338
+ ]
339
+ },
340
+ root_map={
341
+ 'validations': {
342
+ ('sort',): {
343
+
344
+ 'max_items': 2,
345
+ },
346
+ },
347
+ 'allowed_values': {
348
+ ('sort',): {
349
+
350
+ "SPEAKERSTARTOFFSET": "speakerStartOffset",
351
+ "-SPEAKERSTARTOFFSET": "-speakerStartOffset"
352
+ },
353
+ },
354
+ 'openapi_types': {
355
+ 'audio_source_id':
356
+ (int,),
357
+ 'sort':
358
+ ([str],),
359
+ 'pagination_limit':
360
+ (int,),
361
+ 'pagination_offset':
362
+ (int,),
363
+ },
364
+ 'attribute_map': {
365
+ 'audio_source_id': 'audioSourceId',
366
+ 'sort': '_sort',
367
+ 'pagination_limit': '_paginationLimit',
368
+ 'pagination_offset': '_paginationOffset',
369
+ },
370
+ 'location_map': {
371
+ 'audio_source_id': 'query',
372
+ 'sort': 'query',
373
+ 'pagination_limit': 'query',
374
+ 'pagination_offset': 'query',
375
+ },
376
+ 'collection_format_map': {
377
+ 'sort': 'csv',
378
+ }
379
+ },
380
+ headers_map={
381
+ 'accept': [
382
+ 'application/json'
383
+ ],
384
+ 'content_type': [],
385
+ },
386
+ api_client=api_client
387
+ )
388
+
389
+
390
+ @staticmethod
391
+ def apply_kwargs_defaults(kwargs, return_http_data_only, async_req):
392
+ kwargs["async_req"] = async_req
393
+ kwargs["_return_http_data_only"] = return_http_data_only
394
+ kwargs["_preload_content"] = kwargs.get("_preload_content", True)
395
+ kwargs["_request_timeout"] = kwargs.get("_request_timeout", None)
396
+ kwargs["_check_input_type"] = kwargs.get("_check_input_type", True)
397
+ kwargs["_check_return_type"] = kwargs.get("_check_return_type", True)
398
+ kwargs["_spec_property_naming"] = kwargs.get("_spec_property_naming", False)
399
+ kwargs["_content_type"] = kwargs.get("_content_type")
400
+ kwargs["_host_index"] = kwargs.get("_host_index")
401
+
402
+
403
+ def get_bulk_documents_nrt_v1_calls(
404
+ self,
405
+ **kwargs
406
+ ) -> NrtCalls:
407
+ """Returns the active calls happening at the moment based on ticker,call status and entity ID. # noqa: E501
408
+
409
+ Returns the active calls happening at the moment # noqa: E501
410
+ This method makes a synchronous HTTP request. Returns the http data only
411
+
412
+
413
+ Keyword Args:
414
+ ticker (str): Ticker-region identifier for the company hosting the event.. [optional]
415
+ entity_id (str): Factset entity level identifier for the company hosting the event.. [optional]
416
+ call_status (str): Status of the call, i.e., Ended, InProgress, EndedWithoutNotification, or IssueAtSource.. [optional]
417
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDatetimeUtc. . [optional] if omitted the server will use the default value of ["-eventDatetimeUtc"]
418
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
419
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
420
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
421
+ will be returned without reading/decoding response data.
422
+ Default is True. NOTE: if this API returns a file, it is the responsibility
423
+ of the caller to close the file stream.
424
+ _request_timeout (int/float/tuple): timeout setting for this request. If
425
+ one number provided, it will be total request timeout. It can also
426
+ be a pair (tuple) of (connection, read) timeouts.
427
+ Default is None.
428
+ _check_input_type (bool): specifies if type checking
429
+ should be done one the data sent to the server.
430
+ Default is True.
431
+ _check_return_type (bool): specifies if type checking
432
+ should be done one the data received from the server.
433
+ Default is True.
434
+ _spec_property_naming (bool): True if the variable names in the input data
435
+ are serialized names, as specified in the OpenAPI document.
436
+ False if the variable names in the input data
437
+ are pythonic names, e.g. snake case (default)
438
+ _content_type (str/None): force body content-type.
439
+ Default is None and content-type will be predicted by allowed
440
+ content-types and body.
441
+ _host_index (int/None): specifies the index of the server
442
+ that we want to use.
443
+ Default is read from the configuration.
444
+ Returns:
445
+ NrtCalls
446
+ Response Object
447
+ """
448
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
449
+ return self.get_bulk_documents_nrt_v1_calls_endpoint.call_with_http_info(**kwargs)
450
+
451
+ def get_bulk_documents_nrt_v1_calls_with_http_info(
452
+ self,
453
+ **kwargs
454
+ ) -> typing.Tuple[NrtCalls, int, typing.MutableMapping]:
455
+ """Returns the active calls happening at the moment based on ticker,call status and entity ID. # noqa: E501
456
+
457
+ Returns the active calls happening at the moment # noqa: E501
458
+ This method makes a synchronous HTTP request. Returns http data, http status and headers
459
+
460
+
461
+ Keyword Args:
462
+ ticker (str): Ticker-region identifier for the company hosting the event.. [optional]
463
+ entity_id (str): Factset entity level identifier for the company hosting the event.. [optional]
464
+ call_status (str): Status of the call, i.e., Ended, InProgress, EndedWithoutNotification, or IssueAtSource.. [optional]
465
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDatetimeUtc. . [optional] if omitted the server will use the default value of ["-eventDatetimeUtc"]
466
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
467
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
468
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
469
+ will be returned without reading/decoding response data.
470
+ Default is True. NOTE: if this API returns a file, it is the responsibility
471
+ of the caller to close the file stream.
472
+ _request_timeout (int/float/tuple): timeout setting for this request. If
473
+ one number provided, it will be total request timeout. It can also
474
+ be a pair (tuple) of (connection, read) timeouts.
475
+ Default is None.
476
+ _check_input_type (bool): specifies if type checking
477
+ should be done one the data sent to the server.
478
+ Default is True.
479
+ _check_return_type (bool): specifies if type checking
480
+ should be done one the data received from the server.
481
+ Default is True.
482
+ _spec_property_naming (bool): True if the variable names in the input data
483
+ are serialized names, as specified in the OpenAPI document.
484
+ False if the variable names in the input data
485
+ are pythonic names, e.g. snake case (default)
486
+ _content_type (str/None): force body content-type.
487
+ Default is None and content-type will be predicted by allowed
488
+ content-types and body.
489
+ _host_index (int/None): specifies the index of the server
490
+ that we want to use.
491
+ Default is read from the configuration.
492
+ Returns:
493
+ NrtCalls
494
+ Response Object
495
+ int
496
+ Http Status Code
497
+ dict
498
+ Dictionary of the response headers
499
+ """
500
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
501
+ return self.get_bulk_documents_nrt_v1_calls_endpoint.call_with_http_info(**kwargs)
502
+
503
+ def get_bulk_documents_nrt_v1_calls_async(
504
+ self,
505
+ **kwargs
506
+ ) -> "ApplyResult[NrtCalls]":
507
+ """Returns the active calls happening at the moment based on ticker,call status and entity ID. # noqa: E501
508
+
509
+ Returns the active calls happening at the moment # noqa: E501
510
+ This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
511
+
512
+
513
+ Keyword Args:
514
+ ticker (str): Ticker-region identifier for the company hosting the event.. [optional]
515
+ entity_id (str): Factset entity level identifier for the company hosting the event.. [optional]
516
+ call_status (str): Status of the call, i.e., Ended, InProgress, EndedWithoutNotification, or IssueAtSource.. [optional]
517
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDatetimeUtc. . [optional] if omitted the server will use the default value of ["-eventDatetimeUtc"]
518
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
519
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
520
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
521
+ will be returned without reading/decoding response data.
522
+ Default is True. NOTE: if this API returns a file, it is the responsibility
523
+ of the caller to close the file stream.
524
+ _request_timeout (int/float/tuple): timeout setting for this request. If
525
+ one number provided, it will be total request timeout. It can also
526
+ be a pair (tuple) of (connection, read) timeouts.
527
+ Default is None.
528
+ _check_input_type (bool): specifies if type checking
529
+ should be done one the data sent to the server.
530
+ Default is True.
531
+ _check_return_type (bool): specifies if type checking
532
+ should be done one the data received from the server.
533
+ Default is True.
534
+ _spec_property_naming (bool): True if the variable names in the input data
535
+ are serialized names, as specified in the OpenAPI document.
536
+ False if the variable names in the input data
537
+ are pythonic names, e.g. snake case (default)
538
+ _content_type (str/None): force body content-type.
539
+ Default is None and content-type will be predicted by allowed
540
+ content-types and body.
541
+ _host_index (int/None): specifies the index of the server
542
+ that we want to use.
543
+ Default is read from the configuration.
544
+ Returns:
545
+ ApplyResult[NrtCalls]
546
+ """
547
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
548
+ return self.get_bulk_documents_nrt_v1_calls_endpoint.call_with_http_info(**kwargs)
549
+
550
+ def get_bulk_documents_nrt_v1_calls_with_http_info_async(
551
+ self,
552
+ **kwargs
553
+ ) -> "ApplyResult[typing.Tuple[NrtCalls, int, typing.MutableMapping]]":
554
+ """Returns the active calls happening at the moment based on ticker,call status and entity ID. # noqa: E501
555
+
556
+ Returns the active calls happening at the moment # noqa: E501
557
+ This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
558
+
559
+
560
+ Keyword Args:
561
+ ticker (str): Ticker-region identifier for the company hosting the event.. [optional]
562
+ entity_id (str): Factset entity level identifier for the company hosting the event.. [optional]
563
+ call_status (str): Status of the call, i.e., Ended, InProgress, EndedWithoutNotification, or IssueAtSource.. [optional]
564
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDatetimeUtc. . [optional] if omitted the server will use the default value of ["-eventDatetimeUtc"]
565
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
566
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
567
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
568
+ will be returned without reading/decoding response data.
569
+ Default is True. NOTE: if this API returns a file, it is the responsibility
570
+ of the caller to close the file stream.
571
+ _request_timeout (int/float/tuple): timeout setting for this request. If
572
+ one number provided, it will be total request timeout. It can also
573
+ be a pair (tuple) of (connection, read) timeouts.
574
+ Default is None.
575
+ _check_input_type (bool): specifies if type checking
576
+ should be done one the data sent to the server.
577
+ Default is True.
578
+ _check_return_type (bool): specifies if type checking
579
+ should be done one the data received from the server.
580
+ Default is True.
581
+ _spec_property_naming (bool): True if the variable names in the input data
582
+ are serialized names, as specified in the OpenAPI document.
583
+ False if the variable names in the input data
584
+ are pythonic names, e.g. snake case (default)
585
+ _content_type (str/None): force body content-type.
586
+ Default is None and content-type will be predicted by allowed
587
+ content-types and body.
588
+ _host_index (int/None): specifies the index of the server
589
+ that we want to use.
590
+ Default is read from the configuration.
591
+ Returns:
592
+ ApplyResult[(NrtCalls, int, typing.Dict)]
593
+ """
594
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
595
+ return self.get_bulk_documents_nrt_v1_calls_endpoint.call_with_http_info(**kwargs)
596
+
597
+
598
+ def get_bulk_documents_nrt_v1_calls_by_audio_source_id(
599
+ self,
600
+ **kwargs
601
+ ) -> NrtCalls:
602
+ """Returns the active calls happening at the moment based on audio source ID and report ID. # noqa: E501
603
+
604
+ Returns the active calls happening at the moment # noqa: E501
605
+ This method makes a synchronous HTTP request. Returns the http data only
606
+
607
+
608
+ Keyword Args:
609
+ audio_source_id (int): Unique ID for an Internal recording specific to reportID. For example, ReportID X would have multiple recordings from different source (dial-in or webcast). One ReportID can have multiple AudioSourceIDs.. [optional]
610
+ report_id (int): Unique identifier for an event.. [optional]
611
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDatetimeUtc. . [optional] if omitted the server will use the default value of ["-eventDatetimeUtc"]
612
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
613
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
614
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
615
+ will be returned without reading/decoding response data.
616
+ Default is True. NOTE: if this API returns a file, it is the responsibility
617
+ of the caller to close the file stream.
618
+ _request_timeout (int/float/tuple): timeout setting for this request. If
619
+ one number provided, it will be total request timeout. It can also
620
+ be a pair (tuple) of (connection, read) timeouts.
621
+ Default is None.
622
+ _check_input_type (bool): specifies if type checking
623
+ should be done one the data sent to the server.
624
+ Default is True.
625
+ _check_return_type (bool): specifies if type checking
626
+ should be done one the data received from the server.
627
+ Default is True.
628
+ _spec_property_naming (bool): True if the variable names in the input data
629
+ are serialized names, as specified in the OpenAPI document.
630
+ False if the variable names in the input data
631
+ are pythonic names, e.g. snake case (default)
632
+ _content_type (str/None): force body content-type.
633
+ Default is None and content-type will be predicted by allowed
634
+ content-types and body.
635
+ _host_index (int/None): specifies the index of the server
636
+ that we want to use.
637
+ Default is read from the configuration.
638
+ Returns:
639
+ NrtCalls
640
+ Response Object
641
+ """
642
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
643
+ return self.get_bulk_documents_nrt_v1_calls_by_audio_source_id_endpoint.call_with_http_info(**kwargs)
644
+
645
+ def get_bulk_documents_nrt_v1_calls_by_audio_source_id_with_http_info(
646
+ self,
647
+ **kwargs
648
+ ) -> typing.Tuple[NrtCalls, int, typing.MutableMapping]:
649
+ """Returns the active calls happening at the moment based on audio source ID and report ID. # noqa: E501
650
+
651
+ Returns the active calls happening at the moment # noqa: E501
652
+ This method makes a synchronous HTTP request. Returns http data, http status and headers
653
+
654
+
655
+ Keyword Args:
656
+ audio_source_id (int): Unique ID for an Internal recording specific to reportID. For example, ReportID X would have multiple recordings from different source (dial-in or webcast). One ReportID can have multiple AudioSourceIDs.. [optional]
657
+ report_id (int): Unique identifier for an event.. [optional]
658
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDatetimeUtc. . [optional] if omitted the server will use the default value of ["-eventDatetimeUtc"]
659
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
660
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
661
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
662
+ will be returned without reading/decoding response data.
663
+ Default is True. NOTE: if this API returns a file, it is the responsibility
664
+ of the caller to close the file stream.
665
+ _request_timeout (int/float/tuple): timeout setting for this request. If
666
+ one number provided, it will be total request timeout. It can also
667
+ be a pair (tuple) of (connection, read) timeouts.
668
+ Default is None.
669
+ _check_input_type (bool): specifies if type checking
670
+ should be done one the data sent to the server.
671
+ Default is True.
672
+ _check_return_type (bool): specifies if type checking
673
+ should be done one the data received from the server.
674
+ Default is True.
675
+ _spec_property_naming (bool): True if the variable names in the input data
676
+ are serialized names, as specified in the OpenAPI document.
677
+ False if the variable names in the input data
678
+ are pythonic names, e.g. snake case (default)
679
+ _content_type (str/None): force body content-type.
680
+ Default is None and content-type will be predicted by allowed
681
+ content-types and body.
682
+ _host_index (int/None): specifies the index of the server
683
+ that we want to use.
684
+ Default is read from the configuration.
685
+ Returns:
686
+ NrtCalls
687
+ Response Object
688
+ int
689
+ Http Status Code
690
+ dict
691
+ Dictionary of the response headers
692
+ """
693
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
694
+ return self.get_bulk_documents_nrt_v1_calls_by_audio_source_id_endpoint.call_with_http_info(**kwargs)
695
+
696
+ def get_bulk_documents_nrt_v1_calls_by_audio_source_id_async(
697
+ self,
698
+ **kwargs
699
+ ) -> "ApplyResult[NrtCalls]":
700
+ """Returns the active calls happening at the moment based on audio source ID and report ID. # noqa: E501
701
+
702
+ Returns the active calls happening at the moment # noqa: E501
703
+ This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
704
+
705
+
706
+ Keyword Args:
707
+ audio_source_id (int): Unique ID for an Internal recording specific to reportID. For example, ReportID X would have multiple recordings from different source (dial-in or webcast). One ReportID can have multiple AudioSourceIDs.. [optional]
708
+ report_id (int): Unique identifier for an event.. [optional]
709
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDatetimeUtc. . [optional] if omitted the server will use the default value of ["-eventDatetimeUtc"]
710
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
711
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
712
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
713
+ will be returned without reading/decoding response data.
714
+ Default is True. NOTE: if this API returns a file, it is the responsibility
715
+ of the caller to close the file stream.
716
+ _request_timeout (int/float/tuple): timeout setting for this request. If
717
+ one number provided, it will be total request timeout. It can also
718
+ be a pair (tuple) of (connection, read) timeouts.
719
+ Default is None.
720
+ _check_input_type (bool): specifies if type checking
721
+ should be done one the data sent to the server.
722
+ Default is True.
723
+ _check_return_type (bool): specifies if type checking
724
+ should be done one the data received from the server.
725
+ Default is True.
726
+ _spec_property_naming (bool): True if the variable names in the input data
727
+ are serialized names, as specified in the OpenAPI document.
728
+ False if the variable names in the input data
729
+ are pythonic names, e.g. snake case (default)
730
+ _content_type (str/None): force body content-type.
731
+ Default is None and content-type will be predicted by allowed
732
+ content-types and body.
733
+ _host_index (int/None): specifies the index of the server
734
+ that we want to use.
735
+ Default is read from the configuration.
736
+ Returns:
737
+ ApplyResult[NrtCalls]
738
+ """
739
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
740
+ return self.get_bulk_documents_nrt_v1_calls_by_audio_source_id_endpoint.call_with_http_info(**kwargs)
741
+
742
+ def get_bulk_documents_nrt_v1_calls_by_audio_source_id_with_http_info_async(
743
+ self,
744
+ **kwargs
745
+ ) -> "ApplyResult[typing.Tuple[NrtCalls, int, typing.MutableMapping]]":
746
+ """Returns the active calls happening at the moment based on audio source ID and report ID. # noqa: E501
747
+
748
+ Returns the active calls happening at the moment # noqa: E501
749
+ This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
750
+
751
+
752
+ Keyword Args:
753
+ audio_source_id (int): Unique ID for an Internal recording specific to reportID. For example, ReportID X would have multiple recordings from different source (dial-in or webcast). One ReportID can have multiple AudioSourceIDs.. [optional]
754
+ report_id (int): Unique identifier for an event.. [optional]
755
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDatetimeUtc. . [optional] if omitted the server will use the default value of ["-eventDatetimeUtc"]
756
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
757
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
758
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
759
+ will be returned without reading/decoding response data.
760
+ Default is True. NOTE: if this API returns a file, it is the responsibility
761
+ of the caller to close the file stream.
762
+ _request_timeout (int/float/tuple): timeout setting for this request. If
763
+ one number provided, it will be total request timeout. It can also
764
+ be a pair (tuple) of (connection, read) timeouts.
765
+ Default is None.
766
+ _check_input_type (bool): specifies if type checking
767
+ should be done one the data sent to the server.
768
+ Default is True.
769
+ _check_return_type (bool): specifies if type checking
770
+ should be done one the data received from the server.
771
+ Default is True.
772
+ _spec_property_naming (bool): True if the variable names in the input data
773
+ are serialized names, as specified in the OpenAPI document.
774
+ False if the variable names in the input data
775
+ are pythonic names, e.g. snake case (default)
776
+ _content_type (str/None): force body content-type.
777
+ Default is None and content-type will be predicted by allowed
778
+ content-types and body.
779
+ _host_index (int/None): specifies the index of the server
780
+ that we want to use.
781
+ Default is read from the configuration.
782
+ Returns:
783
+ ApplyResult[(NrtCalls, int, typing.Dict)]
784
+ """
785
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
786
+ return self.get_bulk_documents_nrt_v1_calls_by_audio_source_id_endpoint.call_with_http_info(**kwargs)
787
+
788
+
789
+ def get_bulk_documents_nrt_v1_indexedrt(
790
+ self,
791
+ audio_source_id,
792
+ **kwargs
793
+ ) -> IndexedNrt:
794
+ """Returns the indexed transcript data in small increments throughout the duration of an active call. # noqa: E501
795
+
796
+ Returns the indexed transcript data in small increments throughout the duration of an active call. # noqa: E501
797
+ This method makes a synchronous HTTP request. Returns the http data only
798
+
799
+ Args:
800
+ audio_source_id (int): Unique ID for an Internal recording specific to reportID. For example, ReportID X would have multiple recordings from different source (dial-in or webcast). One ReportID can have multiple AudioSourceIDs.
801
+
802
+ Keyword Args:
803
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
804
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
805
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
806
+ will be returned without reading/decoding response data.
807
+ Default is True. NOTE: if this API returns a file, it is the responsibility
808
+ of the caller to close the file stream.
809
+ _request_timeout (int/float/tuple): timeout setting for this request. If
810
+ one number provided, it will be total request timeout. It can also
811
+ be a pair (tuple) of (connection, read) timeouts.
812
+ Default is None.
813
+ _check_input_type (bool): specifies if type checking
814
+ should be done one the data sent to the server.
815
+ Default is True.
816
+ _check_return_type (bool): specifies if type checking
817
+ should be done one the data received from the server.
818
+ Default is True.
819
+ _spec_property_naming (bool): True if the variable names in the input data
820
+ are serialized names, as specified in the OpenAPI document.
821
+ False if the variable names in the input data
822
+ are pythonic names, e.g. snake case (default)
823
+ _content_type (str/None): force body content-type.
824
+ Default is None and content-type will be predicted by allowed
825
+ content-types and body.
826
+ _host_index (int/None): specifies the index of the server
827
+ that we want to use.
828
+ Default is read from the configuration.
829
+ Returns:
830
+ IndexedNrt
831
+ Response Object
832
+ """
833
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
834
+ kwargs['audio_source_id'] = \
835
+ audio_source_id
836
+ return self.get_bulk_documents_nrt_v1_indexedrt_endpoint.call_with_http_info(**kwargs)
837
+
838
+ def get_bulk_documents_nrt_v1_indexedrt_with_http_info(
839
+ self,
840
+ audio_source_id,
841
+ **kwargs
842
+ ) -> typing.Tuple[IndexedNrt, int, typing.MutableMapping]:
843
+ """Returns the indexed transcript data in small increments throughout the duration of an active call. # noqa: E501
844
+
845
+ Returns the indexed transcript data in small increments throughout the duration of an active call. # noqa: E501
846
+ This method makes a synchronous HTTP request. Returns http data, http status and headers
847
+
848
+ Args:
849
+ audio_source_id (int): Unique ID for an Internal recording specific to reportID. For example, ReportID X would have multiple recordings from different source (dial-in or webcast). One ReportID can have multiple AudioSourceIDs.
850
+
851
+ Keyword Args:
852
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
853
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
854
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
855
+ will be returned without reading/decoding response data.
856
+ Default is True. NOTE: if this API returns a file, it is the responsibility
857
+ of the caller to close the file stream.
858
+ _request_timeout (int/float/tuple): timeout setting for this request. If
859
+ one number provided, it will be total request timeout. It can also
860
+ be a pair (tuple) of (connection, read) timeouts.
861
+ Default is None.
862
+ _check_input_type (bool): specifies if type checking
863
+ should be done one the data sent to the server.
864
+ Default is True.
865
+ _check_return_type (bool): specifies if type checking
866
+ should be done one the data received from the server.
867
+ Default is True.
868
+ _spec_property_naming (bool): True if the variable names in the input data
869
+ are serialized names, as specified in the OpenAPI document.
870
+ False if the variable names in the input data
871
+ are pythonic names, e.g. snake case (default)
872
+ _content_type (str/None): force body content-type.
873
+ Default is None and content-type will be predicted by allowed
874
+ content-types and body.
875
+ _host_index (int/None): specifies the index of the server
876
+ that we want to use.
877
+ Default is read from the configuration.
878
+ Returns:
879
+ IndexedNrt
880
+ Response Object
881
+ int
882
+ Http Status Code
883
+ dict
884
+ Dictionary of the response headers
885
+ """
886
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
887
+ kwargs['audio_source_id'] = \
888
+ audio_source_id
889
+ return self.get_bulk_documents_nrt_v1_indexedrt_endpoint.call_with_http_info(**kwargs)
890
+
891
+ def get_bulk_documents_nrt_v1_indexedrt_async(
892
+ self,
893
+ audio_source_id,
894
+ **kwargs
895
+ ) -> "ApplyResult[IndexedNrt]":
896
+ """Returns the indexed transcript data in small increments throughout the duration of an active call. # noqa: E501
897
+
898
+ Returns the indexed transcript data in small increments throughout the duration of an active call. # noqa: E501
899
+ This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
900
+
901
+ Args:
902
+ audio_source_id (int): Unique ID for an Internal recording specific to reportID. For example, ReportID X would have multiple recordings from different source (dial-in or webcast). One ReportID can have multiple AudioSourceIDs.
903
+
904
+ Keyword Args:
905
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
906
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
907
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
908
+ will be returned without reading/decoding response data.
909
+ Default is True. NOTE: if this API returns a file, it is the responsibility
910
+ of the caller to close the file stream.
911
+ _request_timeout (int/float/tuple): timeout setting for this request. If
912
+ one number provided, it will be total request timeout. It can also
913
+ be a pair (tuple) of (connection, read) timeouts.
914
+ Default is None.
915
+ _check_input_type (bool): specifies if type checking
916
+ should be done one the data sent to the server.
917
+ Default is True.
918
+ _check_return_type (bool): specifies if type checking
919
+ should be done one the data received from the server.
920
+ Default is True.
921
+ _spec_property_naming (bool): True if the variable names in the input data
922
+ are serialized names, as specified in the OpenAPI document.
923
+ False if the variable names in the input data
924
+ are pythonic names, e.g. snake case (default)
925
+ _content_type (str/None): force body content-type.
926
+ Default is None and content-type will be predicted by allowed
927
+ content-types and body.
928
+ _host_index (int/None): specifies the index of the server
929
+ that we want to use.
930
+ Default is read from the configuration.
931
+ Returns:
932
+ ApplyResult[IndexedNrt]
933
+ """
934
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
935
+ kwargs['audio_source_id'] = \
936
+ audio_source_id
937
+ return self.get_bulk_documents_nrt_v1_indexedrt_endpoint.call_with_http_info(**kwargs)
938
+
939
+ def get_bulk_documents_nrt_v1_indexedrt_with_http_info_async(
940
+ self,
941
+ audio_source_id,
942
+ **kwargs
943
+ ) -> "ApplyResult[typing.Tuple[IndexedNrt, int, typing.MutableMapping]]":
944
+ """Returns the indexed transcript data in small increments throughout the duration of an active call. # noqa: E501
945
+
946
+ Returns the indexed transcript data in small increments throughout the duration of an active call. # noqa: E501
947
+ This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
948
+
949
+ Args:
950
+ audio_source_id (int): Unique ID for an Internal recording specific to reportID. For example, ReportID X would have multiple recordings from different source (dial-in or webcast). One ReportID can have multiple AudioSourceIDs.
951
+
952
+ Keyword Args:
953
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
954
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
955
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
956
+ will be returned without reading/decoding response data.
957
+ Default is True. NOTE: if this API returns a file, it is the responsibility
958
+ of the caller to close the file stream.
959
+ _request_timeout (int/float/tuple): timeout setting for this request. If
960
+ one number provided, it will be total request timeout. It can also
961
+ be a pair (tuple) of (connection, read) timeouts.
962
+ Default is None.
963
+ _check_input_type (bool): specifies if type checking
964
+ should be done one the data sent to the server.
965
+ Default is True.
966
+ _check_return_type (bool): specifies if type checking
967
+ should be done one the data received from the server.
968
+ Default is True.
969
+ _spec_property_naming (bool): True if the variable names in the input data
970
+ are serialized names, as specified in the OpenAPI document.
971
+ False if the variable names in the input data
972
+ are pythonic names, e.g. snake case (default)
973
+ _content_type (str/None): force body content-type.
974
+ Default is None and content-type will be predicted by allowed
975
+ content-types and body.
976
+ _host_index (int/None): specifies the index of the server
977
+ that we want to use.
978
+ Default is read from the configuration.
979
+ Returns:
980
+ ApplyResult[(IndexedNrt, int, typing.Dict)]
981
+ """
982
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
983
+ kwargs['audio_source_id'] = \
984
+ audio_source_id
985
+ return self.get_bulk_documents_nrt_v1_indexedrt_endpoint.call_with_http_info(**kwargs)
986
+
987
+
988
+ def get_bulk_documents_nrt_v1_speaker_ids(
989
+ self,
990
+ audio_source_id,
991
+ **kwargs
992
+ ) -> NrtSpeakerIds:
993
+ """Returns the latest speakerIds with the confidence scores generated for an active call. # noqa: E501
994
+
995
+ Returns the latest speakerIds with the confidence scores generated for an active call. # noqa: E501
996
+ This method makes a synchronous HTTP request. Returns the http data only
997
+
998
+ Args:
999
+ audio_source_id (int): Unique ID for an Internal recording specific to reportID. For example, ReportID X would have multiple recordings from different source (dial-in or webcast). One ReportID can have multiple AudioSourceIDs.
1000
+
1001
+ Keyword Args:
1002
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on the start offset of the speaker. . [optional] if omitted the server will use the default value of ["-speakerStartOffset"]
1003
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
1004
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
1005
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1006
+ will be returned without reading/decoding response data.
1007
+ Default is True. NOTE: if this API returns a file, it is the responsibility
1008
+ of the caller to close the file stream.
1009
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1010
+ one number provided, it will be total request timeout. It can also
1011
+ be a pair (tuple) of (connection, read) timeouts.
1012
+ Default is None.
1013
+ _check_input_type (bool): specifies if type checking
1014
+ should be done one the data sent to the server.
1015
+ Default is True.
1016
+ _check_return_type (bool): specifies if type checking
1017
+ should be done one the data received from the server.
1018
+ Default is True.
1019
+ _spec_property_naming (bool): True if the variable names in the input data
1020
+ are serialized names, as specified in the OpenAPI document.
1021
+ False if the variable names in the input data
1022
+ are pythonic names, e.g. snake case (default)
1023
+ _content_type (str/None): force body content-type.
1024
+ Default is None and content-type will be predicted by allowed
1025
+ content-types and body.
1026
+ _host_index (int/None): specifies the index of the server
1027
+ that we want to use.
1028
+ Default is read from the configuration.
1029
+ Returns:
1030
+ NrtSpeakerIds
1031
+ Response Object
1032
+ """
1033
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
1034
+ kwargs['audio_source_id'] = \
1035
+ audio_source_id
1036
+ return self.get_bulk_documents_nrt_v1_speaker_ids_endpoint.call_with_http_info(**kwargs)
1037
+
1038
+ def get_bulk_documents_nrt_v1_speaker_ids_with_http_info(
1039
+ self,
1040
+ audio_source_id,
1041
+ **kwargs
1042
+ ) -> typing.Tuple[NrtSpeakerIds, int, typing.MutableMapping]:
1043
+ """Returns the latest speakerIds with the confidence scores generated for an active call. # noqa: E501
1044
+
1045
+ Returns the latest speakerIds with the confidence scores generated for an active call. # noqa: E501
1046
+ This method makes a synchronous HTTP request. Returns http data, http status and headers
1047
+
1048
+ Args:
1049
+ audio_source_id (int): Unique ID for an Internal recording specific to reportID. For example, ReportID X would have multiple recordings from different source (dial-in or webcast). One ReportID can have multiple AudioSourceIDs.
1050
+
1051
+ Keyword Args:
1052
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on the start offset of the speaker. . [optional] if omitted the server will use the default value of ["-speakerStartOffset"]
1053
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
1054
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
1055
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1056
+ will be returned without reading/decoding response data.
1057
+ Default is True. NOTE: if this API returns a file, it is the responsibility
1058
+ of the caller to close the file stream.
1059
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1060
+ one number provided, it will be total request timeout. It can also
1061
+ be a pair (tuple) of (connection, read) timeouts.
1062
+ Default is None.
1063
+ _check_input_type (bool): specifies if type checking
1064
+ should be done one the data sent to the server.
1065
+ Default is True.
1066
+ _check_return_type (bool): specifies if type checking
1067
+ should be done one the data received from the server.
1068
+ Default is True.
1069
+ _spec_property_naming (bool): True if the variable names in the input data
1070
+ are serialized names, as specified in the OpenAPI document.
1071
+ False if the variable names in the input data
1072
+ are pythonic names, e.g. snake case (default)
1073
+ _content_type (str/None): force body content-type.
1074
+ Default is None and content-type will be predicted by allowed
1075
+ content-types and body.
1076
+ _host_index (int/None): specifies the index of the server
1077
+ that we want to use.
1078
+ Default is read from the configuration.
1079
+ Returns:
1080
+ NrtSpeakerIds
1081
+ Response Object
1082
+ int
1083
+ Http Status Code
1084
+ dict
1085
+ Dictionary of the response headers
1086
+ """
1087
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
1088
+ kwargs['audio_source_id'] = \
1089
+ audio_source_id
1090
+ return self.get_bulk_documents_nrt_v1_speaker_ids_endpoint.call_with_http_info(**kwargs)
1091
+
1092
+ def get_bulk_documents_nrt_v1_speaker_ids_async(
1093
+ self,
1094
+ audio_source_id,
1095
+ **kwargs
1096
+ ) -> "ApplyResult[NrtSpeakerIds]":
1097
+ """Returns the latest speakerIds with the confidence scores generated for an active call. # noqa: E501
1098
+
1099
+ Returns the latest speakerIds with the confidence scores generated for an active call. # noqa: E501
1100
+ This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
1101
+
1102
+ Args:
1103
+ audio_source_id (int): Unique ID for an Internal recording specific to reportID. For example, ReportID X would have multiple recordings from different source (dial-in or webcast). One ReportID can have multiple AudioSourceIDs.
1104
+
1105
+ Keyword Args:
1106
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on the start offset of the speaker. . [optional] if omitted the server will use the default value of ["-speakerStartOffset"]
1107
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
1108
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
1109
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1110
+ will be returned without reading/decoding response data.
1111
+ Default is True. NOTE: if this API returns a file, it is the responsibility
1112
+ of the caller to close the file stream.
1113
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1114
+ one number provided, it will be total request timeout. It can also
1115
+ be a pair (tuple) of (connection, read) timeouts.
1116
+ Default is None.
1117
+ _check_input_type (bool): specifies if type checking
1118
+ should be done one the data sent to the server.
1119
+ Default is True.
1120
+ _check_return_type (bool): specifies if type checking
1121
+ should be done one the data received from the server.
1122
+ Default is True.
1123
+ _spec_property_naming (bool): True if the variable names in the input data
1124
+ are serialized names, as specified in the OpenAPI document.
1125
+ False if the variable names in the input data
1126
+ are pythonic names, e.g. snake case (default)
1127
+ _content_type (str/None): force body content-type.
1128
+ Default is None and content-type will be predicted by allowed
1129
+ content-types and body.
1130
+ _host_index (int/None): specifies the index of the server
1131
+ that we want to use.
1132
+ Default is read from the configuration.
1133
+ Returns:
1134
+ ApplyResult[NrtSpeakerIds]
1135
+ """
1136
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
1137
+ kwargs['audio_source_id'] = \
1138
+ audio_source_id
1139
+ return self.get_bulk_documents_nrt_v1_speaker_ids_endpoint.call_with_http_info(**kwargs)
1140
+
1141
+ def get_bulk_documents_nrt_v1_speaker_ids_with_http_info_async(
1142
+ self,
1143
+ audio_source_id,
1144
+ **kwargs
1145
+ ) -> "ApplyResult[typing.Tuple[NrtSpeakerIds, int, typing.MutableMapping]]":
1146
+ """Returns the latest speakerIds with the confidence scores generated for an active call. # noqa: E501
1147
+
1148
+ Returns the latest speakerIds with the confidence scores generated for an active call. # noqa: E501
1149
+ This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
1150
+
1151
+ Args:
1152
+ audio_source_id (int): Unique ID for an Internal recording specific to reportID. For example, ReportID X would have multiple recordings from different source (dial-in or webcast). One ReportID can have multiple AudioSourceIDs.
1153
+
1154
+ Keyword Args:
1155
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on the start offset of the speaker. . [optional] if omitted the server will use the default value of ["-speakerStartOffset"]
1156
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
1157
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
1158
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1159
+ will be returned without reading/decoding response data.
1160
+ Default is True. NOTE: if this API returns a file, it is the responsibility
1161
+ of the caller to close the file stream.
1162
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1163
+ one number provided, it will be total request timeout. It can also
1164
+ be a pair (tuple) of (connection, read) timeouts.
1165
+ Default is None.
1166
+ _check_input_type (bool): specifies if type checking
1167
+ should be done one the data sent to the server.
1168
+ Default is True.
1169
+ _check_return_type (bool): specifies if type checking
1170
+ should be done one the data received from the server.
1171
+ Default is True.
1172
+ _spec_property_naming (bool): True if the variable names in the input data
1173
+ are serialized names, as specified in the OpenAPI document.
1174
+ False if the variable names in the input data
1175
+ are pythonic names, e.g. snake case (default)
1176
+ _content_type (str/None): force body content-type.
1177
+ Default is None and content-type will be predicted by allowed
1178
+ content-types and body.
1179
+ _host_index (int/None): specifies the index of the server
1180
+ that we want to use.
1181
+ Default is read from the configuration.
1182
+ Returns:
1183
+ ApplyResult[(NrtSpeakerIds, int, typing.Dict)]
1184
+ """
1185
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
1186
+ kwargs['audio_source_id'] = \
1187
+ audio_source_id
1188
+ return self.get_bulk_documents_nrt_v1_speaker_ids_endpoint.call_with_http_info(**kwargs)
1189
+
1190
+