fds.sdk.FactSetProgrammaticEnvironment 0.21.6__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.
@@ -0,0 +1,1014 @@
1
+ """
2
+ FPE API
3
+
4
+ FactSet Programmatic Environment (FPE) API is an API for users to interact with FPE programmatically, streamlining path from research to production. # noqa: E501
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Generated by: https://openapi-generator.tech
8
+ """
9
+
10
+
11
+ import re # noqa: F401
12
+ import sys # noqa: F401
13
+ from multiprocessing.pool import ApplyResult
14
+ import typing
15
+
16
+ from fds.sdk.FactSetProgrammaticEnvironment.api_client import ApiClient, Endpoint as _Endpoint
17
+ from fds.sdk.FactSetProgrammaticEnvironment.model_utils import ( # noqa: F401
18
+ check_allowed_values,
19
+ check_validations,
20
+ date,
21
+ datetime,
22
+ file_type,
23
+ none_type,
24
+ validate_and_convert_types
25
+ )
26
+ from fds.sdk.FactSetProgrammaticEnvironment.exceptions import ApiException
27
+ from fds.sdk.FactSetProgrammaticEnvironment.model.calculation import Calculation
28
+ from fds.sdk.FactSetProgrammaticEnvironment.model.calculation_status import CalculationStatus
29
+
30
+
31
+
32
+
33
+
34
+ class CalculationsApi(object):
35
+ """NOTE: This class is auto generated by OpenAPI Generator
36
+ Ref: https://openapi-generator.tech
37
+
38
+ Do not edit the class manually.
39
+ """
40
+
41
+ def __init__(self, api_client=None):
42
+ if api_client is None:
43
+ api_client = ApiClient()
44
+ self.api_client = api_client
45
+
46
+ self.analytics_quant_fpe_v1_calculations_id_get_endpoint = _Endpoint(
47
+ settings={
48
+ 'response_type': (
49
+ { 200: (CalculationStatus,), 202: (CalculationStatus,), },
50
+ None
51
+ ),
52
+ 'auth': [
53
+ 'FactSetApiKey',
54
+ 'FactSetOAuth2'
55
+ ],
56
+ 'endpoint_path': '/analytics/quant/fpe/v1/calculations/{id}',
57
+ 'operation_id': 'analytics_quant_fpe_v1_calculations_id_get',
58
+ 'http_method': 'GET',
59
+ 'servers': None,
60
+ },
61
+ params_map={
62
+ 'all': [
63
+ 'id',
64
+ ],
65
+ 'required': [
66
+ 'id',
67
+ ],
68
+ 'nullable': [
69
+ ],
70
+ 'enum': [
71
+ ],
72
+ 'validation': [
73
+ ]
74
+ },
75
+ root_map={
76
+ 'validations': {
77
+ },
78
+ 'allowed_values': {
79
+ },
80
+ 'openapi_types': {
81
+ 'id':
82
+ (str,),
83
+ },
84
+ 'attribute_map': {
85
+ 'id': 'id',
86
+ },
87
+ 'location_map': {
88
+ 'id': 'path',
89
+ },
90
+ 'collection_format_map': {
91
+ }
92
+ },
93
+ headers_map={
94
+ 'accept': [
95
+ 'application/json'
96
+ ],
97
+ 'content_type': [],
98
+ },
99
+ api_client=api_client
100
+ )
101
+
102
+ self.analytics_quant_fpe_v1_calculations_id_log_get_endpoint = _Endpoint(
103
+ settings={
104
+ 'response_type': (
105
+ { 200: (file_type,), },
106
+ None
107
+ ),
108
+ 'auth': [
109
+ 'FactSetApiKey',
110
+ 'FactSetOAuth2'
111
+ ],
112
+ 'endpoint_path': '/analytics/quant/fpe/v1/calculations/{id}/log',
113
+ 'operation_id': 'analytics_quant_fpe_v1_calculations_id_log_get',
114
+ 'http_method': 'GET',
115
+ 'servers': None,
116
+ },
117
+ params_map={
118
+ 'all': [
119
+ 'id',
120
+ ],
121
+ 'required': [
122
+ 'id',
123
+ ],
124
+ 'nullable': [
125
+ ],
126
+ 'enum': [
127
+ ],
128
+ 'validation': [
129
+ ]
130
+ },
131
+ root_map={
132
+ 'validations': {
133
+ },
134
+ 'allowed_values': {
135
+ },
136
+ 'openapi_types': {
137
+ 'id':
138
+ (str,),
139
+ },
140
+ 'attribute_map': {
141
+ 'id': 'id',
142
+ },
143
+ 'location_map': {
144
+ 'id': 'path',
145
+ },
146
+ 'collection_format_map': {
147
+ }
148
+ },
149
+ headers_map={
150
+ 'accept': [
151
+ 'text/plain'
152
+ ],
153
+ 'content_type': [],
154
+ },
155
+ api_client=api_client
156
+ )
157
+
158
+ self.analytics_quant_fpe_v1_calculations_id_output_get_endpoint = _Endpoint(
159
+ settings={
160
+ 'response_type': (
161
+ { 200: (file_type,), },
162
+ None
163
+ ),
164
+ 'auth': [
165
+ 'FactSetApiKey',
166
+ 'FactSetOAuth2'
167
+ ],
168
+ 'endpoint_path': '/analytics/quant/fpe/v1/calculations/{id}/output',
169
+ 'operation_id': 'analytics_quant_fpe_v1_calculations_id_output_get',
170
+ 'http_method': 'GET',
171
+ 'servers': None,
172
+ },
173
+ params_map={
174
+ 'all': [
175
+ 'id',
176
+ ],
177
+ 'required': [
178
+ 'id',
179
+ ],
180
+ 'nullable': [
181
+ ],
182
+ 'enum': [
183
+ ],
184
+ 'validation': [
185
+ ]
186
+ },
187
+ root_map={
188
+ 'validations': {
189
+ },
190
+ 'allowed_values': {
191
+ },
192
+ 'openapi_types': {
193
+ 'id':
194
+ (str,),
195
+ },
196
+ 'attribute_map': {
197
+ 'id': 'id',
198
+ },
199
+ 'location_map': {
200
+ 'id': 'path',
201
+ },
202
+ 'collection_format_map': {
203
+ }
204
+ },
205
+ headers_map={
206
+ 'accept': [
207
+ '*'
208
+ ],
209
+ 'content_type': [],
210
+ },
211
+ api_client=api_client
212
+ )
213
+
214
+ self.analytics_quant_fpe_v1_calculations_post_endpoint = _Endpoint(
215
+ settings={
216
+ 'response_type': (
217
+ { 202: (CalculationStatus,), },
218
+ None
219
+ ),
220
+ 'auth': [
221
+ 'FactSetApiKey',
222
+ 'FactSetOAuth2'
223
+ ],
224
+ 'endpoint_path': '/analytics/quant/fpe/v1/calculations',
225
+ 'operation_id': 'analytics_quant_fpe_v1_calculations_post',
226
+ 'http_method': 'POST',
227
+ 'servers': None,
228
+ },
229
+ params_map={
230
+ 'all': [
231
+ 'calculation',
232
+ ],
233
+ 'required': [],
234
+ 'nullable': [
235
+ ],
236
+ 'enum': [
237
+ ],
238
+ 'validation': [
239
+ ]
240
+ },
241
+ root_map={
242
+ 'validations': {
243
+ },
244
+ 'allowed_values': {
245
+ },
246
+ 'openapi_types': {
247
+ 'calculation':
248
+ (Calculation,),
249
+ },
250
+ 'attribute_map': {
251
+ },
252
+ 'location_map': {
253
+ 'calculation': 'body',
254
+ },
255
+ 'collection_format_map': {
256
+ }
257
+ },
258
+ headers_map={
259
+ 'accept': [
260
+ 'application/json'
261
+ ],
262
+ 'content_type': [
263
+ 'application/json'
264
+ ]
265
+ },
266
+ api_client=api_client
267
+ )
268
+
269
+
270
+ @staticmethod
271
+ def apply_kwargs_defaults(kwargs, return_http_data_only, async_req):
272
+ kwargs["async_req"] = async_req
273
+ kwargs["_return_http_data_only"] = return_http_data_only
274
+ kwargs["_preload_content"] = kwargs.get("_preload_content", True)
275
+ kwargs["_request_timeout"] = kwargs.get("_request_timeout", None)
276
+ kwargs["_check_input_type"] = kwargs.get("_check_input_type", True)
277
+ kwargs["_check_return_type"] = kwargs.get("_check_return_type", True)
278
+ kwargs["_spec_property_naming"] = kwargs.get("_spec_property_naming", False)
279
+ kwargs["_content_type"] = kwargs.get("_content_type")
280
+ kwargs["_host_index"] = kwargs.get("_host_index")
281
+
282
+
283
+ def analytics_quant_fpe_v1_calculations_id_get(
284
+ self,
285
+ id,
286
+ **kwargs
287
+ ) -> CalculationStatus:
288
+ """Get calculation status by id # noqa: E501
289
+
290
+ This is the endpoint to check on the progress of a previous calculation request. # noqa: E501
291
+ This method makes a synchronous HTTP request. Returns the http data only
292
+
293
+ Args:
294
+ id (str): From url, provided by location header or response body in the calculation start endpoint
295
+
296
+ Keyword Args:
297
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
298
+ will be returned without reading/decoding response data.
299
+ Default is True.
300
+ _request_timeout (int/float/tuple): timeout setting for this request. If
301
+ one number provided, it will be total request timeout. It can also
302
+ be a pair (tuple) of (connection, read) timeouts.
303
+ Default is None.
304
+ _check_input_type (bool): specifies if type checking
305
+ should be done one the data sent to the server.
306
+ Default is True.
307
+ _check_return_type (bool): specifies if type checking
308
+ should be done one the data received from the server.
309
+ Default is True.
310
+ _spec_property_naming (bool): True if the variable names in the input data
311
+ are serialized names, as specified in the OpenAPI document.
312
+ False if the variable names in the input data
313
+ are pythonic names, e.g. snake case (default)
314
+ _content_type (str/None): force body content-type.
315
+ Default is None and content-type will be predicted by allowed
316
+ content-types and body.
317
+ _host_index (int/None): specifies the index of the server
318
+ that we want to use.
319
+ Default is read from the configuration.
320
+ Returns:
321
+ CalculationStatus
322
+ Response Object
323
+ """
324
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
325
+ kwargs['id'] = \
326
+ id
327
+ return self.analytics_quant_fpe_v1_calculations_id_get_endpoint.call_with_http_info(**kwargs)
328
+
329
+ def analytics_quant_fpe_v1_calculations_id_get_with_http_info(
330
+ self,
331
+ id,
332
+ **kwargs
333
+ ) -> typing.Tuple[CalculationStatus, int, typing.MutableMapping]:
334
+ """Get calculation status by id # noqa: E501
335
+
336
+ This is the endpoint to check on the progress of a previous calculation request. # noqa: E501
337
+ This method makes a synchronous HTTP request. Returns http data, http status and headers
338
+
339
+ Args:
340
+ id (str): From url, provided by location header or response body in the calculation start endpoint
341
+
342
+ Keyword Args:
343
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
344
+ will be returned without reading/decoding response data.
345
+ Default is True.
346
+ _request_timeout (int/float/tuple): timeout setting for this request. If
347
+ one number provided, it will be total request timeout. It can also
348
+ be a pair (tuple) of (connection, read) timeouts.
349
+ Default is None.
350
+ _check_input_type (bool): specifies if type checking
351
+ should be done one the data sent to the server.
352
+ Default is True.
353
+ _check_return_type (bool): specifies if type checking
354
+ should be done one the data received from the server.
355
+ Default is True.
356
+ _spec_property_naming (bool): True if the variable names in the input data
357
+ are serialized names, as specified in the OpenAPI document.
358
+ False if the variable names in the input data
359
+ are pythonic names, e.g. snake case (default)
360
+ _content_type (str/None): force body content-type.
361
+ Default is None and content-type will be predicted by allowed
362
+ content-types and body.
363
+ _host_index (int/None): specifies the index of the server
364
+ that we want to use.
365
+ Default is read from the configuration.
366
+ Returns:
367
+ CalculationStatus
368
+ Response Object
369
+ int
370
+ Http Status Code
371
+ dict
372
+ Dictionary of the response headers
373
+ """
374
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
375
+ kwargs['id'] = \
376
+ id
377
+ return self.analytics_quant_fpe_v1_calculations_id_get_endpoint.call_with_http_info(**kwargs)
378
+
379
+ def analytics_quant_fpe_v1_calculations_id_get_async(
380
+ self,
381
+ id,
382
+ **kwargs
383
+ ) -> "ApplyResult[CalculationStatus]":
384
+ """Get calculation status by id # noqa: E501
385
+
386
+ This is the endpoint to check on the progress of a previous calculation request. # noqa: E501
387
+ This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
388
+
389
+ Args:
390
+ id (str): From url, provided by location header or response body in the calculation start endpoint
391
+
392
+ Keyword Args:
393
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
394
+ will be returned without reading/decoding response data.
395
+ Default is True.
396
+ _request_timeout (int/float/tuple): timeout setting for this request. If
397
+ one number provided, it will be total request timeout. It can also
398
+ be a pair (tuple) of (connection, read) timeouts.
399
+ Default is None.
400
+ _check_input_type (bool): specifies if type checking
401
+ should be done one the data sent to the server.
402
+ Default is True.
403
+ _check_return_type (bool): specifies if type checking
404
+ should be done one the data received from the server.
405
+ Default is True.
406
+ _spec_property_naming (bool): True if the variable names in the input data
407
+ are serialized names, as specified in the OpenAPI document.
408
+ False if the variable names in the input data
409
+ are pythonic names, e.g. snake case (default)
410
+ _content_type (str/None): force body content-type.
411
+ Default is None and content-type will be predicted by allowed
412
+ content-types and body.
413
+ _host_index (int/None): specifies the index of the server
414
+ that we want to use.
415
+ Default is read from the configuration.
416
+ Returns:
417
+ ApplyResult[CalculationStatus]
418
+ """
419
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
420
+ kwargs['id'] = \
421
+ id
422
+ return self.analytics_quant_fpe_v1_calculations_id_get_endpoint.call_with_http_info(**kwargs)
423
+
424
+ def analytics_quant_fpe_v1_calculations_id_get_with_http_info_async(
425
+ self,
426
+ id,
427
+ **kwargs
428
+ ) -> "ApplyResult[typing.Tuple[CalculationStatus, int, typing.MutableMapping]]":
429
+ """Get calculation status by id # noqa: E501
430
+
431
+ This is the endpoint to check on the progress of a previous calculation request. # noqa: E501
432
+ This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
433
+
434
+ Args:
435
+ id (str): From url, provided by location header or response body in the calculation start endpoint
436
+
437
+ Keyword Args:
438
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
439
+ will be returned without reading/decoding response data.
440
+ Default is True.
441
+ _request_timeout (int/float/tuple): timeout setting for this request. If
442
+ one number provided, it will be total request timeout. It can also
443
+ be a pair (tuple) of (connection, read) timeouts.
444
+ Default is None.
445
+ _check_input_type (bool): specifies if type checking
446
+ should be done one the data sent to the server.
447
+ Default is True.
448
+ _check_return_type (bool): specifies if type checking
449
+ should be done one the data received from the server.
450
+ Default is True.
451
+ _spec_property_naming (bool): True if the variable names in the input data
452
+ are serialized names, as specified in the OpenAPI document.
453
+ False if the variable names in the input data
454
+ are pythonic names, e.g. snake case (default)
455
+ _content_type (str/None): force body content-type.
456
+ Default is None and content-type will be predicted by allowed
457
+ content-types and body.
458
+ _host_index (int/None): specifies the index of the server
459
+ that we want to use.
460
+ Default is read from the configuration.
461
+ Returns:
462
+ ApplyResult[(CalculationStatus, int, typing.Dict)]
463
+ """
464
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
465
+ kwargs['id'] = \
466
+ id
467
+ return self.analytics_quant_fpe_v1_calculations_id_get_endpoint.call_with_http_info(**kwargs)
468
+
469
+
470
+ def analytics_quant_fpe_v1_calculations_id_log_get(
471
+ self,
472
+ id,
473
+ **kwargs
474
+ ) -> file_type:
475
+ """Get calculation log for a specific calculation # noqa: E501
476
+
477
+ This endpoint returns the log from the calculation. # noqa: E501
478
+ This method makes a synchronous HTTP request. Returns the http data only
479
+
480
+ Args:
481
+ id (str): From url, provided by location header or response body in the calculation start endpoint
482
+
483
+ Keyword Args:
484
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
485
+ will be returned without reading/decoding response data.
486
+ Default is True.
487
+ _request_timeout (int/float/tuple): timeout setting for this request. If
488
+ one number provided, it will be total request timeout. It can also
489
+ be a pair (tuple) of (connection, read) timeouts.
490
+ Default is None.
491
+ _check_input_type (bool): specifies if type checking
492
+ should be done one the data sent to the server.
493
+ Default is True.
494
+ _check_return_type (bool): specifies if type checking
495
+ should be done one the data received from the server.
496
+ Default is True.
497
+ _spec_property_naming (bool): True if the variable names in the input data
498
+ are serialized names, as specified in the OpenAPI document.
499
+ False if the variable names in the input data
500
+ are pythonic names, e.g. snake case (default)
501
+ _content_type (str/None): force body content-type.
502
+ Default is None and content-type will be predicted by allowed
503
+ content-types and body.
504
+ _host_index (int/None): specifies the index of the server
505
+ that we want to use.
506
+ Default is read from the configuration.
507
+ Returns:
508
+ file_type
509
+ Response Object
510
+ """
511
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
512
+ kwargs['id'] = \
513
+ id
514
+ return self.analytics_quant_fpe_v1_calculations_id_log_get_endpoint.call_with_http_info(**kwargs)
515
+
516
+ def analytics_quant_fpe_v1_calculations_id_log_get_with_http_info(
517
+ self,
518
+ id,
519
+ **kwargs
520
+ ) -> typing.Tuple[file_type, int, typing.MutableMapping]:
521
+ """Get calculation log for a specific calculation # noqa: E501
522
+
523
+ This endpoint returns the log from the calculation. # noqa: E501
524
+ This method makes a synchronous HTTP request. Returns http data, http status and headers
525
+
526
+ Args:
527
+ id (str): From url, provided by location header or response body in the calculation start endpoint
528
+
529
+ Keyword Args:
530
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
531
+ will be returned without reading/decoding response data.
532
+ Default is True.
533
+ _request_timeout (int/float/tuple): timeout setting for this request. If
534
+ one number provided, it will be total request timeout. It can also
535
+ be a pair (tuple) of (connection, read) timeouts.
536
+ Default is None.
537
+ _check_input_type (bool): specifies if type checking
538
+ should be done one the data sent to the server.
539
+ Default is True.
540
+ _check_return_type (bool): specifies if type checking
541
+ should be done one the data received from the server.
542
+ Default is True.
543
+ _spec_property_naming (bool): True if the variable names in the input data
544
+ are serialized names, as specified in the OpenAPI document.
545
+ False if the variable names in the input data
546
+ are pythonic names, e.g. snake case (default)
547
+ _content_type (str/None): force body content-type.
548
+ Default is None and content-type will be predicted by allowed
549
+ content-types and body.
550
+ _host_index (int/None): specifies the index of the server
551
+ that we want to use.
552
+ Default is read from the configuration.
553
+ Returns:
554
+ file_type
555
+ Response Object
556
+ int
557
+ Http Status Code
558
+ dict
559
+ Dictionary of the response headers
560
+ """
561
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
562
+ kwargs['id'] = \
563
+ id
564
+ return self.analytics_quant_fpe_v1_calculations_id_log_get_endpoint.call_with_http_info(**kwargs)
565
+
566
+ def analytics_quant_fpe_v1_calculations_id_log_get_async(
567
+ self,
568
+ id,
569
+ **kwargs
570
+ ) -> "ApplyResult[file_type]":
571
+ """Get calculation log for a specific calculation # noqa: E501
572
+
573
+ This endpoint returns the log from the calculation. # noqa: E501
574
+ This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
575
+
576
+ Args:
577
+ id (str): From url, provided by location header or response body in the calculation start endpoint
578
+
579
+ Keyword Args:
580
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
581
+ will be returned without reading/decoding response data.
582
+ Default is True.
583
+ _request_timeout (int/float/tuple): timeout setting for this request. If
584
+ one number provided, it will be total request timeout. It can also
585
+ be a pair (tuple) of (connection, read) timeouts.
586
+ Default is None.
587
+ _check_input_type (bool): specifies if type checking
588
+ should be done one the data sent to the server.
589
+ Default is True.
590
+ _check_return_type (bool): specifies if type checking
591
+ should be done one the data received from the server.
592
+ Default is True.
593
+ _spec_property_naming (bool): True if the variable names in the input data
594
+ are serialized names, as specified in the OpenAPI document.
595
+ False if the variable names in the input data
596
+ are pythonic names, e.g. snake case (default)
597
+ _content_type (str/None): force body content-type.
598
+ Default is None and content-type will be predicted by allowed
599
+ content-types and body.
600
+ _host_index (int/None): specifies the index of the server
601
+ that we want to use.
602
+ Default is read from the configuration.
603
+ Returns:
604
+ ApplyResult[file_type]
605
+ """
606
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
607
+ kwargs['id'] = \
608
+ id
609
+ return self.analytics_quant_fpe_v1_calculations_id_log_get_endpoint.call_with_http_info(**kwargs)
610
+
611
+ def analytics_quant_fpe_v1_calculations_id_log_get_with_http_info_async(
612
+ self,
613
+ id,
614
+ **kwargs
615
+ ) -> "ApplyResult[typing.Tuple[file_type, int, typing.MutableMapping]]":
616
+ """Get calculation log for a specific calculation # noqa: E501
617
+
618
+ This endpoint returns the log from the calculation. # noqa: E501
619
+ This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
620
+
621
+ Args:
622
+ id (str): From url, provided by location header or response body in the calculation start endpoint
623
+
624
+ Keyword Args:
625
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
626
+ will be returned without reading/decoding response data.
627
+ Default is True.
628
+ _request_timeout (int/float/tuple): timeout setting for this request. If
629
+ one number provided, it will be total request timeout. It can also
630
+ be a pair (tuple) of (connection, read) timeouts.
631
+ Default is None.
632
+ _check_input_type (bool): specifies if type checking
633
+ should be done one the data sent to the server.
634
+ Default is True.
635
+ _check_return_type (bool): specifies if type checking
636
+ should be done one the data received from the server.
637
+ Default is True.
638
+ _spec_property_naming (bool): True if the variable names in the input data
639
+ are serialized names, as specified in the OpenAPI document.
640
+ False if the variable names in the input data
641
+ are pythonic names, e.g. snake case (default)
642
+ _content_type (str/None): force body content-type.
643
+ Default is None and content-type will be predicted by allowed
644
+ content-types and body.
645
+ _host_index (int/None): specifies the index of the server
646
+ that we want to use.
647
+ Default is read from the configuration.
648
+ Returns:
649
+ ApplyResult[(file_type, int, typing.Dict)]
650
+ """
651
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
652
+ kwargs['id'] = \
653
+ id
654
+ return self.analytics_quant_fpe_v1_calculations_id_log_get_endpoint.call_with_http_info(**kwargs)
655
+
656
+
657
+ def analytics_quant_fpe_v1_calculations_id_output_get(
658
+ self,
659
+ id,
660
+ **kwargs
661
+ ) -> file_type:
662
+ """Get calculation output for a specific calculation # noqa: E501
663
+
664
+ This endpoint returns the specified output from the calculation. # noqa: E501
665
+ This method makes a synchronous HTTP request. Returns the http data only
666
+
667
+ Args:
668
+ id (str): From url, provided by location header or response body in the calculation start endpoint
669
+
670
+ Keyword Args:
671
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
672
+ will be returned without reading/decoding response data.
673
+ Default is True.
674
+ _request_timeout (int/float/tuple): timeout setting for this request. If
675
+ one number provided, it will be total request timeout. It can also
676
+ be a pair (tuple) of (connection, read) timeouts.
677
+ Default is None.
678
+ _check_input_type (bool): specifies if type checking
679
+ should be done one the data sent to the server.
680
+ Default is True.
681
+ _check_return_type (bool): specifies if type checking
682
+ should be done one the data received from the server.
683
+ Default is True.
684
+ _spec_property_naming (bool): True if the variable names in the input data
685
+ are serialized names, as specified in the OpenAPI document.
686
+ False if the variable names in the input data
687
+ are pythonic names, e.g. snake case (default)
688
+ _content_type (str/None): force body content-type.
689
+ Default is None and content-type will be predicted by allowed
690
+ content-types and body.
691
+ _host_index (int/None): specifies the index of the server
692
+ that we want to use.
693
+ Default is read from the configuration.
694
+ Returns:
695
+ file_type
696
+ Response Object
697
+ """
698
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
699
+ kwargs['id'] = \
700
+ id
701
+ return self.analytics_quant_fpe_v1_calculations_id_output_get_endpoint.call_with_http_info(**kwargs)
702
+
703
+ def analytics_quant_fpe_v1_calculations_id_output_get_with_http_info(
704
+ self,
705
+ id,
706
+ **kwargs
707
+ ) -> typing.Tuple[file_type, int, typing.MutableMapping]:
708
+ """Get calculation output for a specific calculation # noqa: E501
709
+
710
+ This endpoint returns the specified output from the calculation. # noqa: E501
711
+ This method makes a synchronous HTTP request. Returns http data, http status and headers
712
+
713
+ Args:
714
+ id (str): From url, provided by location header or response body in the calculation start endpoint
715
+
716
+ Keyword Args:
717
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
718
+ will be returned without reading/decoding response data.
719
+ Default is True.
720
+ _request_timeout (int/float/tuple): timeout setting for this request. If
721
+ one number provided, it will be total request timeout. It can also
722
+ be a pair (tuple) of (connection, read) timeouts.
723
+ Default is None.
724
+ _check_input_type (bool): specifies if type checking
725
+ should be done one the data sent to the server.
726
+ Default is True.
727
+ _check_return_type (bool): specifies if type checking
728
+ should be done one the data received from the server.
729
+ Default is True.
730
+ _spec_property_naming (bool): True if the variable names in the input data
731
+ are serialized names, as specified in the OpenAPI document.
732
+ False if the variable names in the input data
733
+ are pythonic names, e.g. snake case (default)
734
+ _content_type (str/None): force body content-type.
735
+ Default is None and content-type will be predicted by allowed
736
+ content-types and body.
737
+ _host_index (int/None): specifies the index of the server
738
+ that we want to use.
739
+ Default is read from the configuration.
740
+ Returns:
741
+ file_type
742
+ Response Object
743
+ int
744
+ Http Status Code
745
+ dict
746
+ Dictionary of the response headers
747
+ """
748
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
749
+ kwargs['id'] = \
750
+ id
751
+ return self.analytics_quant_fpe_v1_calculations_id_output_get_endpoint.call_with_http_info(**kwargs)
752
+
753
+ def analytics_quant_fpe_v1_calculations_id_output_get_async(
754
+ self,
755
+ id,
756
+ **kwargs
757
+ ) -> "ApplyResult[file_type]":
758
+ """Get calculation output for a specific calculation # noqa: E501
759
+
760
+ This endpoint returns the specified output from the calculation. # noqa: E501
761
+ This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
762
+
763
+ Args:
764
+ id (str): From url, provided by location header or response body in the calculation start endpoint
765
+
766
+ Keyword Args:
767
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
768
+ will be returned without reading/decoding response data.
769
+ Default is True.
770
+ _request_timeout (int/float/tuple): timeout setting for this request. If
771
+ one number provided, it will be total request timeout. It can also
772
+ be a pair (tuple) of (connection, read) timeouts.
773
+ Default is None.
774
+ _check_input_type (bool): specifies if type checking
775
+ should be done one the data sent to the server.
776
+ Default is True.
777
+ _check_return_type (bool): specifies if type checking
778
+ should be done one the data received from the server.
779
+ Default is True.
780
+ _spec_property_naming (bool): True if the variable names in the input data
781
+ are serialized names, as specified in the OpenAPI document.
782
+ False if the variable names in the input data
783
+ are pythonic names, e.g. snake case (default)
784
+ _content_type (str/None): force body content-type.
785
+ Default is None and content-type will be predicted by allowed
786
+ content-types and body.
787
+ _host_index (int/None): specifies the index of the server
788
+ that we want to use.
789
+ Default is read from the configuration.
790
+ Returns:
791
+ ApplyResult[file_type]
792
+ """
793
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
794
+ kwargs['id'] = \
795
+ id
796
+ return self.analytics_quant_fpe_v1_calculations_id_output_get_endpoint.call_with_http_info(**kwargs)
797
+
798
+ def analytics_quant_fpe_v1_calculations_id_output_get_with_http_info_async(
799
+ self,
800
+ id,
801
+ **kwargs
802
+ ) -> "ApplyResult[typing.Tuple[file_type, int, typing.MutableMapping]]":
803
+ """Get calculation output for a specific calculation # noqa: E501
804
+
805
+ This endpoint returns the specified output from the calculation. # noqa: E501
806
+ This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
807
+
808
+ Args:
809
+ id (str): From url, provided by location header or response body in the calculation start endpoint
810
+
811
+ Keyword Args:
812
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
813
+ will be returned without reading/decoding response data.
814
+ Default is True.
815
+ _request_timeout (int/float/tuple): timeout setting for this request. If
816
+ one number provided, it will be total request timeout. It can also
817
+ be a pair (tuple) of (connection, read) timeouts.
818
+ Default is None.
819
+ _check_input_type (bool): specifies if type checking
820
+ should be done one the data sent to the server.
821
+ Default is True.
822
+ _check_return_type (bool): specifies if type checking
823
+ should be done one the data received from the server.
824
+ Default is True.
825
+ _spec_property_naming (bool): True if the variable names in the input data
826
+ are serialized names, as specified in the OpenAPI document.
827
+ False if the variable names in the input data
828
+ are pythonic names, e.g. snake case (default)
829
+ _content_type (str/None): force body content-type.
830
+ Default is None and content-type will be predicted by allowed
831
+ content-types and body.
832
+ _host_index (int/None): specifies the index of the server
833
+ that we want to use.
834
+ Default is read from the configuration.
835
+ Returns:
836
+ ApplyResult[(file_type, int, typing.Dict)]
837
+ """
838
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
839
+ kwargs['id'] = \
840
+ id
841
+ return self.analytics_quant_fpe_v1_calculations_id_output_get_endpoint.call_with_http_info(**kwargs)
842
+
843
+
844
+ def analytics_quant_fpe_v1_calculations_post(
845
+ self,
846
+ **kwargs
847
+ ) -> CalculationStatus:
848
+ """Starts a new script calculation # noqa: E501
849
+
850
+ This endpoint takes a python script and starts executing it within FPE # noqa: E501
851
+ This method makes a synchronous HTTP request. Returns the http data only
852
+
853
+
854
+ Keyword Args:
855
+ calculation (Calculation): [optional]
856
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
857
+ will be returned without reading/decoding response data.
858
+ Default is True.
859
+ _request_timeout (int/float/tuple): timeout setting for this request. If
860
+ one number provided, it will be total request timeout. It can also
861
+ be a pair (tuple) of (connection, read) timeouts.
862
+ Default is None.
863
+ _check_input_type (bool): specifies if type checking
864
+ should be done one the data sent to the server.
865
+ Default is True.
866
+ _check_return_type (bool): specifies if type checking
867
+ should be done one the data received from the server.
868
+ Default is True.
869
+ _spec_property_naming (bool): True if the variable names in the input data
870
+ are serialized names, as specified in the OpenAPI document.
871
+ False if the variable names in the input data
872
+ are pythonic names, e.g. snake case (default)
873
+ _content_type (str/None): force body content-type.
874
+ Default is None and content-type will be predicted by allowed
875
+ content-types and body.
876
+ _host_index (int/None): specifies the index of the server
877
+ that we want to use.
878
+ Default is read from the configuration.
879
+ Returns:
880
+ CalculationStatus
881
+ Response Object
882
+ """
883
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
884
+ return self.analytics_quant_fpe_v1_calculations_post_endpoint.call_with_http_info(**kwargs)
885
+
886
+ def analytics_quant_fpe_v1_calculations_post_with_http_info(
887
+ self,
888
+ **kwargs
889
+ ) -> typing.Tuple[CalculationStatus, int, typing.MutableMapping]:
890
+ """Starts a new script calculation # noqa: E501
891
+
892
+ This endpoint takes a python script and starts executing it within FPE # noqa: E501
893
+ This method makes a synchronous HTTP request. Returns http data, http status and headers
894
+
895
+
896
+ Keyword Args:
897
+ calculation (Calculation): [optional]
898
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
899
+ will be returned without reading/decoding response data.
900
+ Default is True.
901
+ _request_timeout (int/float/tuple): timeout setting for this request. If
902
+ one number provided, it will be total request timeout. It can also
903
+ be a pair (tuple) of (connection, read) timeouts.
904
+ Default is None.
905
+ _check_input_type (bool): specifies if type checking
906
+ should be done one the data sent to the server.
907
+ Default is True.
908
+ _check_return_type (bool): specifies if type checking
909
+ should be done one the data received from the server.
910
+ Default is True.
911
+ _spec_property_naming (bool): True if the variable names in the input data
912
+ are serialized names, as specified in the OpenAPI document.
913
+ False if the variable names in the input data
914
+ are pythonic names, e.g. snake case (default)
915
+ _content_type (str/None): force body content-type.
916
+ Default is None and content-type will be predicted by allowed
917
+ content-types and body.
918
+ _host_index (int/None): specifies the index of the server
919
+ that we want to use.
920
+ Default is read from the configuration.
921
+ Returns:
922
+ CalculationStatus
923
+ Response Object
924
+ int
925
+ Http Status Code
926
+ dict
927
+ Dictionary of the response headers
928
+ """
929
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
930
+ return self.analytics_quant_fpe_v1_calculations_post_endpoint.call_with_http_info(**kwargs)
931
+
932
+ def analytics_quant_fpe_v1_calculations_post_async(
933
+ self,
934
+ **kwargs
935
+ ) -> "ApplyResult[CalculationStatus]":
936
+ """Starts a new script calculation # noqa: E501
937
+
938
+ This endpoint takes a python script and starts executing it within FPE # noqa: E501
939
+ This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
940
+
941
+
942
+ Keyword Args:
943
+ calculation (Calculation): [optional]
944
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
945
+ will be returned without reading/decoding response data.
946
+ Default is True.
947
+ _request_timeout (int/float/tuple): timeout setting for this request. If
948
+ one number provided, it will be total request timeout. It can also
949
+ be a pair (tuple) of (connection, read) timeouts.
950
+ Default is None.
951
+ _check_input_type (bool): specifies if type checking
952
+ should be done one the data sent to the server.
953
+ Default is True.
954
+ _check_return_type (bool): specifies if type checking
955
+ should be done one the data received from the server.
956
+ Default is True.
957
+ _spec_property_naming (bool): True if the variable names in the input data
958
+ are serialized names, as specified in the OpenAPI document.
959
+ False if the variable names in the input data
960
+ are pythonic names, e.g. snake case (default)
961
+ _content_type (str/None): force body content-type.
962
+ Default is None and content-type will be predicted by allowed
963
+ content-types and body.
964
+ _host_index (int/None): specifies the index of the server
965
+ that we want to use.
966
+ Default is read from the configuration.
967
+ Returns:
968
+ ApplyResult[CalculationStatus]
969
+ """
970
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
971
+ return self.analytics_quant_fpe_v1_calculations_post_endpoint.call_with_http_info(**kwargs)
972
+
973
+ def analytics_quant_fpe_v1_calculations_post_with_http_info_async(
974
+ self,
975
+ **kwargs
976
+ ) -> "ApplyResult[typing.Tuple[CalculationStatus, int, typing.MutableMapping]]":
977
+ """Starts a new script calculation # noqa: E501
978
+
979
+ This endpoint takes a python script and starts executing it within FPE # noqa: E501
980
+ This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
981
+
982
+
983
+ Keyword Args:
984
+ calculation (Calculation): [optional]
985
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
986
+ will be returned without reading/decoding response data.
987
+ Default is True.
988
+ _request_timeout (int/float/tuple): timeout setting for this request. If
989
+ one number provided, it will be total request timeout. It can also
990
+ be a pair (tuple) of (connection, read) timeouts.
991
+ Default is None.
992
+ _check_input_type (bool): specifies if type checking
993
+ should be done one the data sent to the server.
994
+ Default is True.
995
+ _check_return_type (bool): specifies if type checking
996
+ should be done one the data received from the server.
997
+ Default is True.
998
+ _spec_property_naming (bool): True if the variable names in the input data
999
+ are serialized names, as specified in the OpenAPI document.
1000
+ False if the variable names in the input data
1001
+ are pythonic names, e.g. snake case (default)
1002
+ _content_type (str/None): force body content-type.
1003
+ Default is None and content-type will be predicted by allowed
1004
+ content-types and body.
1005
+ _host_index (int/None): specifies the index of the server
1006
+ that we want to use.
1007
+ Default is read from the configuration.
1008
+ Returns:
1009
+ ApplyResult[(CalculationStatus, int, typing.Dict)]
1010
+ """
1011
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
1012
+ return self.analytics_quant_fpe_v1_calculations_post_endpoint.call_with_http_info(**kwargs)
1013
+
1014
+