fds.sdk.SPAREngine 2.1.0__tar.gz → 2.2.0__tar.gz
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.
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/PKG-INFO +12 -8
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/README.md +11 -7
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/__init__.py +2 -2
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/api/accounts_api.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/api/benchmarks_api.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/api/components_api.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/api/currencies_api.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/api/documents_api.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/api/frequencies_api.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/api/spar_calculations_api.py +1 -1
- fds_sdk_sparengine-2.2.0/fds/sdk/SPAREngine/api/spar_peer_universe_api.py +325 -0
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/api_client.py +2 -2
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/apis/__init__.py +1 -0
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/configuration.py +3 -3
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/exceptions.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/account_directories.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/account_directories_root.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/calculation_meta.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/calculation_status.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/calculation_status_meta.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/calculation_status_root.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/calculation_unit_status.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/calculation_unit_status_meta.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/calculations_summary.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/calculations_summary_root.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/client_error_response.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/component_summary.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/component_summary_root.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/currency.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/currency_root.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/document_directories.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/document_directories_root.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/error.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/error_source.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/frequency.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/frequency_root.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/object_root.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/pagination_info.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/pagination_meta.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/return_type.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/spar_accounts.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/spar_accounts_root.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/spar_benchmark.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/spar_benchmark_root.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/spar_calculation_parameters.py +3 -3
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/spar_calculation_parameters_root.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/spar_component.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/spar_component_identifier.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/spar_component_root.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/spar_date_parameters.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/spar_identifier.py +1 -1
- fds_sdk_sparengine-2.2.0/fds/sdk/SPAREngine/model/spar_peer_universe_list_response.py +262 -0
- fds_sdk_sparengine-2.2.0/fds/sdk/SPAREngine/model/spar_peer_universe_response_item.py +276 -0
- fds_sdk_sparengine-2.2.0/fds/sdk/SPAREngine/model/spar_peer_universe_root.py +268 -0
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model_utils.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/models/__init__.py +3 -0
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/rest.py +1 -1
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds.sdk.SPAREngine.egg-info/PKG-INFO +12 -8
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds.sdk.SPAREngine.egg-info/SOURCES.txt +4 -0
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/setup.py +2 -2
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/LICENSE +0 -0
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/__init__.py +0 -0
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/api/__init__.py +0 -0
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/SPAREngine/model/__init__.py +0 -0
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds/sdk/__init__.py +0 -0
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds.sdk.SPAREngine.egg-info/dependency_links.txt +0 -0
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds.sdk.SPAREngine.egg-info/requires.txt +0 -0
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/fds.sdk.SPAREngine.egg-info/top_level.txt +0 -0
- {fds_sdk_sparengine-2.1.0 → fds_sdk_sparengine-2.2.0}/setup.cfg +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: fds.sdk.SPAREngine
|
|
3
|
-
Version: 2.
|
|
3
|
+
Version: 2.2.0
|
|
4
4
|
Summary: Style Performance and Risk Analysis (SPAR) Engine client library for Python
|
|
5
5
|
Home-page: https://github.com/FactSet/enterprise-sdk/tree/main/code/python/SPAREngine/v3
|
|
6
6
|
Author: FactSet Research Systems
|
|
@@ -27,16 +27,16 @@ Dynamic: summary
|
|
|
27
27
|
|
|
28
28
|
# Style Performance and Risk Analysis (SPAR) Engine client library for Python
|
|
29
29
|
|
|
30
|
-
[](https://developer.factset.com/api-catalog/spar-engine-api)
|
|
31
|
+
[](https://pypi.org/project/fds.sdk.SPAREngine/v/2.2.0)
|
|
32
32
|
[](https://www.apache.org/licenses/LICENSE-2.0)
|
|
33
33
|
|
|
34
34
|
Allow clients to fetch Analytics through APIs.
|
|
35
35
|
|
|
36
36
|
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
37
37
|
|
|
38
|
-
- API version: 3.
|
|
39
|
-
- SDK version: 2.
|
|
38
|
+
- API version: 3.16.2
|
|
39
|
+
- SDK version: 2.2.0
|
|
40
40
|
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
41
41
|
|
|
42
42
|
For more information, please visit [https://developer.factset.com/contact](https://developer.factset.com/contact)
|
|
@@ -50,13 +50,13 @@ For more information, please visit [https://developer.factset.com/contact](https
|
|
|
50
50
|
### Poetry
|
|
51
51
|
|
|
52
52
|
```shell
|
|
53
|
-
poetry add fds.sdk.utils fds.protobuf.stach.extensions fds.sdk.SPAREngine==2.
|
|
53
|
+
poetry add fds.sdk.utils fds.protobuf.stach.extensions fds.sdk.SPAREngine==2.2.0
|
|
54
54
|
```
|
|
55
55
|
|
|
56
56
|
### pip
|
|
57
57
|
|
|
58
58
|
```shell
|
|
59
|
-
pip install fds.sdk.utils fds.protobuf.stach.extensions fds.sdk.SPAREngine==2.
|
|
59
|
+
pip install fds.sdk.utils fds.protobuf.stach.extensions fds.sdk.SPAREngine==2.2.0
|
|
60
60
|
```
|
|
61
61
|
|
|
62
62
|
## Usage
|
|
@@ -276,6 +276,7 @@ Class | Method | HTTP request | Description
|
|
|
276
276
|
*SPARCalculationsApi* | [**get_calculation_unit_result_by_id**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/SPAREngine/v3/docs/SPARCalculationsApi.md#get_calculation_unit_result_by_id) | **GET** /analytics/engines/spar/v3/calculations/{id}/units/{unitId}/result | Get SPAR calculation result by id
|
|
277
277
|
*SPARCalculationsApi* | [**post_and_calculate**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/SPAREngine/v3/docs/SPARCalculationsApi.md#post_and_calculate) | **POST** /analytics/engines/spar/v3/calculations | Create and Run SPAR calculation
|
|
278
278
|
*SPARCalculationsApi* | [**put_and_calculate**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/SPAREngine/v3/docs/SPARCalculationsApi.md#put_and_calculate) | **PUT** /analytics/engines/spar/v3/calculations/{id} | Create or Update SPAR calculation and run it.
|
|
279
|
+
*SPARPeerUniverseApi* | [**get_list_of_peer_universe**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/SPAREngine/v3/docs/SPARPeerUniverseApi.md#get_list_of_peer_universe) | **GET** /analytics/engines/spar/v3/peer-universe | Get List of Peer Universe
|
|
279
280
|
|
|
280
281
|
|
|
281
282
|
## Documentation For Models
|
|
@@ -316,6 +317,9 @@ Class | Method | HTTP request | Description
|
|
|
316
317
|
- [SPARComponentRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/SPAREngine/v3/docs/SPARComponentRoot.md)
|
|
317
318
|
- [SPARDateParameters](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/SPAREngine/v3/docs/SPARDateParameters.md)
|
|
318
319
|
- [SPARIdentifier](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/SPAREngine/v3/docs/SPARIdentifier.md)
|
|
320
|
+
- [SPARPeerUniverseListResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/SPAREngine/v3/docs/SPARPeerUniverseListResponse.md)
|
|
321
|
+
- [SPARPeerUniverseResponseItem](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/SPAREngine/v3/docs/SPARPeerUniverseResponseItem.md)
|
|
322
|
+
- [SPARPeerUniverseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/SPAREngine/v3/docs/SPARPeerUniverseRoot.md)
|
|
319
323
|
|
|
320
324
|
|
|
321
325
|
## Documentation For Authorization
|
|
@@ -359,7 +363,7 @@ Please refer to the [contributing guide](../../../../CONTRIBUTING.md).
|
|
|
359
363
|
|
|
360
364
|
## Copyright
|
|
361
365
|
|
|
362
|
-
Copyright
|
|
366
|
+
Copyright 2026 FactSet Research Systems Inc
|
|
363
367
|
|
|
364
368
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
365
369
|
you may not use this file except in compliance with the License.
|
|
@@ -2,16 +2,16 @@
|
|
|
2
2
|
|
|
3
3
|
# Style Performance and Risk Analysis (SPAR) Engine client library for Python
|
|
4
4
|
|
|
5
|
-
[](https://developer.factset.com/api-catalog/spar-engine-api)
|
|
6
|
+
[](https://pypi.org/project/fds.sdk.SPAREngine/v/2.2.0)
|
|
7
7
|
[](https://www.apache.org/licenses/LICENSE-2.0)
|
|
8
8
|
|
|
9
9
|
Allow clients to fetch Analytics through APIs.
|
|
10
10
|
|
|
11
11
|
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
12
12
|
|
|
13
|
-
- API version: 3.
|
|
14
|
-
- SDK version: 2.
|
|
13
|
+
- API version: 3.16.2
|
|
14
|
+
- SDK version: 2.2.0
|
|
15
15
|
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
16
16
|
|
|
17
17
|
For more information, please visit [https://developer.factset.com/contact](https://developer.factset.com/contact)
|
|
@@ -25,13 +25,13 @@ For more information, please visit [https://developer.factset.com/contact](https
|
|
|
25
25
|
### Poetry
|
|
26
26
|
|
|
27
27
|
```shell
|
|
28
|
-
poetry add fds.sdk.utils fds.protobuf.stach.extensions fds.sdk.SPAREngine==2.
|
|
28
|
+
poetry add fds.sdk.utils fds.protobuf.stach.extensions fds.sdk.SPAREngine==2.2.0
|
|
29
29
|
```
|
|
30
30
|
|
|
31
31
|
### pip
|
|
32
32
|
|
|
33
33
|
```shell
|
|
34
|
-
pip install fds.sdk.utils fds.protobuf.stach.extensions fds.sdk.SPAREngine==2.
|
|
34
|
+
pip install fds.sdk.utils fds.protobuf.stach.extensions fds.sdk.SPAREngine==2.2.0
|
|
35
35
|
```
|
|
36
36
|
|
|
37
37
|
## Usage
|
|
@@ -251,6 +251,7 @@ Class | Method | HTTP request | Description
|
|
|
251
251
|
*SPARCalculationsApi* | [**get_calculation_unit_result_by_id**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/SPAREngine/v3/docs/SPARCalculationsApi.md#get_calculation_unit_result_by_id) | **GET** /analytics/engines/spar/v3/calculations/{id}/units/{unitId}/result | Get SPAR calculation result by id
|
|
252
252
|
*SPARCalculationsApi* | [**post_and_calculate**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/SPAREngine/v3/docs/SPARCalculationsApi.md#post_and_calculate) | **POST** /analytics/engines/spar/v3/calculations | Create and Run SPAR calculation
|
|
253
253
|
*SPARCalculationsApi* | [**put_and_calculate**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/SPAREngine/v3/docs/SPARCalculationsApi.md#put_and_calculate) | **PUT** /analytics/engines/spar/v3/calculations/{id} | Create or Update SPAR calculation and run it.
|
|
254
|
+
*SPARPeerUniverseApi* | [**get_list_of_peer_universe**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/SPAREngine/v3/docs/SPARPeerUniverseApi.md#get_list_of_peer_universe) | **GET** /analytics/engines/spar/v3/peer-universe | Get List of Peer Universe
|
|
254
255
|
|
|
255
256
|
|
|
256
257
|
## Documentation For Models
|
|
@@ -291,6 +292,9 @@ Class | Method | HTTP request | Description
|
|
|
291
292
|
- [SPARComponentRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/SPAREngine/v3/docs/SPARComponentRoot.md)
|
|
292
293
|
- [SPARDateParameters](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/SPAREngine/v3/docs/SPARDateParameters.md)
|
|
293
294
|
- [SPARIdentifier](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/SPAREngine/v3/docs/SPARIdentifier.md)
|
|
295
|
+
- [SPARPeerUniverseListResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/SPAREngine/v3/docs/SPARPeerUniverseListResponse.md)
|
|
296
|
+
- [SPARPeerUniverseResponseItem](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/SPAREngine/v3/docs/SPARPeerUniverseResponseItem.md)
|
|
297
|
+
- [SPARPeerUniverseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/SPAREngine/v3/docs/SPARPeerUniverseRoot.md)
|
|
294
298
|
|
|
295
299
|
|
|
296
300
|
## Documentation For Authorization
|
|
@@ -334,7 +338,7 @@ Please refer to the [contributing guide](../../../../CONTRIBUTING.md).
|
|
|
334
338
|
|
|
335
339
|
## Copyright
|
|
336
340
|
|
|
337
|
-
Copyright
|
|
341
|
+
Copyright 2026 FactSet Research Systems Inc
|
|
338
342
|
|
|
339
343
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
340
344
|
you may not use this file except in compliance with the License.
|
|
@@ -5,13 +5,13 @@
|
|
|
5
5
|
|
|
6
6
|
Allow clients to fetch Analytics through APIs. # noqa: E501
|
|
7
7
|
|
|
8
|
-
The version of the OpenAPI document: 3.
|
|
8
|
+
The version of the OpenAPI document: 3.16.2
|
|
9
9
|
Contact: api@factset.com
|
|
10
10
|
Generated by: https://openapi-generator.tech
|
|
11
11
|
"""
|
|
12
12
|
|
|
13
13
|
|
|
14
|
-
__version__ = "2.
|
|
14
|
+
__version__ = "2.2.0"
|
|
15
15
|
|
|
16
16
|
# import ApiClient
|
|
17
17
|
from fds.sdk.SPAREngine.api_client import ApiClient
|
|
@@ -0,0 +1,325 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Style Performance and Risk Analysis (SPAR) Engine API
|
|
3
|
+
|
|
4
|
+
Allow clients to fetch Analytics through APIs. # noqa: E501
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 3.16.2
|
|
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.SPAREngine.api_client import ApiClient, Endpoint as _Endpoint
|
|
18
|
+
from fds.sdk.SPAREngine.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.SPAREngine.exceptions import ApiException
|
|
28
|
+
from fds.sdk.SPAREngine.model.client_error_response import ClientErrorResponse
|
|
29
|
+
from fds.sdk.SPAREngine.model.spar_peer_universe_root import SPARPeerUniverseRoot
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
class SPARPeerUniverseApi(object):
|
|
36
|
+
"""NOTE: This class is auto generated by OpenAPI Generator
|
|
37
|
+
Ref: https://openapi-generator.tech
|
|
38
|
+
|
|
39
|
+
Do not edit the class manually.
|
|
40
|
+
"""
|
|
41
|
+
|
|
42
|
+
def __init__(self, api_client=None):
|
|
43
|
+
if api_client is None:
|
|
44
|
+
api_client = ApiClient()
|
|
45
|
+
self.api_client = api_client
|
|
46
|
+
|
|
47
|
+
self.get_list_of_peer_universe_endpoint = _Endpoint(
|
|
48
|
+
settings={
|
|
49
|
+
'response_type': (
|
|
50
|
+
{ 200: (SPARPeerUniverseRoot,), 400: (ClientErrorResponse,), 404: (ClientErrorResponse,), },
|
|
51
|
+
None
|
|
52
|
+
),
|
|
53
|
+
'auth': [
|
|
54
|
+
'FactSetApiKey',
|
|
55
|
+
'FactSetOAuth2'
|
|
56
|
+
],
|
|
57
|
+
'endpoint_path': '/analytics/engines/spar/v3/peer-universe',
|
|
58
|
+
'operation_id': 'get_list_of_peer_universe',
|
|
59
|
+
'http_method': 'GET',
|
|
60
|
+
'servers': None,
|
|
61
|
+
},
|
|
62
|
+
params_map={
|
|
63
|
+
'all': [
|
|
64
|
+
'category',
|
|
65
|
+
'name',
|
|
66
|
+
'directory',
|
|
67
|
+
],
|
|
68
|
+
'required': [
|
|
69
|
+
'category',
|
|
70
|
+
],
|
|
71
|
+
'nullable': [
|
|
72
|
+
],
|
|
73
|
+
'enum': [
|
|
74
|
+
],
|
|
75
|
+
'validation': [
|
|
76
|
+
]
|
|
77
|
+
},
|
|
78
|
+
root_map={
|
|
79
|
+
'validations': {
|
|
80
|
+
},
|
|
81
|
+
'allowed_values': {
|
|
82
|
+
},
|
|
83
|
+
'openapi_types': {
|
|
84
|
+
'category':
|
|
85
|
+
(str,),
|
|
86
|
+
'name':
|
|
87
|
+
(str,),
|
|
88
|
+
'directory':
|
|
89
|
+
(str,),
|
|
90
|
+
},
|
|
91
|
+
'attribute_map': {
|
|
92
|
+
'category': 'category',
|
|
93
|
+
'name': 'name',
|
|
94
|
+
'directory': 'directory',
|
|
95
|
+
},
|
|
96
|
+
'location_map': {
|
|
97
|
+
'category': 'query',
|
|
98
|
+
'name': 'query',
|
|
99
|
+
'directory': 'query',
|
|
100
|
+
},
|
|
101
|
+
'collection_format_map': {
|
|
102
|
+
}
|
|
103
|
+
},
|
|
104
|
+
headers_map={
|
|
105
|
+
'accept': [
|
|
106
|
+
'application/json'
|
|
107
|
+
],
|
|
108
|
+
'content_type': [],
|
|
109
|
+
},
|
|
110
|
+
api_client=api_client
|
|
111
|
+
)
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
@staticmethod
|
|
115
|
+
def apply_kwargs_defaults(kwargs, return_http_data_only, async_req):
|
|
116
|
+
kwargs["async_req"] = async_req
|
|
117
|
+
kwargs["_return_http_data_only"] = return_http_data_only
|
|
118
|
+
kwargs["_preload_content"] = kwargs.get("_preload_content", True)
|
|
119
|
+
kwargs["_request_timeout"] = kwargs.get("_request_timeout", None)
|
|
120
|
+
kwargs["_check_input_type"] = kwargs.get("_check_input_type", True)
|
|
121
|
+
kwargs["_check_return_type"] = kwargs.get("_check_return_type", True)
|
|
122
|
+
kwargs["_spec_property_naming"] = kwargs.get("_spec_property_naming", False)
|
|
123
|
+
kwargs["_content_type"] = kwargs.get("_content_type")
|
|
124
|
+
kwargs["_host_index"] = kwargs.get("_host_index")
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
def get_list_of_peer_universe(
|
|
128
|
+
self,
|
|
129
|
+
category,
|
|
130
|
+
**kwargs
|
|
131
|
+
) -> SPARPeerUniverseRoot:
|
|
132
|
+
"""Get List of Peer Universe # noqa: E501
|
|
133
|
+
|
|
134
|
+
Retrieves peer universe information that can be used when specifying universeId for SPAR calculations. This endpoint returns a list of available universes for different categories. Parameters: Category is mandatory. Usage: * Category parameter: Fetches all peer universe details available for specified category. * Use parameters to narrow down your lookup based on peer universe name, category, and/or directory. Remarks: * Category Values: Allowed values include category name like 'US Funds', 'Asia Funds', 'Intl Funds','Institutions', 'Hedge Funds', 'Database', 'Domicile', 'Manager', 'Rating', 'OFDBs', 'Screens' etc. * Access to specific categories may vary depending on your permissions. * Directory parameter is mandatory when category is 'OFDBs' or 'Screens'. Eg: CLIENT:/FOLDER1. * Note: Category 'Client funds' is not supported yet. # noqa: E501
|
|
135
|
+
This method makes a synchronous HTTP request. Returns the http data only
|
|
136
|
+
|
|
137
|
+
Args:
|
|
138
|
+
category (str): Peer universe category
|
|
139
|
+
|
|
140
|
+
Keyword Args:
|
|
141
|
+
name (str): Peer universe name. [optional]
|
|
142
|
+
directory (str): The directory to get the peer universe. [optional]
|
|
143
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
144
|
+
will be returned without reading/decoding response data.
|
|
145
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
146
|
+
of the caller to close the file stream.
|
|
147
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
148
|
+
one number provided, it will be total request timeout. It can also
|
|
149
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
150
|
+
Default is None.
|
|
151
|
+
_check_input_type (bool): specifies if type checking
|
|
152
|
+
should be done one the data sent to the server.
|
|
153
|
+
Default is True.
|
|
154
|
+
_check_return_type (bool): specifies if type checking
|
|
155
|
+
should be done one the data received from the server.
|
|
156
|
+
Default is True.
|
|
157
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
158
|
+
are serialized names, as specified in the OpenAPI document.
|
|
159
|
+
False if the variable names in the input data
|
|
160
|
+
are pythonic names, e.g. snake case (default)
|
|
161
|
+
_content_type (str/None): force body content-type.
|
|
162
|
+
Default is None and content-type will be predicted by allowed
|
|
163
|
+
content-types and body.
|
|
164
|
+
_host_index (int/None): specifies the index of the server
|
|
165
|
+
that we want to use.
|
|
166
|
+
Default is read from the configuration.
|
|
167
|
+
Returns:
|
|
168
|
+
SPARPeerUniverseRoot
|
|
169
|
+
Response Object
|
|
170
|
+
"""
|
|
171
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
|
|
172
|
+
kwargs['category'] = \
|
|
173
|
+
category
|
|
174
|
+
return self.get_list_of_peer_universe_endpoint.call_with_http_info(**kwargs)
|
|
175
|
+
|
|
176
|
+
def get_list_of_peer_universe_with_http_info(
|
|
177
|
+
self,
|
|
178
|
+
category,
|
|
179
|
+
**kwargs
|
|
180
|
+
) -> typing.Tuple[SPARPeerUniverseRoot, int, typing.MutableMapping]:
|
|
181
|
+
"""Get List of Peer Universe # noqa: E501
|
|
182
|
+
|
|
183
|
+
Retrieves peer universe information that can be used when specifying universeId for SPAR calculations. This endpoint returns a list of available universes for different categories. Parameters: Category is mandatory. Usage: * Category parameter: Fetches all peer universe details available for specified category. * Use parameters to narrow down your lookup based on peer universe name, category, and/or directory. Remarks: * Category Values: Allowed values include category name like 'US Funds', 'Asia Funds', 'Intl Funds','Institutions', 'Hedge Funds', 'Database', 'Domicile', 'Manager', 'Rating', 'OFDBs', 'Screens' etc. * Access to specific categories may vary depending on your permissions. * Directory parameter is mandatory when category is 'OFDBs' or 'Screens'. Eg: CLIENT:/FOLDER1. * Note: Category 'Client funds' is not supported yet. # noqa: E501
|
|
184
|
+
This method makes a synchronous HTTP request. Returns http data, http status and headers
|
|
185
|
+
|
|
186
|
+
Args:
|
|
187
|
+
category (str): Peer universe category
|
|
188
|
+
|
|
189
|
+
Keyword Args:
|
|
190
|
+
name (str): Peer universe name. [optional]
|
|
191
|
+
directory (str): The directory to get the peer universe. [optional]
|
|
192
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
193
|
+
will be returned without reading/decoding response data.
|
|
194
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
195
|
+
of the caller to close the file stream.
|
|
196
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
197
|
+
one number provided, it will be total request timeout. It can also
|
|
198
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
199
|
+
Default is None.
|
|
200
|
+
_check_input_type (bool): specifies if type checking
|
|
201
|
+
should be done one the data sent to the server.
|
|
202
|
+
Default is True.
|
|
203
|
+
_check_return_type (bool): specifies if type checking
|
|
204
|
+
should be done one the data received from the server.
|
|
205
|
+
Default is True.
|
|
206
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
207
|
+
are serialized names, as specified in the OpenAPI document.
|
|
208
|
+
False if the variable names in the input data
|
|
209
|
+
are pythonic names, e.g. snake case (default)
|
|
210
|
+
_content_type (str/None): force body content-type.
|
|
211
|
+
Default is None and content-type will be predicted by allowed
|
|
212
|
+
content-types and body.
|
|
213
|
+
_host_index (int/None): specifies the index of the server
|
|
214
|
+
that we want to use.
|
|
215
|
+
Default is read from the configuration.
|
|
216
|
+
Returns:
|
|
217
|
+
SPARPeerUniverseRoot
|
|
218
|
+
Response Object
|
|
219
|
+
int
|
|
220
|
+
Http Status Code
|
|
221
|
+
dict
|
|
222
|
+
Dictionary of the response headers
|
|
223
|
+
"""
|
|
224
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
|
|
225
|
+
kwargs['category'] = \
|
|
226
|
+
category
|
|
227
|
+
return self.get_list_of_peer_universe_endpoint.call_with_http_info(**kwargs)
|
|
228
|
+
|
|
229
|
+
def get_list_of_peer_universe_async(
|
|
230
|
+
self,
|
|
231
|
+
category,
|
|
232
|
+
**kwargs
|
|
233
|
+
) -> "ApplyResult[SPARPeerUniverseRoot]":
|
|
234
|
+
"""Get List of Peer Universe # noqa: E501
|
|
235
|
+
|
|
236
|
+
Retrieves peer universe information that can be used when specifying universeId for SPAR calculations. This endpoint returns a list of available universes for different categories. Parameters: Category is mandatory. Usage: * Category parameter: Fetches all peer universe details available for specified category. * Use parameters to narrow down your lookup based on peer universe name, category, and/or directory. Remarks: * Category Values: Allowed values include category name like 'US Funds', 'Asia Funds', 'Intl Funds','Institutions', 'Hedge Funds', 'Database', 'Domicile', 'Manager', 'Rating', 'OFDBs', 'Screens' etc. * Access to specific categories may vary depending on your permissions. * Directory parameter is mandatory when category is 'OFDBs' or 'Screens'. Eg: CLIENT:/FOLDER1. * Note: Category 'Client funds' is not supported yet. # noqa: E501
|
|
237
|
+
This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
|
|
238
|
+
|
|
239
|
+
Args:
|
|
240
|
+
category (str): Peer universe category
|
|
241
|
+
|
|
242
|
+
Keyword Args:
|
|
243
|
+
name (str): Peer universe name. [optional]
|
|
244
|
+
directory (str): The directory to get the peer universe. [optional]
|
|
245
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
246
|
+
will be returned without reading/decoding response data.
|
|
247
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
248
|
+
of the caller to close the file stream.
|
|
249
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
250
|
+
one number provided, it will be total request timeout. It can also
|
|
251
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
252
|
+
Default is None.
|
|
253
|
+
_check_input_type (bool): specifies if type checking
|
|
254
|
+
should be done one the data sent to the server.
|
|
255
|
+
Default is True.
|
|
256
|
+
_check_return_type (bool): specifies if type checking
|
|
257
|
+
should be done one the data received from the server.
|
|
258
|
+
Default is True.
|
|
259
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
260
|
+
are serialized names, as specified in the OpenAPI document.
|
|
261
|
+
False if the variable names in the input data
|
|
262
|
+
are pythonic names, e.g. snake case (default)
|
|
263
|
+
_content_type (str/None): force body content-type.
|
|
264
|
+
Default is None and content-type will be predicted by allowed
|
|
265
|
+
content-types and body.
|
|
266
|
+
_host_index (int/None): specifies the index of the server
|
|
267
|
+
that we want to use.
|
|
268
|
+
Default is read from the configuration.
|
|
269
|
+
Returns:
|
|
270
|
+
ApplyResult[SPARPeerUniverseRoot]
|
|
271
|
+
"""
|
|
272
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
|
|
273
|
+
kwargs['category'] = \
|
|
274
|
+
category
|
|
275
|
+
return self.get_list_of_peer_universe_endpoint.call_with_http_info(**kwargs)
|
|
276
|
+
|
|
277
|
+
def get_list_of_peer_universe_with_http_info_async(
|
|
278
|
+
self,
|
|
279
|
+
category,
|
|
280
|
+
**kwargs
|
|
281
|
+
) -> "ApplyResult[typing.Tuple[SPARPeerUniverseRoot, int, typing.MutableMapping]]":
|
|
282
|
+
"""Get List of Peer Universe # noqa: E501
|
|
283
|
+
|
|
284
|
+
Retrieves peer universe information that can be used when specifying universeId for SPAR calculations. This endpoint returns a list of available universes for different categories. Parameters: Category is mandatory. Usage: * Category parameter: Fetches all peer universe details available for specified category. * Use parameters to narrow down your lookup based on peer universe name, category, and/or directory. Remarks: * Category Values: Allowed values include category name like 'US Funds', 'Asia Funds', 'Intl Funds','Institutions', 'Hedge Funds', 'Database', 'Domicile', 'Manager', 'Rating', 'OFDBs', 'Screens' etc. * Access to specific categories may vary depending on your permissions. * Directory parameter is mandatory when category is 'OFDBs' or 'Screens'. Eg: CLIENT:/FOLDER1. * Note: Category 'Client funds' is not supported yet. # noqa: E501
|
|
285
|
+
This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
|
|
286
|
+
|
|
287
|
+
Args:
|
|
288
|
+
category (str): Peer universe category
|
|
289
|
+
|
|
290
|
+
Keyword Args:
|
|
291
|
+
name (str): Peer universe name. [optional]
|
|
292
|
+
directory (str): The directory to get the peer universe. [optional]
|
|
293
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
294
|
+
will be returned without reading/decoding response data.
|
|
295
|
+
Default is True. NOTE: if this API returns a file, it is the responsibility
|
|
296
|
+
of the caller to close the file stream.
|
|
297
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
298
|
+
one number provided, it will be total request timeout. It can also
|
|
299
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
300
|
+
Default is None.
|
|
301
|
+
_check_input_type (bool): specifies if type checking
|
|
302
|
+
should be done one the data sent to the server.
|
|
303
|
+
Default is True.
|
|
304
|
+
_check_return_type (bool): specifies if type checking
|
|
305
|
+
should be done one the data received from the server.
|
|
306
|
+
Default is True.
|
|
307
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
308
|
+
are serialized names, as specified in the OpenAPI document.
|
|
309
|
+
False if the variable names in the input data
|
|
310
|
+
are pythonic names, e.g. snake case (default)
|
|
311
|
+
_content_type (str/None): force body content-type.
|
|
312
|
+
Default is None and content-type will be predicted by allowed
|
|
313
|
+
content-types and body.
|
|
314
|
+
_host_index (int/None): specifies the index of the server
|
|
315
|
+
that we want to use.
|
|
316
|
+
Default is read from the configuration.
|
|
317
|
+
Returns:
|
|
318
|
+
ApplyResult[(SPARPeerUniverseRoot, int, typing.Dict)]
|
|
319
|
+
"""
|
|
320
|
+
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
|
|
321
|
+
kwargs['category'] = \
|
|
322
|
+
category
|
|
323
|
+
return self.get_list_of_peer_universe_endpoint.call_with_http_info(**kwargs)
|
|
324
|
+
|
|
325
|
+
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
Allow clients to fetch Analytics through APIs. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 3.
|
|
6
|
+
The version of the OpenAPI document: 3.16.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -116,7 +116,7 @@ class ApiClient(object):
|
|
|
116
116
|
self.default_headers[header_name] = header_value
|
|
117
117
|
self.cookie = cookie
|
|
118
118
|
# Set default User-Agent.
|
|
119
|
-
self.user_agent = f'fds-sdk/python/SPAREngine/2.
|
|
119
|
+
self.user_agent = f'fds-sdk/python/SPAREngine/2.2.0 ({platform.system()}, Python {platform.python_version()})'
|
|
120
120
|
|
|
121
121
|
def __enter__(self):
|
|
122
122
|
return self
|
|
@@ -21,3 +21,4 @@ from fds.sdk.SPAREngine.api.currencies_api import CurrenciesApi
|
|
|
21
21
|
from fds.sdk.SPAREngine.api.documents_api import DocumentsApi
|
|
22
22
|
from fds.sdk.SPAREngine.api.frequencies_api import FrequenciesApi
|
|
23
23
|
from fds.sdk.SPAREngine.api.spar_calculations_api import SPARCalculationsApi
|
|
24
|
+
from fds.sdk.SPAREngine.api.spar_peer_universe_api import SPARPeerUniverseApi
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
Allow clients to fetch Analytics through APIs. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 3.
|
|
6
|
+
The version of the OpenAPI document: 3.16.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -429,8 +429,8 @@ conf = fds.sdk.SPAREngine.Configuration(
|
|
|
429
429
|
return "Python SDK Debug Report:\n"\
|
|
430
430
|
"OS: {env}\n"\
|
|
431
431
|
"Python Version: {pyversion}\n"\
|
|
432
|
-
"Version of the API: 3.
|
|
433
|
-
"SDK Package Version: 2.
|
|
432
|
+
"Version of the API: 3.16.2\n"\
|
|
433
|
+
"SDK Package Version: 2.2.0".\
|
|
434
434
|
format(env=sys.platform, pyversion=sys.version)
|
|
435
435
|
|
|
436
436
|
def get_host_settings(self):
|