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,1682 @@
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.response_categories import ResponseCategories
30
+ from fds.sdk.EventsandTranscripts.model.response_time import ResponseTime
31
+ from fds.sdk.EventsandTranscripts.model.transcripts import Transcripts
32
+ from fds.sdk.EventsandTranscripts.model.transcripts_one import TranscriptsOne
33
+
34
+
35
+
36
+
37
+
38
+ class TranscriptsApi(object):
39
+ """NOTE: This class is auto generated by OpenAPI Generator
40
+ Ref: https://openapi-generator.tech
41
+
42
+ Do not edit the class manually.
43
+ """
44
+
45
+ def __init__(self, api_client=None):
46
+ if api_client is None:
47
+ api_client = ApiClient()
48
+ self.api_client = api_client
49
+
50
+ self.get_timezone_endpoint = _Endpoint(
51
+ settings={
52
+ 'response_type': (
53
+ { 200: (ResponseTime,), 400: (Error,), 401: (Error,), 403: (Error,), 500: (Error,), },
54
+ None
55
+ ),
56
+ 'auth': [
57
+ 'FactSetApiKey',
58
+ 'FactSetOAuth2'
59
+ ],
60
+ 'endpoint_path': '/reference/time-zones',
61
+ 'operation_id': 'get_timezone',
62
+ 'http_method': 'GET',
63
+ 'servers': None,
64
+ },
65
+ params_map={
66
+ 'all': [
67
+ ],
68
+ 'required': [],
69
+ 'nullable': [
70
+ ],
71
+ 'enum': [
72
+ ],
73
+ 'validation': [
74
+ ]
75
+ },
76
+ root_map={
77
+ 'validations': {
78
+ },
79
+ 'allowed_values': {
80
+ },
81
+ 'openapi_types': {
82
+ },
83
+ 'attribute_map': {
84
+ },
85
+ 'location_map': {
86
+ },
87
+ 'collection_format_map': {
88
+ }
89
+ },
90
+ headers_map={
91
+ 'accept': [
92
+ 'application/json'
93
+ ],
94
+ 'content_type': [],
95
+ },
96
+ api_client=api_client
97
+ )
98
+
99
+ self.get_transcripts_endpoint = _Endpoint(
100
+ settings={
101
+ 'response_type': (
102
+ { 200: (Transcripts,), 400: (Error,), 401: (Error,), 403: (Error,), 500: (Error,), },
103
+ None
104
+ ),
105
+ 'auth': [
106
+ 'FactSetApiKey',
107
+ 'FactSetOAuth2'
108
+ ],
109
+ 'endpoint_path': '/transcripts/search',
110
+ 'operation_id': 'get_transcripts',
111
+ 'http_method': 'GET',
112
+ 'servers': None,
113
+ },
114
+ params_map={
115
+ 'all': [
116
+ 'search_text',
117
+ 'sort',
118
+ 'pagination_limit',
119
+ 'pagination_offset',
120
+ ],
121
+ 'required': [],
122
+ 'nullable': [
123
+ ],
124
+ 'enum': [
125
+ 'sort',
126
+ ],
127
+ 'validation': [
128
+ 'sort',
129
+ ]
130
+ },
131
+ root_map={
132
+ 'validations': {
133
+ ('sort',): {
134
+
135
+ 'max_items': 2,
136
+ },
137
+ },
138
+ 'allowed_values': {
139
+ ('sort',): {
140
+
141
+ "STORYDATETIME": "storyDateTime",
142
+ "-STORYDATETIME": "-storyDateTime"
143
+ },
144
+ },
145
+ 'openapi_types': {
146
+ 'search_text':
147
+ (str,),
148
+ 'sort':
149
+ ([str],),
150
+ 'pagination_limit':
151
+ (int,),
152
+ 'pagination_offset':
153
+ (int,),
154
+ },
155
+ 'attribute_map': {
156
+ 'search_text': 'searchText',
157
+ 'sort': '_sort',
158
+ 'pagination_limit': '_paginationLimit',
159
+ 'pagination_offset': '_paginationOffset',
160
+ },
161
+ 'location_map': {
162
+ 'search_text': 'query',
163
+ 'sort': 'query',
164
+ 'pagination_limit': 'query',
165
+ 'pagination_offset': 'query',
166
+ },
167
+ 'collection_format_map': {
168
+ 'sort': 'csv',
169
+ }
170
+ },
171
+ headers_map={
172
+ 'accept': [
173
+ 'application/json'
174
+ ],
175
+ 'content_type': [],
176
+ },
177
+ api_client=api_client
178
+ )
179
+
180
+ self.get_transcripts_dates_endpoint = _Endpoint(
181
+ settings={
182
+ 'response_type': (
183
+ { 200: (Transcripts,), 400: (Error,), 401: (Error,), 403: (Error,), 500: (Error,), },
184
+ None
185
+ ),
186
+ 'auth': [
187
+ 'FactSetApiKey',
188
+ 'FactSetOAuth2'
189
+ ],
190
+ 'endpoint_path': '/transcripts/dates',
191
+ 'operation_id': 'get_transcripts_dates',
192
+ 'http_method': 'GET',
193
+ 'servers': None,
194
+ },
195
+ params_map={
196
+ 'all': [
197
+ 'start_date',
198
+ 'end_date',
199
+ 'start_date_relative',
200
+ 'end_date_relative',
201
+ 'time_zone',
202
+ 'sort',
203
+ 'pagination_limit',
204
+ 'pagination_offset',
205
+ ],
206
+ 'required': [],
207
+ 'nullable': [
208
+ ],
209
+ 'enum': [
210
+ 'sort',
211
+ ],
212
+ 'validation': [
213
+ 'sort',
214
+ ]
215
+ },
216
+ root_map={
217
+ 'validations': {
218
+ ('sort',): {
219
+
220
+ 'max_items': 2,
221
+ },
222
+ },
223
+ 'allowed_values': {
224
+ ('sort',): {
225
+
226
+ "STORYDATETIME": "storyDateTime",
227
+ "-STORYDATETIME": "-storyDateTime"
228
+ },
229
+ },
230
+ 'openapi_types': {
231
+ 'start_date':
232
+ (date,),
233
+ 'end_date':
234
+ (date,),
235
+ 'start_date_relative':
236
+ (int,),
237
+ 'end_date_relative':
238
+ (int,),
239
+ 'time_zone':
240
+ (str,),
241
+ 'sort':
242
+ ([str],),
243
+ 'pagination_limit':
244
+ (int,),
245
+ 'pagination_offset':
246
+ (int,),
247
+ },
248
+ 'attribute_map': {
249
+ 'start_date': 'startDate',
250
+ 'end_date': 'endDate',
251
+ 'start_date_relative': 'startDateRelative',
252
+ 'end_date_relative': 'endDateRelative',
253
+ 'time_zone': 'timeZone',
254
+ 'sort': '_sort',
255
+ 'pagination_limit': '_paginationLimit',
256
+ 'pagination_offset': '_paginationOffset',
257
+ },
258
+ 'location_map': {
259
+ 'start_date': 'query',
260
+ 'end_date': 'query',
261
+ 'start_date_relative': 'query',
262
+ 'end_date_relative': 'query',
263
+ 'time_zone': 'query',
264
+ 'sort': 'query',
265
+ 'pagination_limit': 'query',
266
+ 'pagination_offset': 'query',
267
+ },
268
+ 'collection_format_map': {
269
+ 'sort': 'csv',
270
+ }
271
+ },
272
+ headers_map={
273
+ 'accept': [
274
+ 'application/json'
275
+ ],
276
+ 'content_type': [],
277
+ },
278
+ api_client=api_client
279
+ )
280
+
281
+ self.get_transcripts_events_endpoint = _Endpoint(
282
+ settings={
283
+ 'response_type': (
284
+ { 200: (Transcripts,), 400: (Error,), 401: (Error,), 403: (Error,), 500: (Error,), },
285
+ None
286
+ ),
287
+ 'auth': [
288
+ 'FactSetApiKey',
289
+ 'FactSetOAuth2'
290
+ ],
291
+ 'endpoint_path': '/transcripts/events',
292
+ 'operation_id': 'get_transcripts_events',
293
+ 'http_method': 'GET',
294
+ 'servers': None,
295
+ },
296
+ params_map={
297
+ 'all': [
298
+ 'event_ids',
299
+ 'event_type',
300
+ 'sort',
301
+ 'pagination_limit',
302
+ 'pagination_offset',
303
+ ],
304
+ 'required': [],
305
+ 'nullable': [
306
+ ],
307
+ 'enum': [
308
+ 'event_type',
309
+ 'sort',
310
+ ],
311
+ 'validation': [
312
+ 'event_ids',
313
+ 'sort',
314
+ ]
315
+ },
316
+ root_map={
317
+ 'validations': {
318
+ ('event_ids',): {
319
+
320
+ 'max_items': 1000,
321
+ },
322
+ ('sort',): {
323
+
324
+ 'max_items': 2,
325
+ },
326
+ },
327
+ 'allowed_values': {
328
+ ('event_type',): {
329
+
330
+ "EARNINGS": "Earnings",
331
+ "GUIDANCE": "Guidance",
332
+ "ANALYSTSSHAREHOLDERSMEETING": "AnalystsShareholdersMeeting",
333
+ "CONFERENCEPRESENTATION": "ConferencePresentation",
334
+ "SALESREVENUE": "SalesRevenue",
335
+ "SPECIALSITUATION": "SpecialSituation"
336
+ },
337
+ ('sort',): {
338
+
339
+ "STORYDATETIME": "storyDateTime",
340
+ "-STORYDATETIME": "-storyDateTime"
341
+ },
342
+ },
343
+ 'openapi_types': {
344
+ 'event_ids':
345
+ ([str],),
346
+ 'event_type':
347
+ (str,),
348
+ 'sort':
349
+ ([str],),
350
+ 'pagination_limit':
351
+ (int,),
352
+ 'pagination_offset':
353
+ (int,),
354
+ },
355
+ 'attribute_map': {
356
+ 'event_ids': 'eventIds',
357
+ 'event_type': 'eventType',
358
+ 'sort': '_sort',
359
+ 'pagination_limit': '_paginationLimit',
360
+ 'pagination_offset': '_paginationOffset',
361
+ },
362
+ 'location_map': {
363
+ 'event_ids': 'query',
364
+ 'event_type': 'query',
365
+ 'sort': 'query',
366
+ 'pagination_limit': 'query',
367
+ 'pagination_offset': 'query',
368
+ },
369
+ 'collection_format_map': {
370
+ 'event_ids': 'csv',
371
+ 'sort': 'csv',
372
+ }
373
+ },
374
+ headers_map={
375
+ 'accept': [
376
+ 'application/json'
377
+ ],
378
+ 'content_type': [],
379
+ },
380
+ api_client=api_client
381
+ )
382
+
383
+ self.get_transcripts_ids_endpoint = _Endpoint(
384
+ settings={
385
+ 'response_type': (
386
+ { 200: (TranscriptsOne,), 400: (Error,), 401: (Error,), 403: (Error,), 500: (Error,), },
387
+ None
388
+ ),
389
+ 'auth': [
390
+ 'FactSetApiKey',
391
+ 'FactSetOAuth2'
392
+ ],
393
+ 'endpoint_path': '/transcripts/ids',
394
+ 'operation_id': 'get_transcripts_ids',
395
+ 'http_method': 'GET',
396
+ 'servers': None,
397
+ },
398
+ params_map={
399
+ 'all': [
400
+ 'primary_id',
401
+ 'ids',
402
+ 'report_ids',
403
+ 'categories',
404
+ 'sort',
405
+ 'pagination_limit',
406
+ 'pagination_offset',
407
+ ],
408
+ 'required': [],
409
+ 'nullable': [
410
+ ],
411
+ 'enum': [
412
+ 'primary_id',
413
+ 'sort',
414
+ ],
415
+ 'validation': [
416
+ 'ids',
417
+ 'report_ids',
418
+ 'sort',
419
+ ]
420
+ },
421
+ root_map={
422
+ 'validations': {
423
+ ('ids',): {
424
+
425
+ 'max_items': 1000,
426
+ },
427
+ ('report_ids',): {
428
+
429
+ 'max_items': 1000,
430
+ },
431
+ ('sort',): {
432
+
433
+ 'max_items': 2,
434
+ },
435
+ },
436
+ 'allowed_values': {
437
+ ('primary_id',): {
438
+
439
+ "TRUE": True,
440
+ "FALSE": False
441
+ },
442
+ ('sort',): {
443
+
444
+ "STORYDATETIME": "storyDateTime",
445
+ "-STORYDATETIME": "-storyDateTime"
446
+ },
447
+ },
448
+ 'openapi_types': {
449
+ 'primary_id':
450
+ (bool,),
451
+ 'ids':
452
+ ([str],),
453
+ 'report_ids':
454
+ ([str],),
455
+ 'categories':
456
+ ([str],),
457
+ 'sort':
458
+ ([str],),
459
+ 'pagination_limit':
460
+ (int,),
461
+ 'pagination_offset':
462
+ (int,),
463
+ },
464
+ 'attribute_map': {
465
+ 'primary_id': 'primaryId',
466
+ 'ids': 'ids',
467
+ 'report_ids': 'reportIds',
468
+ 'categories': 'categories',
469
+ 'sort': '_sort',
470
+ 'pagination_limit': '_paginationLimit',
471
+ 'pagination_offset': '_paginationOffset',
472
+ },
473
+ 'location_map': {
474
+ 'primary_id': 'query',
475
+ 'ids': 'query',
476
+ 'report_ids': 'query',
477
+ 'categories': 'query',
478
+ 'sort': 'query',
479
+ 'pagination_limit': 'query',
480
+ 'pagination_offset': 'query',
481
+ },
482
+ 'collection_format_map': {
483
+ 'ids': 'csv',
484
+ 'report_ids': 'csv',
485
+ 'categories': 'csv',
486
+ 'sort': 'csv',
487
+ }
488
+ },
489
+ headers_map={
490
+ 'accept': [
491
+ 'application/json'
492
+ ],
493
+ 'content_type': [],
494
+ },
495
+ api_client=api_client
496
+ )
497
+
498
+ self.getcategories_endpoint = _Endpoint(
499
+ settings={
500
+ 'response_type': (
501
+ { 200: (ResponseCategories,), 400: (Error,), 401: (Error,), 403: (Error,), 500: (Error,), },
502
+ None
503
+ ),
504
+ 'auth': [
505
+ 'FactSetApiKey',
506
+ 'FactSetOAuth2'
507
+ ],
508
+ 'endpoint_path': '/reference/categories',
509
+ 'operation_id': 'getcategories',
510
+ 'http_method': 'GET',
511
+ 'servers': None,
512
+ },
513
+ params_map={
514
+ 'all': [
515
+ ],
516
+ 'required': [],
517
+ 'nullable': [
518
+ ],
519
+ 'enum': [
520
+ ],
521
+ 'validation': [
522
+ ]
523
+ },
524
+ root_map={
525
+ 'validations': {
526
+ },
527
+ 'allowed_values': {
528
+ },
529
+ 'openapi_types': {
530
+ },
531
+ 'attribute_map': {
532
+ },
533
+ 'location_map': {
534
+ },
535
+ 'collection_format_map': {
536
+ }
537
+ },
538
+ headers_map={
539
+ 'accept': [
540
+ 'application/json'
541
+ ],
542
+ 'content_type': [],
543
+ },
544
+ api_client=api_client
545
+ )
546
+
547
+
548
+ @staticmethod
549
+ def apply_kwargs_defaults(kwargs, return_http_data_only, async_req):
550
+ kwargs["async_req"] = async_req
551
+ kwargs["_return_http_data_only"] = return_http_data_only
552
+ kwargs["_preload_content"] = kwargs.get("_preload_content", True)
553
+ kwargs["_request_timeout"] = kwargs.get("_request_timeout", None)
554
+ kwargs["_check_input_type"] = kwargs.get("_check_input_type", True)
555
+ kwargs["_check_return_type"] = kwargs.get("_check_return_type", True)
556
+ kwargs["_spec_property_naming"] = kwargs.get("_spec_property_naming", False)
557
+ kwargs["_content_type"] = kwargs.get("_content_type")
558
+ kwargs["_host_index"] = kwargs.get("_host_index")
559
+
560
+
561
+ def get_timezone(
562
+ self,
563
+ **kwargs
564
+ ) -> ResponseTime:
565
+ """Returns the time zones. # noqa: E501
566
+
567
+ Retrieves and delivers a comprehensive list of all available `timeZones`. # noqa: E501
568
+ This method makes a synchronous HTTP request. Returns the http data only
569
+
570
+
571
+ Keyword Args:
572
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
573
+ will be returned without reading/decoding response data.
574
+ Default is True. NOTE: if this API returns a file, it is the responsibility
575
+ of the caller to close the file stream.
576
+ _request_timeout (int/float/tuple): timeout setting for this request. If
577
+ one number provided, it will be total request timeout. It can also
578
+ be a pair (tuple) of (connection, read) timeouts.
579
+ Default is None.
580
+ _check_input_type (bool): specifies if type checking
581
+ should be done one the data sent to the server.
582
+ Default is True.
583
+ _check_return_type (bool): specifies if type checking
584
+ should be done one the data received from the server.
585
+ Default is True.
586
+ _spec_property_naming (bool): True if the variable names in the input data
587
+ are serialized names, as specified in the OpenAPI document.
588
+ False if the variable names in the input data
589
+ are pythonic names, e.g. snake case (default)
590
+ _content_type (str/None): force body content-type.
591
+ Default is None and content-type will be predicted by allowed
592
+ content-types and body.
593
+ _host_index (int/None): specifies the index of the server
594
+ that we want to use.
595
+ Default is read from the configuration.
596
+ Returns:
597
+ ResponseTime
598
+ Response Object
599
+ """
600
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
601
+ return self.get_timezone_endpoint.call_with_http_info(**kwargs)
602
+
603
+ def get_timezone_with_http_info(
604
+ self,
605
+ **kwargs
606
+ ) -> typing.Tuple[ResponseTime, int, typing.MutableMapping]:
607
+ """Returns the time zones. # noqa: E501
608
+
609
+ Retrieves and delivers a comprehensive list of all available `timeZones`. # noqa: E501
610
+ This method makes a synchronous HTTP request. Returns http data, http status and headers
611
+
612
+
613
+ Keyword Args:
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
+ ResponseTime
640
+ Response Object
641
+ int
642
+ Http Status Code
643
+ dict
644
+ Dictionary of the response headers
645
+ """
646
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
647
+ return self.get_timezone_endpoint.call_with_http_info(**kwargs)
648
+
649
+ def get_timezone_async(
650
+ self,
651
+ **kwargs
652
+ ) -> "ApplyResult[ResponseTime]":
653
+ """Returns the time zones. # noqa: E501
654
+
655
+ Retrieves and delivers a comprehensive list of all available `timeZones`. # noqa: E501
656
+ This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
657
+
658
+
659
+ Keyword Args:
660
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
661
+ will be returned without reading/decoding response data.
662
+ Default is True. NOTE: if this API returns a file, it is the responsibility
663
+ of the caller to close the file stream.
664
+ _request_timeout (int/float/tuple): timeout setting for this request. If
665
+ one number provided, it will be total request timeout. It can also
666
+ be a pair (tuple) of (connection, read) timeouts.
667
+ Default is None.
668
+ _check_input_type (bool): specifies if type checking
669
+ should be done one the data sent to the server.
670
+ Default is True.
671
+ _check_return_type (bool): specifies if type checking
672
+ should be done one the data received from the server.
673
+ Default is True.
674
+ _spec_property_naming (bool): True if the variable names in the input data
675
+ are serialized names, as specified in the OpenAPI document.
676
+ False if the variable names in the input data
677
+ are pythonic names, e.g. snake case (default)
678
+ _content_type (str/None): force body content-type.
679
+ Default is None and content-type will be predicted by allowed
680
+ content-types and body.
681
+ _host_index (int/None): specifies the index of the server
682
+ that we want to use.
683
+ Default is read from the configuration.
684
+ Returns:
685
+ ApplyResult[ResponseTime]
686
+ """
687
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
688
+ return self.get_timezone_endpoint.call_with_http_info(**kwargs)
689
+
690
+ def get_timezone_with_http_info_async(
691
+ self,
692
+ **kwargs
693
+ ) -> "ApplyResult[typing.Tuple[ResponseTime, int, typing.MutableMapping]]":
694
+ """Returns the time zones. # noqa: E501
695
+
696
+ Retrieves and delivers a comprehensive list of all available `timeZones`. # noqa: E501
697
+ This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
698
+
699
+
700
+ Keyword Args:
701
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
702
+ will be returned without reading/decoding response data.
703
+ Default is True. NOTE: if this API returns a file, it is the responsibility
704
+ of the caller to close the file stream.
705
+ _request_timeout (int/float/tuple): timeout setting for this request. If
706
+ one number provided, it will be total request timeout. It can also
707
+ be a pair (tuple) of (connection, read) timeouts.
708
+ Default is None.
709
+ _check_input_type (bool): specifies if type checking
710
+ should be done one the data sent to the server.
711
+ Default is True.
712
+ _check_return_type (bool): specifies if type checking
713
+ should be done one the data received from the server.
714
+ Default is True.
715
+ _spec_property_naming (bool): True if the variable names in the input data
716
+ are serialized names, as specified in the OpenAPI document.
717
+ False if the variable names in the input data
718
+ are pythonic names, e.g. snake case (default)
719
+ _content_type (str/None): force body content-type.
720
+ Default is None and content-type will be predicted by allowed
721
+ content-types and body.
722
+ _host_index (int/None): specifies the index of the server
723
+ that we want to use.
724
+ Default is read from the configuration.
725
+ Returns:
726
+ ApplyResult[(ResponseTime, int, typing.Dict)]
727
+ """
728
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
729
+ return self.get_timezone_endpoint.call_with_http_info(**kwargs)
730
+
731
+
732
+ def get_transcripts(
733
+ self,
734
+ **kwargs
735
+ ) -> Transcripts:
736
+ """Returns the transcript documents in XML format and related metadata within FactSet coverage based on search text. # noqa: E501
737
+
738
+ Returns the transcripts documents within FactSet coverage along with other response fields. All transcripts originate from Factset Callstreet Transcripts. # noqa: E501
739
+ This method makes a synchronous HTTP request. Returns the http data only
740
+
741
+
742
+ Keyword Args:
743
+ search_text (str): Restricts the search to include only document stories which include the text searched.. [optional]
744
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDate. . [optional] if omitted the server will use the default value of ["-storyDateTime"]
745
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
746
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
747
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
748
+ will be returned without reading/decoding response data.
749
+ Default is True. NOTE: if this API returns a file, it is the responsibility
750
+ of the caller to close the file stream.
751
+ _request_timeout (int/float/tuple): timeout setting for this request. If
752
+ one number provided, it will be total request timeout. It can also
753
+ be a pair (tuple) of (connection, read) timeouts.
754
+ Default is None.
755
+ _check_input_type (bool): specifies if type checking
756
+ should be done one the data sent to the server.
757
+ Default is True.
758
+ _check_return_type (bool): specifies if type checking
759
+ should be done one the data received from the server.
760
+ Default is True.
761
+ _spec_property_naming (bool): True if the variable names in the input data
762
+ are serialized names, as specified in the OpenAPI document.
763
+ False if the variable names in the input data
764
+ are pythonic names, e.g. snake case (default)
765
+ _content_type (str/None): force body content-type.
766
+ Default is None and content-type will be predicted by allowed
767
+ content-types and body.
768
+ _host_index (int/None): specifies the index of the server
769
+ that we want to use.
770
+ Default is read from the configuration.
771
+ Returns:
772
+ Transcripts
773
+ Response Object
774
+ """
775
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
776
+ return self.get_transcripts_endpoint.call_with_http_info(**kwargs)
777
+
778
+ def get_transcripts_with_http_info(
779
+ self,
780
+ **kwargs
781
+ ) -> typing.Tuple[Transcripts, int, typing.MutableMapping]:
782
+ """Returns the transcript documents in XML format and related metadata within FactSet coverage based on search text. # noqa: E501
783
+
784
+ Returns the transcripts documents within FactSet coverage along with other response fields. All transcripts originate from Factset Callstreet Transcripts. # noqa: E501
785
+ This method makes a synchronous HTTP request. Returns http data, http status and headers
786
+
787
+
788
+ Keyword Args:
789
+ search_text (str): Restricts the search to include only document stories which include the text searched.. [optional]
790
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDate. . [optional] if omitted the server will use the default value of ["-storyDateTime"]
791
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
792
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
793
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
794
+ will be returned without reading/decoding response data.
795
+ Default is True. NOTE: if this API returns a file, it is the responsibility
796
+ of the caller to close the file stream.
797
+ _request_timeout (int/float/tuple): timeout setting for this request. If
798
+ one number provided, it will be total request timeout. It can also
799
+ be a pair (tuple) of (connection, read) timeouts.
800
+ Default is None.
801
+ _check_input_type (bool): specifies if type checking
802
+ should be done one the data sent to the server.
803
+ Default is True.
804
+ _check_return_type (bool): specifies if type checking
805
+ should be done one the data received from the server.
806
+ Default is True.
807
+ _spec_property_naming (bool): True if the variable names in the input data
808
+ are serialized names, as specified in the OpenAPI document.
809
+ False if the variable names in the input data
810
+ are pythonic names, e.g. snake case (default)
811
+ _content_type (str/None): force body content-type.
812
+ Default is None and content-type will be predicted by allowed
813
+ content-types and body.
814
+ _host_index (int/None): specifies the index of the server
815
+ that we want to use.
816
+ Default is read from the configuration.
817
+ Returns:
818
+ Transcripts
819
+ Response Object
820
+ int
821
+ Http Status Code
822
+ dict
823
+ Dictionary of the response headers
824
+ """
825
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
826
+ return self.get_transcripts_endpoint.call_with_http_info(**kwargs)
827
+
828
+ def get_transcripts_async(
829
+ self,
830
+ **kwargs
831
+ ) -> "ApplyResult[Transcripts]":
832
+ """Returns the transcript documents in XML format and related metadata within FactSet coverage based on search text. # noqa: E501
833
+
834
+ Returns the transcripts documents within FactSet coverage along with other response fields. All transcripts originate from Factset Callstreet Transcripts. # noqa: E501
835
+ This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
836
+
837
+
838
+ Keyword Args:
839
+ search_text (str): Restricts the search to include only document stories which include the text searched.. [optional]
840
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDate. . [optional] if omitted the server will use the default value of ["-storyDateTime"]
841
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
842
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
843
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
844
+ will be returned without reading/decoding response data.
845
+ Default is True. NOTE: if this API returns a file, it is the responsibility
846
+ of the caller to close the file stream.
847
+ _request_timeout (int/float/tuple): timeout setting for this request. If
848
+ one number provided, it will be total request timeout. It can also
849
+ be a pair (tuple) of (connection, read) timeouts.
850
+ Default is None.
851
+ _check_input_type (bool): specifies if type checking
852
+ should be done one the data sent to the server.
853
+ Default is True.
854
+ _check_return_type (bool): specifies if type checking
855
+ should be done one the data received from the server.
856
+ Default is True.
857
+ _spec_property_naming (bool): True if the variable names in the input data
858
+ are serialized names, as specified in the OpenAPI document.
859
+ False if the variable names in the input data
860
+ are pythonic names, e.g. snake case (default)
861
+ _content_type (str/None): force body content-type.
862
+ Default is None and content-type will be predicted by allowed
863
+ content-types and body.
864
+ _host_index (int/None): specifies the index of the server
865
+ that we want to use.
866
+ Default is read from the configuration.
867
+ Returns:
868
+ ApplyResult[Transcripts]
869
+ """
870
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
871
+ return self.get_transcripts_endpoint.call_with_http_info(**kwargs)
872
+
873
+ def get_transcripts_with_http_info_async(
874
+ self,
875
+ **kwargs
876
+ ) -> "ApplyResult[typing.Tuple[Transcripts, int, typing.MutableMapping]]":
877
+ """Returns the transcript documents in XML format and related metadata within FactSet coverage based on search text. # noqa: E501
878
+
879
+ Returns the transcripts documents within FactSet coverage along with other response fields. All transcripts originate from Factset Callstreet Transcripts. # noqa: E501
880
+ This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
881
+
882
+
883
+ Keyword Args:
884
+ search_text (str): Restricts the search to include only document stories which include the text searched.. [optional]
885
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDate. . [optional] if omitted the server will use the default value of ["-storyDateTime"]
886
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
887
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
888
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
889
+ will be returned without reading/decoding response data.
890
+ Default is True. NOTE: if this API returns a file, it is the responsibility
891
+ of the caller to close the file stream.
892
+ _request_timeout (int/float/tuple): timeout setting for this request. If
893
+ one number provided, it will be total request timeout. It can also
894
+ be a pair (tuple) of (connection, read) timeouts.
895
+ Default is None.
896
+ _check_input_type (bool): specifies if type checking
897
+ should be done one the data sent to the server.
898
+ Default is True.
899
+ _check_return_type (bool): specifies if type checking
900
+ should be done one the data received from the server.
901
+ Default is True.
902
+ _spec_property_naming (bool): True if the variable names in the input data
903
+ are serialized names, as specified in the OpenAPI document.
904
+ False if the variable names in the input data
905
+ are pythonic names, e.g. snake case (default)
906
+ _content_type (str/None): force body content-type.
907
+ Default is None and content-type will be predicted by allowed
908
+ content-types and body.
909
+ _host_index (int/None): specifies the index of the server
910
+ that we want to use.
911
+ Default is read from the configuration.
912
+ Returns:
913
+ ApplyResult[(Transcripts, int, typing.Dict)]
914
+ """
915
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
916
+ return self.get_transcripts_endpoint.call_with_http_info(**kwargs)
917
+
918
+
919
+ def get_transcripts_dates(
920
+ self,
921
+ **kwargs
922
+ ) -> Transcripts:
923
+ """Returns the transcript documents in XML format and related metadata within FactSet coverage based on specific date range and time zones. # noqa: E501
924
+
925
+ Returns the transcripts documents within FactSet coverage along with other response fields. All transcripts originate from Factset Callstreet Transcripts. # noqa: E501
926
+ This method makes a synchronous HTTP request. Returns the http data only
927
+
928
+
929
+ Keyword Args:
930
+ start_date (date): Start Date. Format is YYYY-MM-DD **The API supports data from 1999 onwards. Ensure that the provided Date falls within this range for accurate results.** . [optional]
931
+ end_date (date): End Date. Format is YYYY-MM-DD.. [optional]
932
+ start_date_relative (int): The earliest date of the feed file the API should fetch based on the file timestamp. - Format: Specify the date using a relative term as an integer: '0' for today, '-1' for yesterday, '-2' for two days ago, and so forth. Negative values are used to represent past dates. - *Either `startDate` or `startDateRelative` should be used, but not both.* - *If both `startDate` and `startDateRelative` are provided in the same request, the API will return an error.* - *If users provide future dates in requests for `startDate` or `startDateRelative`, the API will not return any data.* . [optional]
933
+ end_date_relative (int): The latest date of the feed file the API should fetch for based on the file timestamp. - Format: Specify the date using a relative term as an integer: '0' for today, '-1' for yesterday, '-2' for two days ago, and so forth. Negative values are used to represent past dates. - *Either `endDate` or `endDateRelative` should be used, but not both.* - *If both `endDate` and `endDateRelative` are provided in the same request, the API will return an error.* - *If users provide future dates in requests for `endDate` or `endDateRelative`, the API will not return any data.* . [optional]
934
+ time_zone (str): timeZone to return story dates and times.Time zones, represented in POSIX format, are automatically adjusted for daylight savings. timeZone names are sourced from the IANA timezone registry. The time fields in the response will adhere to this specified timezone.. [optional] if omitted the server will use the default value of "America/New_York"
935
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDate. . [optional] if omitted the server will use the default value of ["-storyDateTime"]
936
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
937
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
938
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
939
+ will be returned without reading/decoding response data.
940
+ Default is True. NOTE: if this API returns a file, it is the responsibility
941
+ of the caller to close the file stream.
942
+ _request_timeout (int/float/tuple): timeout setting for this request. If
943
+ one number provided, it will be total request timeout. It can also
944
+ be a pair (tuple) of (connection, read) timeouts.
945
+ Default is None.
946
+ _check_input_type (bool): specifies if type checking
947
+ should be done one the data sent to the server.
948
+ Default is True.
949
+ _check_return_type (bool): specifies if type checking
950
+ should be done one the data received from the server.
951
+ Default is True.
952
+ _spec_property_naming (bool): True if the variable names in the input data
953
+ are serialized names, as specified in the OpenAPI document.
954
+ False if the variable names in the input data
955
+ are pythonic names, e.g. snake case (default)
956
+ _content_type (str/None): force body content-type.
957
+ Default is None and content-type will be predicted by allowed
958
+ content-types and body.
959
+ _host_index (int/None): specifies the index of the server
960
+ that we want to use.
961
+ Default is read from the configuration.
962
+ Returns:
963
+ Transcripts
964
+ Response Object
965
+ """
966
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
967
+ return self.get_transcripts_dates_endpoint.call_with_http_info(**kwargs)
968
+
969
+ def get_transcripts_dates_with_http_info(
970
+ self,
971
+ **kwargs
972
+ ) -> typing.Tuple[Transcripts, int, typing.MutableMapping]:
973
+ """Returns the transcript documents in XML format and related metadata within FactSet coverage based on specific date range and time zones. # noqa: E501
974
+
975
+ Returns the transcripts documents within FactSet coverage along with other response fields. All transcripts originate from Factset Callstreet Transcripts. # noqa: E501
976
+ This method makes a synchronous HTTP request. Returns http data, http status and headers
977
+
978
+
979
+ Keyword Args:
980
+ start_date (date): Start Date. Format is YYYY-MM-DD **The API supports data from 1999 onwards. Ensure that the provided Date falls within this range for accurate results.** . [optional]
981
+ end_date (date): End Date. Format is YYYY-MM-DD.. [optional]
982
+ start_date_relative (int): The earliest date of the feed file the API should fetch based on the file timestamp. - Format: Specify the date using a relative term as an integer: '0' for today, '-1' for yesterday, '-2' for two days ago, and so forth. Negative values are used to represent past dates. - *Either `startDate` or `startDateRelative` should be used, but not both.* - *If both `startDate` and `startDateRelative` are provided in the same request, the API will return an error.* - *If users provide future dates in requests for `startDate` or `startDateRelative`, the API will not return any data.* . [optional]
983
+ end_date_relative (int): The latest date of the feed file the API should fetch for based on the file timestamp. - Format: Specify the date using a relative term as an integer: '0' for today, '-1' for yesterday, '-2' for two days ago, and so forth. Negative values are used to represent past dates. - *Either `endDate` or `endDateRelative` should be used, but not both.* - *If both `endDate` and `endDateRelative` are provided in the same request, the API will return an error.* - *If users provide future dates in requests for `endDate` or `endDateRelative`, the API will not return any data.* . [optional]
984
+ time_zone (str): timeZone to return story dates and times.Time zones, represented in POSIX format, are automatically adjusted for daylight savings. timeZone names are sourced from the IANA timezone registry. The time fields in the response will adhere to this specified timezone.. [optional] if omitted the server will use the default value of "America/New_York"
985
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDate. . [optional] if omitted the server will use the default value of ["-storyDateTime"]
986
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
987
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
988
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
989
+ will be returned without reading/decoding response data.
990
+ Default is True. NOTE: if this API returns a file, it is the responsibility
991
+ of the caller to close the file stream.
992
+ _request_timeout (int/float/tuple): timeout setting for this request. If
993
+ one number provided, it will be total request timeout. It can also
994
+ be a pair (tuple) of (connection, read) timeouts.
995
+ Default is None.
996
+ _check_input_type (bool): specifies if type checking
997
+ should be done one the data sent to the server.
998
+ Default is True.
999
+ _check_return_type (bool): specifies if type checking
1000
+ should be done one the data received from the server.
1001
+ Default is True.
1002
+ _spec_property_naming (bool): True if the variable names in the input data
1003
+ are serialized names, as specified in the OpenAPI document.
1004
+ False if the variable names in the input data
1005
+ are pythonic names, e.g. snake case (default)
1006
+ _content_type (str/None): force body content-type.
1007
+ Default is None and content-type will be predicted by allowed
1008
+ content-types and body.
1009
+ _host_index (int/None): specifies the index of the server
1010
+ that we want to use.
1011
+ Default is read from the configuration.
1012
+ Returns:
1013
+ Transcripts
1014
+ Response Object
1015
+ int
1016
+ Http Status Code
1017
+ dict
1018
+ Dictionary of the response headers
1019
+ """
1020
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
1021
+ return self.get_transcripts_dates_endpoint.call_with_http_info(**kwargs)
1022
+
1023
+ def get_transcripts_dates_async(
1024
+ self,
1025
+ **kwargs
1026
+ ) -> "ApplyResult[Transcripts]":
1027
+ """Returns the transcript documents in XML format and related metadata within FactSet coverage based on specific date range and time zones. # noqa: E501
1028
+
1029
+ Returns the transcripts documents within FactSet coverage along with other response fields. All transcripts originate from Factset Callstreet Transcripts. # noqa: E501
1030
+ This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
1031
+
1032
+
1033
+ Keyword Args:
1034
+ start_date (date): Start Date. Format is YYYY-MM-DD **The API supports data from 1999 onwards. Ensure that the provided Date falls within this range for accurate results.** . [optional]
1035
+ end_date (date): End Date. Format is YYYY-MM-DD.. [optional]
1036
+ start_date_relative (int): The earliest date of the feed file the API should fetch based on the file timestamp. - Format: Specify the date using a relative term as an integer: '0' for today, '-1' for yesterday, '-2' for two days ago, and so forth. Negative values are used to represent past dates. - *Either `startDate` or `startDateRelative` should be used, but not both.* - *If both `startDate` and `startDateRelative` are provided in the same request, the API will return an error.* - *If users provide future dates in requests for `startDate` or `startDateRelative`, the API will not return any data.* . [optional]
1037
+ end_date_relative (int): The latest date of the feed file the API should fetch for based on the file timestamp. - Format: Specify the date using a relative term as an integer: '0' for today, '-1' for yesterday, '-2' for two days ago, and so forth. Negative values are used to represent past dates. - *Either `endDate` or `endDateRelative` should be used, but not both.* - *If both `endDate` and `endDateRelative` are provided in the same request, the API will return an error.* - *If users provide future dates in requests for `endDate` or `endDateRelative`, the API will not return any data.* . [optional]
1038
+ time_zone (str): timeZone to return story dates and times.Time zones, represented in POSIX format, are automatically adjusted for daylight savings. timeZone names are sourced from the IANA timezone registry. The time fields in the response will adhere to this specified timezone.. [optional] if omitted the server will use the default value of "America/New_York"
1039
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDate. . [optional] if omitted the server will use the default value of ["-storyDateTime"]
1040
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
1041
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
1042
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1043
+ will be returned without reading/decoding response data.
1044
+ Default is True. NOTE: if this API returns a file, it is the responsibility
1045
+ of the caller to close the file stream.
1046
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1047
+ one number provided, it will be total request timeout. It can also
1048
+ be a pair (tuple) of (connection, read) timeouts.
1049
+ Default is None.
1050
+ _check_input_type (bool): specifies if type checking
1051
+ should be done one the data sent to the server.
1052
+ Default is True.
1053
+ _check_return_type (bool): specifies if type checking
1054
+ should be done one the data received from the server.
1055
+ Default is True.
1056
+ _spec_property_naming (bool): True if the variable names in the input data
1057
+ are serialized names, as specified in the OpenAPI document.
1058
+ False if the variable names in the input data
1059
+ are pythonic names, e.g. snake case (default)
1060
+ _content_type (str/None): force body content-type.
1061
+ Default is None and content-type will be predicted by allowed
1062
+ content-types and body.
1063
+ _host_index (int/None): specifies the index of the server
1064
+ that we want to use.
1065
+ Default is read from the configuration.
1066
+ Returns:
1067
+ ApplyResult[Transcripts]
1068
+ """
1069
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
1070
+ return self.get_transcripts_dates_endpoint.call_with_http_info(**kwargs)
1071
+
1072
+ def get_transcripts_dates_with_http_info_async(
1073
+ self,
1074
+ **kwargs
1075
+ ) -> "ApplyResult[typing.Tuple[Transcripts, int, typing.MutableMapping]]":
1076
+ """Returns the transcript documents in XML format and related metadata within FactSet coverage based on specific date range and time zones. # noqa: E501
1077
+
1078
+ Returns the transcripts documents within FactSet coverage along with other response fields. All transcripts originate from Factset Callstreet Transcripts. # noqa: E501
1079
+ This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
1080
+
1081
+
1082
+ Keyword Args:
1083
+ start_date (date): Start Date. Format is YYYY-MM-DD **The API supports data from 1999 onwards. Ensure that the provided Date falls within this range for accurate results.** . [optional]
1084
+ end_date (date): End Date. Format is YYYY-MM-DD.. [optional]
1085
+ start_date_relative (int): The earliest date of the feed file the API should fetch based on the file timestamp. - Format: Specify the date using a relative term as an integer: '0' for today, '-1' for yesterday, '-2' for two days ago, and so forth. Negative values are used to represent past dates. - *Either `startDate` or `startDateRelative` should be used, but not both.* - *If both `startDate` and `startDateRelative` are provided in the same request, the API will return an error.* - *If users provide future dates in requests for `startDate` or `startDateRelative`, the API will not return any data.* . [optional]
1086
+ end_date_relative (int): The latest date of the feed file the API should fetch for based on the file timestamp. - Format: Specify the date using a relative term as an integer: '0' for today, '-1' for yesterday, '-2' for two days ago, and so forth. Negative values are used to represent past dates. - *Either `endDate` or `endDateRelative` should be used, but not both.* - *If both `endDate` and `endDateRelative` are provided in the same request, the API will return an error.* - *If users provide future dates in requests for `endDate` or `endDateRelative`, the API will not return any data.* . [optional]
1087
+ time_zone (str): timeZone to return story dates and times.Time zones, represented in POSIX format, are automatically adjusted for daylight savings. timeZone names are sourced from the IANA timezone registry. The time fields in the response will adhere to this specified timezone.. [optional] if omitted the server will use the default value of "America/New_York"
1088
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDate. . [optional] if omitted the server will use the default value of ["-storyDateTime"]
1089
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
1090
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
1091
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1092
+ will be returned without reading/decoding response data.
1093
+ Default is True. NOTE: if this API returns a file, it is the responsibility
1094
+ of the caller to close the file stream.
1095
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1096
+ one number provided, it will be total request timeout. It can also
1097
+ be a pair (tuple) of (connection, read) timeouts.
1098
+ Default is None.
1099
+ _check_input_type (bool): specifies if type checking
1100
+ should be done one the data sent to the server.
1101
+ Default is True.
1102
+ _check_return_type (bool): specifies if type checking
1103
+ should be done one the data received from the server.
1104
+ Default is True.
1105
+ _spec_property_naming (bool): True if the variable names in the input data
1106
+ are serialized names, as specified in the OpenAPI document.
1107
+ False if the variable names in the input data
1108
+ are pythonic names, e.g. snake case (default)
1109
+ _content_type (str/None): force body content-type.
1110
+ Default is None and content-type will be predicted by allowed
1111
+ content-types and body.
1112
+ _host_index (int/None): specifies the index of the server
1113
+ that we want to use.
1114
+ Default is read from the configuration.
1115
+ Returns:
1116
+ ApplyResult[(Transcripts, int, typing.Dict)]
1117
+ """
1118
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
1119
+ return self.get_transcripts_dates_endpoint.call_with_http_info(**kwargs)
1120
+
1121
+
1122
+ def get_transcripts_events(
1123
+ self,
1124
+ **kwargs
1125
+ ) -> Transcripts:
1126
+ """Returns the transcript documents in XML format and related metadata within FactSet coverage based on eventIds and eventType. # noqa: E501
1127
+
1128
+ Returns the transcripts documents within FactSet coverage along with other response fields. All transcripts originate from Factset Callstreet Transcripts. # noqa: E501
1129
+ This method makes a synchronous HTTP request. Returns the http data only
1130
+
1131
+
1132
+ Keyword Args:
1133
+ event_ids ([str]): Requests Event IDs. This is a comma-separated list with a maximum limit of 1000.. [optional]
1134
+ event_type (str): Specifies the type of event you want to retrieve. Earnings - Denotes an Earnings event. Guidance - Denotes a Guidance event. AnalystsShareholdersMeeting - Denotes an Analysts and Shareholders Meeting event. ConferencePresentation - Denotes a Conference Presentation event. SalesRevenue - Denotes a Sales/Revenue event. SpecialSituation - Denotes a Special Situation event (i.e. Merger/Acquisition).. [optional]
1135
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDate. . [optional] if omitted the server will use the default value of ["-storyDateTime"]
1136
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
1137
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
1138
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1139
+ will be returned without reading/decoding response data.
1140
+ Default is True. NOTE: if this API returns a file, it is the responsibility
1141
+ of the caller to close the file stream.
1142
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1143
+ one number provided, it will be total request timeout. It can also
1144
+ be a pair (tuple) of (connection, read) timeouts.
1145
+ Default is None.
1146
+ _check_input_type (bool): specifies if type checking
1147
+ should be done one the data sent to the server.
1148
+ Default is True.
1149
+ _check_return_type (bool): specifies if type checking
1150
+ should be done one the data received from the server.
1151
+ Default is True.
1152
+ _spec_property_naming (bool): True if the variable names in the input data
1153
+ are serialized names, as specified in the OpenAPI document.
1154
+ False if the variable names in the input data
1155
+ are pythonic names, e.g. snake case (default)
1156
+ _content_type (str/None): force body content-type.
1157
+ Default is None and content-type will be predicted by allowed
1158
+ content-types and body.
1159
+ _host_index (int/None): specifies the index of the server
1160
+ that we want to use.
1161
+ Default is read from the configuration.
1162
+ Returns:
1163
+ Transcripts
1164
+ Response Object
1165
+ """
1166
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
1167
+ return self.get_transcripts_events_endpoint.call_with_http_info(**kwargs)
1168
+
1169
+ def get_transcripts_events_with_http_info(
1170
+ self,
1171
+ **kwargs
1172
+ ) -> typing.Tuple[Transcripts, int, typing.MutableMapping]:
1173
+ """Returns the transcript documents in XML format and related metadata within FactSet coverage based on eventIds and eventType. # noqa: E501
1174
+
1175
+ Returns the transcripts documents within FactSet coverage along with other response fields. All transcripts originate from Factset Callstreet Transcripts. # noqa: E501
1176
+ This method makes a synchronous HTTP request. Returns http data, http status and headers
1177
+
1178
+
1179
+ Keyword Args:
1180
+ event_ids ([str]): Requests Event IDs. This is a comma-separated list with a maximum limit of 1000.. [optional]
1181
+ event_type (str): Specifies the type of event you want to retrieve. Earnings - Denotes an Earnings event. Guidance - Denotes a Guidance event. AnalystsShareholdersMeeting - Denotes an Analysts and Shareholders Meeting event. ConferencePresentation - Denotes a Conference Presentation event. SalesRevenue - Denotes a Sales/Revenue event. SpecialSituation - Denotes a Special Situation event (i.e. Merger/Acquisition).. [optional]
1182
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDate. . [optional] if omitted the server will use the default value of ["-storyDateTime"]
1183
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
1184
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
1185
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1186
+ will be returned without reading/decoding response data.
1187
+ Default is True. NOTE: if this API returns a file, it is the responsibility
1188
+ of the caller to close the file stream.
1189
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1190
+ one number provided, it will be total request timeout. It can also
1191
+ be a pair (tuple) of (connection, read) timeouts.
1192
+ Default is None.
1193
+ _check_input_type (bool): specifies if type checking
1194
+ should be done one the data sent to the server.
1195
+ Default is True.
1196
+ _check_return_type (bool): specifies if type checking
1197
+ should be done one the data received from the server.
1198
+ Default is True.
1199
+ _spec_property_naming (bool): True if the variable names in the input data
1200
+ are serialized names, as specified in the OpenAPI document.
1201
+ False if the variable names in the input data
1202
+ are pythonic names, e.g. snake case (default)
1203
+ _content_type (str/None): force body content-type.
1204
+ Default is None and content-type will be predicted by allowed
1205
+ content-types and body.
1206
+ _host_index (int/None): specifies the index of the server
1207
+ that we want to use.
1208
+ Default is read from the configuration.
1209
+ Returns:
1210
+ Transcripts
1211
+ Response Object
1212
+ int
1213
+ Http Status Code
1214
+ dict
1215
+ Dictionary of the response headers
1216
+ """
1217
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
1218
+ return self.get_transcripts_events_endpoint.call_with_http_info(**kwargs)
1219
+
1220
+ def get_transcripts_events_async(
1221
+ self,
1222
+ **kwargs
1223
+ ) -> "ApplyResult[Transcripts]":
1224
+ """Returns the transcript documents in XML format and related metadata within FactSet coverage based on eventIds and eventType. # noqa: E501
1225
+
1226
+ Returns the transcripts documents within FactSet coverage along with other response fields. All transcripts originate from Factset Callstreet Transcripts. # noqa: E501
1227
+ This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
1228
+
1229
+
1230
+ Keyword Args:
1231
+ event_ids ([str]): Requests Event IDs. This is a comma-separated list with a maximum limit of 1000.. [optional]
1232
+ event_type (str): Specifies the type of event you want to retrieve. Earnings - Denotes an Earnings event. Guidance - Denotes a Guidance event. AnalystsShareholdersMeeting - Denotes an Analysts and Shareholders Meeting event. ConferencePresentation - Denotes a Conference Presentation event. SalesRevenue - Denotes a Sales/Revenue event. SpecialSituation - Denotes a Special Situation event (i.e. Merger/Acquisition).. [optional]
1233
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDate. . [optional] if omitted the server will use the default value of ["-storyDateTime"]
1234
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
1235
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
1236
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1237
+ will be returned without reading/decoding response data.
1238
+ Default is True. NOTE: if this API returns a file, it is the responsibility
1239
+ of the caller to close the file stream.
1240
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1241
+ one number provided, it will be total request timeout. It can also
1242
+ be a pair (tuple) of (connection, read) timeouts.
1243
+ Default is None.
1244
+ _check_input_type (bool): specifies if type checking
1245
+ should be done one the data sent to the server.
1246
+ Default is True.
1247
+ _check_return_type (bool): specifies if type checking
1248
+ should be done one the data received from the server.
1249
+ Default is True.
1250
+ _spec_property_naming (bool): True if the variable names in the input data
1251
+ are serialized names, as specified in the OpenAPI document.
1252
+ False if the variable names in the input data
1253
+ are pythonic names, e.g. snake case (default)
1254
+ _content_type (str/None): force body content-type.
1255
+ Default is None and content-type will be predicted by allowed
1256
+ content-types and body.
1257
+ _host_index (int/None): specifies the index of the server
1258
+ that we want to use.
1259
+ Default is read from the configuration.
1260
+ Returns:
1261
+ ApplyResult[Transcripts]
1262
+ """
1263
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
1264
+ return self.get_transcripts_events_endpoint.call_with_http_info(**kwargs)
1265
+
1266
+ def get_transcripts_events_with_http_info_async(
1267
+ self,
1268
+ **kwargs
1269
+ ) -> "ApplyResult[typing.Tuple[Transcripts, int, typing.MutableMapping]]":
1270
+ """Returns the transcript documents in XML format and related metadata within FactSet coverage based on eventIds and eventType. # noqa: E501
1271
+
1272
+ Returns the transcripts documents within FactSet coverage along with other response fields. All transcripts originate from Factset Callstreet Transcripts. # noqa: E501
1273
+ This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
1274
+
1275
+
1276
+ Keyword Args:
1277
+ event_ids ([str]): Requests Event IDs. This is a comma-separated list with a maximum limit of 1000.. [optional]
1278
+ event_type (str): Specifies the type of event you want to retrieve. Earnings - Denotes an Earnings event. Guidance - Denotes a Guidance event. AnalystsShareholdersMeeting - Denotes an Analysts and Shareholders Meeting event. ConferencePresentation - Denotes a Conference Presentation event. SalesRevenue - Denotes a Sales/Revenue event. SpecialSituation - Denotes a Special Situation event (i.e. Merger/Acquisition).. [optional]
1279
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDate. . [optional] if omitted the server will use the default value of ["-storyDateTime"]
1280
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
1281
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
1282
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1283
+ will be returned without reading/decoding response data.
1284
+ Default is True. NOTE: if this API returns a file, it is the responsibility
1285
+ of the caller to close the file stream.
1286
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1287
+ one number provided, it will be total request timeout. It can also
1288
+ be a pair (tuple) of (connection, read) timeouts.
1289
+ Default is None.
1290
+ _check_input_type (bool): specifies if type checking
1291
+ should be done one the data sent to the server.
1292
+ Default is True.
1293
+ _check_return_type (bool): specifies if type checking
1294
+ should be done one the data received from the server.
1295
+ Default is True.
1296
+ _spec_property_naming (bool): True if the variable names in the input data
1297
+ are serialized names, as specified in the OpenAPI document.
1298
+ False if the variable names in the input data
1299
+ are pythonic names, e.g. snake case (default)
1300
+ _content_type (str/None): force body content-type.
1301
+ Default is None and content-type will be predicted by allowed
1302
+ content-types and body.
1303
+ _host_index (int/None): specifies the index of the server
1304
+ that we want to use.
1305
+ Default is read from the configuration.
1306
+ Returns:
1307
+ ApplyResult[(Transcripts, int, typing.Dict)]
1308
+ """
1309
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
1310
+ return self.get_transcripts_events_endpoint.call_with_http_info(**kwargs)
1311
+
1312
+
1313
+ def get_transcripts_ids(
1314
+ self,
1315
+ **kwargs
1316
+ ) -> TranscriptsOne:
1317
+ """Returns the transcript documents in XML format and related metadata within FactSet coverage based on specific IDs. # noqa: E501
1318
+
1319
+ Returns the transcripts documents within FactSet coverage along with other response fields. All transcripts originate from Factset Callstreet Transcripts. # noqa: E501
1320
+ This method makes a synchronous HTTP request. Returns the http data only
1321
+
1322
+
1323
+ Keyword Args:
1324
+ primary_id (bool): Type of identifier search * true - Returns headlines of stories that have the searched identifier(s) as the primary identifier. * false - Returns headlines of stories that mentioned or referred to the identifier.. [optional] if omitted the server will use the default value of False
1325
+ ids ([str]): Requested symbols or securities. This is a comma-separated list with a maximum limit of 1000. Each symbol can be a FactSet exchange symbol, CUSIP, or SEDOL.. [optional]
1326
+ report_ids ([str]): Requests Report IDs. This is a comma-separated list with a maximum limit of 1000. [optional]
1327
+ categories ([str]): Code for categories to include. This is a comma-separated list.which represent country, industry, and subject codes. Use the ```/reference/categories``` endpoint to get the list of available categories. Default = All categories.. [optional]
1328
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDate. . [optional] if omitted the server will use the default value of ["-storyDateTime"]
1329
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
1330
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
1331
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1332
+ will be returned without reading/decoding response data.
1333
+ Default is True. NOTE: if this API returns a file, it is the responsibility
1334
+ of the caller to close the file stream.
1335
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1336
+ one number provided, it will be total request timeout. It can also
1337
+ be a pair (tuple) of (connection, read) timeouts.
1338
+ Default is None.
1339
+ _check_input_type (bool): specifies if type checking
1340
+ should be done one the data sent to the server.
1341
+ Default is True.
1342
+ _check_return_type (bool): specifies if type checking
1343
+ should be done one the data received from the server.
1344
+ Default is True.
1345
+ _spec_property_naming (bool): True if the variable names in the input data
1346
+ are serialized names, as specified in the OpenAPI document.
1347
+ False if the variable names in the input data
1348
+ are pythonic names, e.g. snake case (default)
1349
+ _content_type (str/None): force body content-type.
1350
+ Default is None and content-type will be predicted by allowed
1351
+ content-types and body.
1352
+ _host_index (int/None): specifies the index of the server
1353
+ that we want to use.
1354
+ Default is read from the configuration.
1355
+ Returns:
1356
+ TranscriptsOne
1357
+ Response Object
1358
+ """
1359
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
1360
+ return self.get_transcripts_ids_endpoint.call_with_http_info(**kwargs)
1361
+
1362
+ def get_transcripts_ids_with_http_info(
1363
+ self,
1364
+ **kwargs
1365
+ ) -> typing.Tuple[TranscriptsOne, int, typing.MutableMapping]:
1366
+ """Returns the transcript documents in XML format and related metadata within FactSet coverage based on specific IDs. # noqa: E501
1367
+
1368
+ Returns the transcripts documents within FactSet coverage along with other response fields. All transcripts originate from Factset Callstreet Transcripts. # noqa: E501
1369
+ This method makes a synchronous HTTP request. Returns http data, http status and headers
1370
+
1371
+
1372
+ Keyword Args:
1373
+ primary_id (bool): Type of identifier search * true - Returns headlines of stories that have the searched identifier(s) as the primary identifier. * false - Returns headlines of stories that mentioned or referred to the identifier.. [optional] if omitted the server will use the default value of False
1374
+ ids ([str]): Requested symbols or securities. This is a comma-separated list with a maximum limit of 1000. Each symbol can be a FactSet exchange symbol, CUSIP, or SEDOL.. [optional]
1375
+ report_ids ([str]): Requests Report IDs. This is a comma-separated list with a maximum limit of 1000. [optional]
1376
+ categories ([str]): Code for categories to include. This is a comma-separated list.which represent country, industry, and subject codes. Use the ```/reference/categories``` endpoint to get the list of available categories. Default = All categories.. [optional]
1377
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDate. . [optional] if omitted the server will use the default value of ["-storyDateTime"]
1378
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
1379
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
1380
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1381
+ will be returned without reading/decoding response data.
1382
+ Default is True. NOTE: if this API returns a file, it is the responsibility
1383
+ of the caller to close the file stream.
1384
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1385
+ one number provided, it will be total request timeout. It can also
1386
+ be a pair (tuple) of (connection, read) timeouts.
1387
+ Default is None.
1388
+ _check_input_type (bool): specifies if type checking
1389
+ should be done one the data sent to the server.
1390
+ Default is True.
1391
+ _check_return_type (bool): specifies if type checking
1392
+ should be done one the data received from the server.
1393
+ Default is True.
1394
+ _spec_property_naming (bool): True if the variable names in the input data
1395
+ are serialized names, as specified in the OpenAPI document.
1396
+ False if the variable names in the input data
1397
+ are pythonic names, e.g. snake case (default)
1398
+ _content_type (str/None): force body content-type.
1399
+ Default is None and content-type will be predicted by allowed
1400
+ content-types and body.
1401
+ _host_index (int/None): specifies the index of the server
1402
+ that we want to use.
1403
+ Default is read from the configuration.
1404
+ Returns:
1405
+ TranscriptsOne
1406
+ Response Object
1407
+ int
1408
+ Http Status Code
1409
+ dict
1410
+ Dictionary of the response headers
1411
+ """
1412
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
1413
+ return self.get_transcripts_ids_endpoint.call_with_http_info(**kwargs)
1414
+
1415
+ def get_transcripts_ids_async(
1416
+ self,
1417
+ **kwargs
1418
+ ) -> "ApplyResult[TranscriptsOne]":
1419
+ """Returns the transcript documents in XML format and related metadata within FactSet coverage based on specific IDs. # noqa: E501
1420
+
1421
+ Returns the transcripts documents within FactSet coverage along with other response fields. All transcripts originate from Factset Callstreet Transcripts. # noqa: E501
1422
+ This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
1423
+
1424
+
1425
+ Keyword Args:
1426
+ primary_id (bool): Type of identifier search * true - Returns headlines of stories that have the searched identifier(s) as the primary identifier. * false - Returns headlines of stories that mentioned or referred to the identifier.. [optional] if omitted the server will use the default value of False
1427
+ ids ([str]): Requested symbols or securities. This is a comma-separated list with a maximum limit of 1000. Each symbol can be a FactSet exchange symbol, CUSIP, or SEDOL.. [optional]
1428
+ report_ids ([str]): Requests Report IDs. This is a comma-separated list with a maximum limit of 1000. [optional]
1429
+ categories ([str]): Code for categories to include. This is a comma-separated list.which represent country, industry, and subject codes. Use the ```/reference/categories``` endpoint to get the list of available categories. Default = All categories.. [optional]
1430
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDate. . [optional] if omitted the server will use the default value of ["-storyDateTime"]
1431
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
1432
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
1433
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1434
+ will be returned without reading/decoding response data.
1435
+ Default is True. NOTE: if this API returns a file, it is the responsibility
1436
+ of the caller to close the file stream.
1437
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1438
+ one number provided, it will be total request timeout. It can also
1439
+ be a pair (tuple) of (connection, read) timeouts.
1440
+ Default is None.
1441
+ _check_input_type (bool): specifies if type checking
1442
+ should be done one the data sent to the server.
1443
+ Default is True.
1444
+ _check_return_type (bool): specifies if type checking
1445
+ should be done one the data received from the server.
1446
+ Default is True.
1447
+ _spec_property_naming (bool): True if the variable names in the input data
1448
+ are serialized names, as specified in the OpenAPI document.
1449
+ False if the variable names in the input data
1450
+ are pythonic names, e.g. snake case (default)
1451
+ _content_type (str/None): force body content-type.
1452
+ Default is None and content-type will be predicted by allowed
1453
+ content-types and body.
1454
+ _host_index (int/None): specifies the index of the server
1455
+ that we want to use.
1456
+ Default is read from the configuration.
1457
+ Returns:
1458
+ ApplyResult[TranscriptsOne]
1459
+ """
1460
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
1461
+ return self.get_transcripts_ids_endpoint.call_with_http_info(**kwargs)
1462
+
1463
+ def get_transcripts_ids_with_http_info_async(
1464
+ self,
1465
+ **kwargs
1466
+ ) -> "ApplyResult[typing.Tuple[TranscriptsOne, int, typing.MutableMapping]]":
1467
+ """Returns the transcript documents in XML format and related metadata within FactSet coverage based on specific IDs. # noqa: E501
1468
+
1469
+ Returns the transcripts documents within FactSet coverage along with other response fields. All transcripts originate from Factset Callstreet Transcripts. # noqa: E501
1470
+ This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
1471
+
1472
+
1473
+ Keyword Args:
1474
+ primary_id (bool): Type of identifier search * true - Returns headlines of stories that have the searched identifier(s) as the primary identifier. * false - Returns headlines of stories that mentioned or referred to the identifier.. [optional] if omitted the server will use the default value of False
1475
+ ids ([str]): Requested symbols or securities. This is a comma-separated list with a maximum limit of 1000. Each symbol can be a FactSet exchange symbol, CUSIP, or SEDOL.. [optional]
1476
+ report_ids ([str]): Requests Report IDs. This is a comma-separated list with a maximum limit of 1000. [optional]
1477
+ categories ([str]): Code for categories to include. This is a comma-separated list.which represent country, industry, and subject codes. Use the ```/reference/categories``` endpoint to get the list of available categories. Default = All categories.. [optional]
1478
+ sort ([str]): Enables sorting data in ascending or descending chronological order based on eventDate. . [optional] if omitted the server will use the default value of ["-storyDateTime"]
1479
+ pagination_limit (int): Number of results to return per page.. [optional] if omitted the server will use the default value of 25
1480
+ pagination_offset (int): Page number of the results to return.. [optional] if omitted the server will use the default value of 0
1481
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1482
+ will be returned without reading/decoding response data.
1483
+ Default is True. NOTE: if this API returns a file, it is the responsibility
1484
+ of the caller to close the file stream.
1485
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1486
+ one number provided, it will be total request timeout. It can also
1487
+ be a pair (tuple) of (connection, read) timeouts.
1488
+ Default is None.
1489
+ _check_input_type (bool): specifies if type checking
1490
+ should be done one the data sent to the server.
1491
+ Default is True.
1492
+ _check_return_type (bool): specifies if type checking
1493
+ should be done one the data received from the server.
1494
+ Default is True.
1495
+ _spec_property_naming (bool): True if the variable names in the input data
1496
+ are serialized names, as specified in the OpenAPI document.
1497
+ False if the variable names in the input data
1498
+ are pythonic names, e.g. snake case (default)
1499
+ _content_type (str/None): force body content-type.
1500
+ Default is None and content-type will be predicted by allowed
1501
+ content-types and body.
1502
+ _host_index (int/None): specifies the index of the server
1503
+ that we want to use.
1504
+ Default is read from the configuration.
1505
+ Returns:
1506
+ ApplyResult[(TranscriptsOne, int, typing.Dict)]
1507
+ """
1508
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
1509
+ return self.get_transcripts_ids_endpoint.call_with_http_info(**kwargs)
1510
+
1511
+
1512
+ def getcategories(
1513
+ self,
1514
+ **kwargs
1515
+ ) -> ResponseCategories:
1516
+ """Returns the categories. # noqa: E501
1517
+
1518
+ Retrieves and delivers a comprehensive list of all available `categories`which are defined as country, industry, and subject codes. The data is returned as a comma-separated list. # noqa: E501
1519
+ This method makes a synchronous HTTP request. Returns the http data only
1520
+
1521
+
1522
+ Keyword Args:
1523
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1524
+ will be returned without reading/decoding response data.
1525
+ Default is True. NOTE: if this API returns a file, it is the responsibility
1526
+ of the caller to close the file stream.
1527
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1528
+ one number provided, it will be total request timeout. It can also
1529
+ be a pair (tuple) of (connection, read) timeouts.
1530
+ Default is None.
1531
+ _check_input_type (bool): specifies if type checking
1532
+ should be done one the data sent to the server.
1533
+ Default is True.
1534
+ _check_return_type (bool): specifies if type checking
1535
+ should be done one the data received from the server.
1536
+ Default is True.
1537
+ _spec_property_naming (bool): True if the variable names in the input data
1538
+ are serialized names, as specified in the OpenAPI document.
1539
+ False if the variable names in the input data
1540
+ are pythonic names, e.g. snake case (default)
1541
+ _content_type (str/None): force body content-type.
1542
+ Default is None and content-type will be predicted by allowed
1543
+ content-types and body.
1544
+ _host_index (int/None): specifies the index of the server
1545
+ that we want to use.
1546
+ Default is read from the configuration.
1547
+ Returns:
1548
+ ResponseCategories
1549
+ Response Object
1550
+ """
1551
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
1552
+ return self.getcategories_endpoint.call_with_http_info(**kwargs)
1553
+
1554
+ def getcategories_with_http_info(
1555
+ self,
1556
+ **kwargs
1557
+ ) -> typing.Tuple[ResponseCategories, int, typing.MutableMapping]:
1558
+ """Returns the categories. # noqa: E501
1559
+
1560
+ Retrieves and delivers a comprehensive list of all available `categories`which are defined as country, industry, and subject codes. The data is returned as a comma-separated list. # noqa: E501
1561
+ This method makes a synchronous HTTP request. Returns http data, http status and headers
1562
+
1563
+
1564
+ Keyword Args:
1565
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1566
+ will be returned without reading/decoding response data.
1567
+ Default is True. NOTE: if this API returns a file, it is the responsibility
1568
+ of the caller to close the file stream.
1569
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1570
+ one number provided, it will be total request timeout. It can also
1571
+ be a pair (tuple) of (connection, read) timeouts.
1572
+ Default is None.
1573
+ _check_input_type (bool): specifies if type checking
1574
+ should be done one the data sent to the server.
1575
+ Default is True.
1576
+ _check_return_type (bool): specifies if type checking
1577
+ should be done one the data received from the server.
1578
+ Default is True.
1579
+ _spec_property_naming (bool): True if the variable names in the input data
1580
+ are serialized names, as specified in the OpenAPI document.
1581
+ False if the variable names in the input data
1582
+ are pythonic names, e.g. snake case (default)
1583
+ _content_type (str/None): force body content-type.
1584
+ Default is None and content-type will be predicted by allowed
1585
+ content-types and body.
1586
+ _host_index (int/None): specifies the index of the server
1587
+ that we want to use.
1588
+ Default is read from the configuration.
1589
+ Returns:
1590
+ ResponseCategories
1591
+ Response Object
1592
+ int
1593
+ Http Status Code
1594
+ dict
1595
+ Dictionary of the response headers
1596
+ """
1597
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
1598
+ return self.getcategories_endpoint.call_with_http_info(**kwargs)
1599
+
1600
+ def getcategories_async(
1601
+ self,
1602
+ **kwargs
1603
+ ) -> "ApplyResult[ResponseCategories]":
1604
+ """Returns the categories. # noqa: E501
1605
+
1606
+ Retrieves and delivers a comprehensive list of all available `categories`which are defined as country, industry, and subject codes. The data is returned as a comma-separated list. # noqa: E501
1607
+ This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
1608
+
1609
+
1610
+ Keyword Args:
1611
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1612
+ will be returned without reading/decoding response data.
1613
+ Default is True. NOTE: if this API returns a file, it is the responsibility
1614
+ of the caller to close the file stream.
1615
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1616
+ one number provided, it will be total request timeout. It can also
1617
+ be a pair (tuple) of (connection, read) timeouts.
1618
+ Default is None.
1619
+ _check_input_type (bool): specifies if type checking
1620
+ should be done one the data sent to the server.
1621
+ Default is True.
1622
+ _check_return_type (bool): specifies if type checking
1623
+ should be done one the data received from the server.
1624
+ Default is True.
1625
+ _spec_property_naming (bool): True if the variable names in the input data
1626
+ are serialized names, as specified in the OpenAPI document.
1627
+ False if the variable names in the input data
1628
+ are pythonic names, e.g. snake case (default)
1629
+ _content_type (str/None): force body content-type.
1630
+ Default is None and content-type will be predicted by allowed
1631
+ content-types and body.
1632
+ _host_index (int/None): specifies the index of the server
1633
+ that we want to use.
1634
+ Default is read from the configuration.
1635
+ Returns:
1636
+ ApplyResult[ResponseCategories]
1637
+ """
1638
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
1639
+ return self.getcategories_endpoint.call_with_http_info(**kwargs)
1640
+
1641
+ def getcategories_with_http_info_async(
1642
+ self,
1643
+ **kwargs
1644
+ ) -> "ApplyResult[typing.Tuple[ResponseCategories, int, typing.MutableMapping]]":
1645
+ """Returns the categories. # noqa: E501
1646
+
1647
+ Retrieves and delivers a comprehensive list of all available `categories`which are defined as country, industry, and subject codes. The data is returned as a comma-separated list. # noqa: E501
1648
+ This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
1649
+
1650
+
1651
+ Keyword Args:
1652
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
1653
+ will be returned without reading/decoding response data.
1654
+ Default is True. NOTE: if this API returns a file, it is the responsibility
1655
+ of the caller to close the file stream.
1656
+ _request_timeout (int/float/tuple): timeout setting for this request. If
1657
+ one number provided, it will be total request timeout. It can also
1658
+ be a pair (tuple) of (connection, read) timeouts.
1659
+ Default is None.
1660
+ _check_input_type (bool): specifies if type checking
1661
+ should be done one the data sent to the server.
1662
+ Default is True.
1663
+ _check_return_type (bool): specifies if type checking
1664
+ should be done one the data received from the server.
1665
+ Default is True.
1666
+ _spec_property_naming (bool): True if the variable names in the input data
1667
+ are serialized names, as specified in the OpenAPI document.
1668
+ False if the variable names in the input data
1669
+ are pythonic names, e.g. snake case (default)
1670
+ _content_type (str/None): force body content-type.
1671
+ Default is None and content-type will be predicted by allowed
1672
+ content-types and body.
1673
+ _host_index (int/None): specifies the index of the server
1674
+ that we want to use.
1675
+ Default is read from the configuration.
1676
+ Returns:
1677
+ ApplyResult[(ResponseCategories, int, typing.Dict)]
1678
+ """
1679
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
1680
+ return self.getcategories_endpoint.call_with_http_info(**kwargs)
1681
+
1682
+