Skip to content

Commit 6b479c0

Browse files
factset-sdk-botfactset-sdk-bot
authored
feat(sdk): Auto-created from 'analyticsapi-engines-sdk-generator' repository PR 56 for SDK version v5.7.0 (#106)
upgraded to major version 6.0.0
1 parent b6af850 commit 6b479c0

File tree

116 files changed

+1554
-294
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

116 files changed

+1554
-294
lines changed

‎CHANGELOG.md‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,98 @@
1+
6.0.0 (25/03/2024)
2+
3+
Supported API versions:
4+
* v3: [pa,spar,vault,pub,fi,axp,fpo,afi,npo,bpm,quant],v1:[fiab]
5+
6+
Summmary:
7+
* Supporting new functionalities in pa,spar,vault,pub,quant and fi.
8+
9+
Functionality Additions:
10+
* New Parameters are added in the FI Request.
11+
* 413 status code is added to Quant Response.
12+
* 'Warnings' are added as an enhancement to quant unit status response object.
13+
* Added code and title as two new fields in the Error Response object.
14+
* Added new Get Component details by Id endpoint for SPAR.
15+
16+
Breaking changes:
17+
* Removed default values when the parameter field is required for lookup end points for pa,spar,vault and strategy document end points for optimizers.
18+
* Updated the response schema for GetAllCalculations End Point for pa,spar,vault,pub and quant.
19+
20+
Bug Fixes:
21+
* Removed requiredfield attribute for pagenumber field parameter in GetAllCalculations End Point for pa,spar,vault,pub and quant.
22+
23+
-----------------------
24+
25+
5.4.0 (06/27/2022)
26+
27+
Supported API versions:
28+
* v3: [pa,spar,vault,pub,fi,axp,fpo,afi,npo,bpm,quant]
29+
30+
Summary:
31+
* Supporting new functionalities in FI and Quant.
32+
33+
Functionality Additions:
34+
* Added new property "IsArrayReturnType" for FQL expression in Quant Request
35+
* Added new property "Structured Products" in FI Request
36+
37+
Bug Fixes:
38+
* NA
39+
40+
-----------------------
41+
42+
5.4.0 (06/27/2022)
43+
44+
Supported API versions:
45+
* v3: [pa,spar,vault,pub,fi,axp,fpo,afi,npo,bpm,quant]
46+
47+
Summary:
48+
* Supporting new functionalities in pa,spar,vault,pub,quant
49+
50+
Functionality Additions:
51+
* Supporting new features/functionalities of the FI API.
52+
* Added new end point for GroupingFrequencies
53+
* Added new endpoint for Pricing Sources.
54+
55+
Bug Fixes:
56+
* NA
57+
58+
-----------------------
59+
60+
5.4.0 (03/22/2022)
61+
62+
Supported API versions:
63+
v3: [pa,spar,vault,pub,fi,axp,fpo,afi,npo,bpm,quant],v1:[fiab]
64+
65+
Summary:
66+
* Added support for MarketEnviornment in the FI calculation parameters.
67+
* Added FI Discount curves endpoint.
68+
* Added support for `override_universal_screen_calendar` for Quant Dates.
69+
70+
-----------------------
71+
72+
5.3.0 (11/30/2021)
73+
74+
Supported API versions:
75+
v3: [pa,spar,vault,pub,fi,axp,fpo,afi,npo,bpm,quant],v1:[fiab]
76+
77+
Summary:
78+
* Added new methods for getting components in TemplatedPAComponentsAPI
79+
* Added support for new parameters for FI inputs.
80+
* Bug fixes for FPO API
81+
* Bug fixes for component manager API.
82+
83+
-----------------------
84+
85+
5.2.0 (09/14/2021)
86+
87+
Supported API versions:
88+
v3: [pa,spar,vault,pub,fi,axp,fpo,afi,npo,bpm,quant],v1:[fiab]
89+
90+
Summary:
91+
* Support for PA Component Manager API endpoints
92+
* Support new fields in QuantCalculationParameters and deprecate old fields.
93+
94+
-----------------------
95+
196
5.1.0 (07/20/2021)
297

398
Supported API versions:

‎auto-generated-sdk/.openapi-generator/FILES‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ docs/FIABCalculationStatusSummary.md
6868
docs/FIABCalculationsApi.md
6969
docs/FIABDateParameters.md
7070
docs/FIABIdentifier.md
71+
docs/FIAttributionForJobSettings.md
72+
docs/FIAttributionForSecurities.md
7173
docs/FIBalloonExtension.md
7274
docs/FIBankLoans.md
7375
docs/FICalculationParameters.md
@@ -182,6 +184,8 @@ docs/SPARBenchmarkRoot.md
182184
docs/SPARCalculationParameters.md
183185
docs/SPARCalculationParametersRoot.md
184186
docs/SPARCalculationsApi.md
187+
docs/SPARComponent.md
188+
docs/SPARComponentRoot.md
185189
docs/SPARDateParameters.md
186190
docs/SPARIdentifier.md
187191
docs/StrategyDocumentsApi.md
@@ -309,6 +313,8 @@ fds/analyticsapi/engines/model/document_directories_root.py
309313
fds/analyticsapi/engines/model/error.py
310314
fds/analyticsapi/engines/model/error_source.py
311315
fds/analyticsapi/engines/model/event_summary.py
316+
fds/analyticsapi/engines/model/fi_attribution_for_job_settings.py
317+
fds/analyticsapi/engines/model/fi_attribution_for_securities.py
312318
fds/analyticsapi/engines/model/fi_balloon_extension.py
313319
fds/analyticsapi/engines/model/fi_bank_loans.py
314320
fds/analyticsapi/engines/model/fi_calculation_parameters.py
@@ -417,6 +423,8 @@ fds/analyticsapi/engines/model/spar_benchmark.py
417423
fds/analyticsapi/engines/model/spar_benchmark_root.py
418424
fds/analyticsapi/engines/model/spar_calculation_parameters.py
419425
fds/analyticsapi/engines/model/spar_calculation_parameters_root.py
426+
fds/analyticsapi/engines/model/spar_component.py
427+
fds/analyticsapi/engines/model/spar_component_root.py
420428
fds/analyticsapi/engines/model/spar_date_parameters.py
421429
fds/analyticsapi/engines/model/spar_identifier.py
422430
fds/analyticsapi/engines/model/template_content_types.py

‎auto-generated-sdk/README.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Allow clients to fetch Analytics through APIs.
44
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
55

66
- API version: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab]
7-
- Package version: 5.6.0
7+
- Package version: 6.0.0
88
- Build package: CustomPythonClientCodegen
99
For more information, please visit [https://developer.factset.com/contact](https://developer.factset.com/contact)
1010

@@ -123,6 +123,7 @@ Class | Method | HTTP request | Description
123123
*ColumnsApi* | [**get_pa_columns**](docs/ColumnsApi.md#get_pa_columns) | **GET** /analytics/engines/pa/v3/columns | Get PA columns
124124
*ComponentsApi* | [**get_pa_component_by_id**](docs/ComponentsApi.md#get_pa_component_by_id) | **GET** /analytics/engines/pa/v3/components/{id} | Get PA component by id
125125
*ComponentsApi* | [**get_pa_components**](docs/ComponentsApi.md#get_pa_components) | **GET** /analytics/engines/pa/v3/components | Get PA components
126+
*ComponentsApi* | [**get_spar_component_by_id**](docs/ComponentsApi.md#get_spar_component_by_id) | **GET** /analytics/engines/spar/v3/components/{id} | Get SPAR component by id
126127
*ComponentsApi* | [**get_spar_components**](docs/ComponentsApi.md#get_spar_components) | **GET** /analytics/engines/spar/v3/components | Get SPAR components
127128
*ComponentsApi* | [**get_vault_component_by_id**](docs/ComponentsApi.md#get_vault_component_by_id) | **GET** /analytics/engines/vault/v3/components/{id} | Get Vault component by id
128129
*ComponentsApi* | [**get_vault_components**](docs/ComponentsApi.md#get_vault_components) | **GET** /analytics/engines/vault/v3/components | Get Vault components
@@ -276,6 +277,8 @@ Class | Method | HTTP request | Description
276277
- [FIABCalculationStatusSummary](docs/FIABCalculationStatusSummary.md)
277278
- [FIABDateParameters](docs/FIABDateParameters.md)
278279
- [FIABIdentifier](docs/FIABIdentifier.md)
280+
- [FIAttributionForJobSettings](docs/FIAttributionForJobSettings.md)
281+
- [FIAttributionForSecurities](docs/FIAttributionForSecurities.md)
279282
- [FIBalloonExtension](docs/FIBalloonExtension.md)
280283
- [FIBankLoans](docs/FIBankLoans.md)
281284
- [FICalculationParameters](docs/FICalculationParameters.md)
@@ -379,6 +382,8 @@ Class | Method | HTTP request | Description
379382
- [SPARBenchmarkRoot](docs/SPARBenchmarkRoot.md)
380383
- [SPARCalculationParameters](docs/SPARCalculationParameters.md)
381384
- [SPARCalculationParametersRoot](docs/SPARCalculationParametersRoot.md)
385+
- [SPARComponent](docs/SPARComponent.md)
386+
- [SPARComponentRoot](docs/SPARComponentRoot.md)
382387
- [SPARDateParameters](docs/SPARDateParameters.md)
383388
- [SPARIdentifier](docs/SPARIdentifier.md)
384389
- [TemplateContentTypes](docs/TemplateContentTypes.md)

‎auto-generated-sdk/docs/AFIOptimizationParametersRoot.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**data** | [**AFIOptimizationParameters**](AFIOptimizationParameters.md) | | [optional]
8-
**meta** | **bool, date, datetime, dict, float, int, list, str** | | [optional]
8+
**meta** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional]
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1111

‎auto-generated-sdk/docs/AFIOptimizerApi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,7 @@ configuration = fds.analyticsapi.engines.Configuration(
418418
with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
419419
# Create an instance of the API class
420420
api_instance = afi_optimizer_api.AFIOptimizerApi(api_client)
421-
x_fact_set_api_long_running_deadline = 1 # int | Long running deadline in seconds. (optional)
421+
x_fact_set_api_long_running_deadline = 10 # int | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional)
422422
cache_control = "Cache-Control_example" # str | Standard HTTP header. Accepts max-stale. (optional)
423423
afi_optimization_parameters_root = AFIOptimizationParametersRoot(
424424
data=AFIOptimizationParameters(
@@ -486,7 +486,7 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
486486

487487
Name | Type | Description | Notes
488488
------------- | ------------- | ------------- | -------------
489-
**x_fact_set_api_long_running_deadline** | **int**| Long running deadline in seconds. | [optional]
489+
**x_fact_set_api_long_running_deadline** | **int**| Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional]
490490
**cache_control** | **str**| Standard HTTP header. Accepts max-stale. | [optional]
491491
**afi_optimization_parameters_root** | [**AFIOptimizationParametersRoot**](AFIOptimizationParametersRoot.md)| Optimization Parameters | [optional]
492492

@@ -568,7 +568,7 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
568568
# Create an instance of the API class
569569
api_instance = afi_optimizer_api.AFIOptimizerApi(api_client)
570570
id = "id_example" # str | from url, provided from the location header in the Create and Run AFI optimization endpoint
571-
x_fact_set_api_long_running_deadline = 1 # int | Long running deadline in seconds. (optional)
571+
x_fact_set_api_long_running_deadline = 10 # int | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional)
572572
cache_control = "Cache-Control_example" # str | Standard HTTP header. Accepts max-stale. (optional)
573573
afi_optimization_parameters_root = AFIOptimizationParametersRoot(
574574
data=AFIOptimizationParameters(
@@ -645,7 +645,7 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
645645
Name | Type | Description | Notes
646646
------------- | ------------- | ------------- | -------------
647647
**id** | **str**| from url, provided from the location header in the Create and Run AFI optimization endpoint |
648-
**x_fact_set_api_long_running_deadline** | **int**| Long running deadline in seconds. | [optional]
648+
**x_fact_set_api_long_running_deadline** | **int**| Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional]
649649
**cache_control** | **str**| Standard HTTP header. Accepts max-stale. | [optional]
650650
**afi_optimization_parameters_root** | [**AFIOptimizationParametersRoot**](AFIOptimizationParametersRoot.md)| Optimization Parameters | [optional]
651651

‎auto-generated-sdk/docs/AXPOptimizerApi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,7 @@ configuration = fds.analyticsapi.engines.Configuration(
418418
with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
419419
# Create an instance of the API class
420420
api_instance = axp_optimizer_api.AXPOptimizerApi(api_client)
421-
x_fact_set_api_long_running_deadline = 1 # int | Long running deadline in seconds. (optional)
421+
x_fact_set_api_long_running_deadline = 10 # int | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional)
422422
cache_control = "Cache-Control_example" # str | Standard HTTP header. Accepts max-stale. (optional)
423423
axioma_equity_optimization_parameters_root = AxiomaEquityOptimizationParametersRoot(
424424
data=AxiomaEquityOptimizationParameters(
@@ -486,7 +486,7 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
486486

487487
Name | Type | Description | Notes
488488
------------- | ------------- | ------------- | -------------
489-
**x_fact_set_api_long_running_deadline** | **int**| Long running deadline in seconds. | [optional]
489+
**x_fact_set_api_long_running_deadline** | **int**| Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional]
490490
**cache_control** | **str**| Standard HTTP header. Accepts max-stale. | [optional]
491491
**axioma_equity_optimization_parameters_root** | [**AxiomaEquityOptimizationParametersRoot**](AxiomaEquityOptimizationParametersRoot.md)| Optimization Parameters | [optional]
492492

@@ -568,7 +568,7 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
568568
# Create an instance of the API class
569569
api_instance = axp_optimizer_api.AXPOptimizerApi(api_client)
570570
id = "id_example" # str | from url, provided from the location header in the Create and Run Axioma optimization endpoint
571-
x_fact_set_api_long_running_deadline = 1 # int | Long running deadline in seconds. (optional)
571+
x_fact_set_api_long_running_deadline = 10 # int | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional)
572572
cache_control = "Cache-Control_example" # str | Standard HTTP header. Accepts max-stale. (optional)
573573
axioma_equity_optimization_parameters_root = AxiomaEquityOptimizationParametersRoot(
574574
data=AxiomaEquityOptimizationParameters(
@@ -645,7 +645,7 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
645645
Name | Type | Description | Notes
646646
------------- | ------------- | ------------- | -------------
647647
**id** | **str**| from url, provided from the location header in the Create and Run Axioma optimization endpoint |
648-
**x_fact_set_api_long_running_deadline** | **int**| Long running deadline in seconds. | [optional]
648+
**x_fact_set_api_long_running_deadline** | **int**| Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional]
649649
**cache_control** | **str**| Standard HTTP header. Accepts max-stale. | [optional]
650650
**axioma_equity_optimization_parameters_root** | [**AxiomaEquityOptimizationParametersRoot**](AxiomaEquityOptimizationParametersRoot.md)| Optimization Parameters | [optional]
651651

‎auto-generated-sdk/docs/AccountsApi.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Method | HTTP request | Description
1010

1111

1212
# **get_accounts**
13-
> AccountDirectoriesRoot get_accounts()
13+
> AccountDirectoriesRoot get_accounts(path)
1414
1515
Get accounts and sub-directories in a directory
1616

@@ -53,11 +53,12 @@ configuration = fds.analyticsapi.engines.Configuration(
5353
with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
5454
# Create an instance of the API class
5555
api_instance = accounts_api.AccountsApi(api_client)
56+
path = "Client:" # str | The directory to get the accounts and sub-directories.
5657

5758
# example passing only required values which don't have defaults set
5859
try:
5960
# Get accounts and sub-directories in a directory
60-
api_response = api_instance.get_accounts()
61+
api_response = api_instance.get_accounts(path)
6162
pprint(api_response)
6263
except fds.analyticsapi.engines.ApiException as e:
6364
print("Exception when calling AccountsApi->get_accounts: %s\n" % e)
@@ -68,7 +69,7 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
6869

6970
Name | Type | Description | Notes
7071
------------- | ------------- | ------------- | -------------
71-
**path** | **str**| The directory to get the accounts and sub-directories in | defaults to ""
72+
**path** | **str**| The directory to get the accounts and sub-directories. |
7273

7374
### Return type
7475

‎auto-generated-sdk/docs/AxiomaEquityOptimizationParametersRoot.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**data** | [**AxiomaEquityOptimizationParameters**](AxiomaEquityOptimizationParameters.md) | | [optional]
8-
**meta** | **bool, date, datetime, dict, float, int, list, str** | | [optional]
8+
**meta** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional]
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1111

‎auto-generated-sdk/docs/BPMOptimizationParametersRoot.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**data** | [**BPMOptimizationParameters**](BPMOptimizationParameters.md) | | [optional]
8-
**meta** | **bool, date, datetime, dict, float, int, list, str** | | [optional]
8+
**meta** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional]
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1111

‎auto-generated-sdk/docs/BPMOptimizerApi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,7 @@ configuration = fds.analyticsapi.engines.Configuration(
418418
with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
419419
# Create an instance of the API class
420420
api_instance = bpm_optimizer_api.BPMOptimizerApi(api_client)
421-
x_fact_set_api_long_running_deadline = 1 # int | Long running deadline in seconds. (optional)
421+
x_fact_set_api_long_running_deadline = 10 # int | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional)
422422
cache_control = "Cache-Control_example" # str | Standard HTTP header. Accepts max-stale. (optional)
423423
bpm_optimization_parameters_root = BPMOptimizationParametersRoot(
424424
data=BPMOptimizationParameters(
@@ -494,7 +494,7 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
494494

495495
Name | Type | Description | Notes
496496
------------- | ------------- | ------------- | -------------
497-
**x_fact_set_api_long_running_deadline** | **int**| Long running deadline in seconds. | [optional]
497+
**x_fact_set_api_long_running_deadline** | **int**| Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional]
498498
**cache_control** | **str**| Standard HTTP header. Accepts max-stale. | [optional]
499499
**bpm_optimization_parameters_root** | [**BPMOptimizationParametersRoot**](BPMOptimizationParametersRoot.md)| Optimization Parameters | [optional]
500500

@@ -576,7 +576,7 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
576576
# Create an instance of the API class
577577
api_instance = bpm_optimizer_api.BPMOptimizerApi(api_client)
578578
id = "id_example" # str | from url, provided from the location header in the Create and Run BPM optimization endpoint
579-
x_fact_set_api_long_running_deadline = 1 # int | Long running deadline in seconds. (optional)
579+
x_fact_set_api_long_running_deadline = 10 # int | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional)
580580
cache_control = "Cache-Control_example" # str | Standard HTTP header. Accepts max-stale. (optional)
581581
bpm_optimization_parameters_root = BPMOptimizationParametersRoot(
582582
data=BPMOptimizationParameters(
@@ -661,7 +661,7 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
661661
Name | Type | Description | Notes
662662
------------- | ------------- | ------------- | -------------
663663
**id** | **str**| from url, provided from the location header in the Create and Run BPM optimization endpoint |
664-
**x_fact_set_api_long_running_deadline** | **int**| Long running deadline in seconds. | [optional]
664+
**x_fact_set_api_long_running_deadline** | **int**| Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional]
665665
**cache_control** | **str**| Standard HTTP header. Accepts max-stale. | [optional]
666666
**bpm_optimization_parameters_root** | [**BPMOptimizationParametersRoot**](BPMOptimizationParametersRoot.md)| Optimization Parameters | [optional]
667667

0 commit comments

Comments
 (0)