diff --git a/auto-generated-sdk/.openapi-generator/FILES b/auto-generated-sdk/.openapi-generator/FILES index 76f7d73f..a70e636b 100644 --- a/auto-generated-sdk/.openapi-generator/FILES +++ b/auto-generated-sdk/.openapi-generator/FILES @@ -68,6 +68,8 @@ docs/FIABCalculationStatusSummary.md docs/FIABCalculationsApi.md docs/FIABDateParameters.md docs/FIABIdentifier.md +docs/FIAttributionForJobSettings.md +docs/FIAttributionForSecurities.md docs/FIBalloonExtension.md docs/FIBankLoans.md docs/FICalculationParameters.md @@ -185,6 +187,8 @@ docs/SPARBenchmarkRoot.md docs/SPARCalculationParameters.md docs/SPARCalculationParametersRoot.md docs/SPARCalculationsApi.md +docs/SPARComponent.md +docs/SPARComponentRoot.md docs/SPARDateParameters.md docs/SPARIdentifier.md docs/StrategyDocumentsApi.md @@ -217,6 +221,9 @@ docs/UnlinkedPATemplateSummaryRoot.md docs/UnlinkedPATemplateUpdateParameters.md docs/UnlinkedPATemplateUpdateParametersRoot.md docs/UnlinkedPATemplatesApi.md +docs/VaultAttributionLoaderApi.md +docs/VaultAttributionLoaderResponse.md +docs/VaultAttributionLoaderResponseRoot.md docs/VaultCalculationParameters.md docs/VaultCalculationParametersRoot.md docs/VaultCalculationsApi.md @@ -257,6 +264,7 @@ src/FactSet.AnalyticsAPI.Engines/Api/SPARCalculationsApi.cs src/FactSet.AnalyticsAPI.Engines/Api/StrategyDocumentsApi.cs src/FactSet.AnalyticsAPI.Engines/Api/TemplatedPAComponentsApi.cs src/FactSet.AnalyticsAPI.Engines/Api/UnlinkedPATemplatesApi.cs +src/FactSet.AnalyticsAPI.Engines/Api/VaultAttributionLoaderApi.cs src/FactSet.AnalyticsAPI.Engines/Api/VaultCalculationsApi.cs src/FactSet.AnalyticsAPI.Engines/Client/ApiClient.cs src/FactSet.AnalyticsAPI.Engines/Client/ApiException.cs @@ -327,6 +335,8 @@ src/FactSet.AnalyticsAPI.Engines/Model/FIABCalculationStatus.cs src/FactSet.AnalyticsAPI.Engines/Model/FIABCalculationStatusSummary.cs src/FactSet.AnalyticsAPI.Engines/Model/FIABDateParameters.cs src/FactSet.AnalyticsAPI.Engines/Model/FIABIdentifier.cs +src/FactSet.AnalyticsAPI.Engines/Model/FIAttributionForJobSettings.cs +src/FactSet.AnalyticsAPI.Engines/Model/FIAttributionForSecurities.cs src/FactSet.AnalyticsAPI.Engines/Model/FIBalloonExtension.cs src/FactSet.AnalyticsAPI.Engines/Model/FIBankLoans.cs src/FactSet.AnalyticsAPI.Engines/Model/FICalculationParameters.cs @@ -433,6 +443,8 @@ src/FactSet.AnalyticsAPI.Engines/Model/SPARBenchmark.cs src/FactSet.AnalyticsAPI.Engines/Model/SPARBenchmarkRoot.cs src/FactSet.AnalyticsAPI.Engines/Model/SPARCalculationParameters.cs src/FactSet.AnalyticsAPI.Engines/Model/SPARCalculationParametersRoot.cs +src/FactSet.AnalyticsAPI.Engines/Model/SPARComponent.cs +src/FactSet.AnalyticsAPI.Engines/Model/SPARComponentRoot.cs src/FactSet.AnalyticsAPI.Engines/Model/SPARDateParameters.cs src/FactSet.AnalyticsAPI.Engines/Model/SPARIdentifier.cs src/FactSet.AnalyticsAPI.Engines/Model/TemplateContentTypes.cs @@ -462,6 +474,8 @@ src/FactSet.AnalyticsAPI.Engines/Model/UnlinkedPATemplateSummary.cs src/FactSet.AnalyticsAPI.Engines/Model/UnlinkedPATemplateSummaryRoot.cs src/FactSet.AnalyticsAPI.Engines/Model/UnlinkedPATemplateUpdateParameters.cs src/FactSet.AnalyticsAPI.Engines/Model/UnlinkedPATemplateUpdateParametersRoot.cs +src/FactSet.AnalyticsAPI.Engines/Model/VaultAttributionLoaderResponse.cs +src/FactSet.AnalyticsAPI.Engines/Model/VaultAttributionLoaderResponseRoot.cs src/FactSet.AnalyticsAPI.Engines/Model/VaultCalculationParameters.cs src/FactSet.AnalyticsAPI.Engines/Model/VaultCalculationParametersRoot.cs src/FactSet.AnalyticsAPI.Engines/Model/VaultComponent.cs diff --git a/auto-generated-sdk/README.md b/auto-generated-sdk/README.md index 32fafbb6..d597a132 100644 --- a/auto-generated-sdk/README.md +++ b/auto-generated-sdk/README.md @@ -132,6 +132,7 @@ Class | Method | HTTP request | Description *ColumnsApi* | [**GetPAColumns**](docs/ColumnsApi.md#getpacolumns) | **GET** /analytics/engines/pa/v3/columns | Get PA columns *ComponentsApi* | [**GetPAComponentById**](docs/ComponentsApi.md#getpacomponentbyid) | **GET** /analytics/engines/pa/v3/components/{id} | Get PA component by id *ComponentsApi* | [**GetPAComponents**](docs/ComponentsApi.md#getpacomponents) | **GET** /analytics/engines/pa/v3/components | Get PA components +*ComponentsApi* | [**GetSPARComponentById**](docs/ComponentsApi.md#getsparcomponentbyid) | **GET** /analytics/engines/spar/v3/components/{id} | Get SPAR component by id *ComponentsApi* | [**GetSPARComponents**](docs/ComponentsApi.md#getsparcomponents) | **GET** /analytics/engines/spar/v3/components | Get SPAR components *ComponentsApi* | [**GetVaultComponentById**](docs/ComponentsApi.md#getvaultcomponentbyid) | **GET** /analytics/engines/vault/v3/components/{id} | Get Vault component by id *ComponentsApi* | [**GetVaultComponents**](docs/ComponentsApi.md#getvaultcomponents) | **GET** /analytics/engines/vault/v3/components | Get Vault components @@ -223,6 +224,7 @@ Class | Method | HTTP request | Description *UnlinkedPATemplatesApi* | [**GetUnlinkedPATemplates**](docs/UnlinkedPATemplatesApi.md#getunlinkedpatemplates) | **GET** /analytics/engines/pa/v3/unlinked-templates | Get unlinked PA templates *UnlinkedPATemplatesApi* | [**GetUnlinkedPATemplatesById**](docs/UnlinkedPATemplatesApi.md#getunlinkedpatemplatesbyid) | **GET** /analytics/engines/pa/v3/unlinked-templates/{id} | Get unlinked PA template details by id *UnlinkedPATemplatesApi* | [**UpdateUnlinkedPATemplates**](docs/UnlinkedPATemplatesApi.md#updateunlinkedpatemplates) | **PUT** /analytics/engines/pa/v3/unlinked-templates/{id} | Update unlinked PA template +*VaultAttributionLoaderApi* | [**VaultAttributionLoader**](docs/VaultAttributionLoaderApi.md#vaultattributionloader) | **POST** /analytics/engines/vault/v3/load/{batchId} | Vault - External Attribution Loader *VaultCalculationsApi* | [**CancelCalculationById**](docs/VaultCalculationsApi.md#cancelcalculationbyid) | **DELETE** /analytics/engines/vault/v3/calculations/{id} | Cancel Vault calculation by id *VaultCalculationsApi* | [**GetAllCalculations**](docs/VaultCalculationsApi.md#getallcalculations) | **GET** /analytics/engines/vault/v3/calculations | Get all calculations *VaultCalculationsApi* | [**GetCalculationParameters**](docs/VaultCalculationsApi.md#getcalculationparameters) | **GET** /analytics/engines/vault/v3/calculations/{id} | Get Vault calculation parameters by id @@ -286,6 +288,8 @@ Class | Method | HTTP request | Description - [Model.FIABCalculationStatusSummary](docs/FIABCalculationStatusSummary.md) - [Model.FIABDateParameters](docs/FIABDateParameters.md) - [Model.FIABIdentifier](docs/FIABIdentifier.md) + - [Model.FIAttributionForJobSettings](docs/FIAttributionForJobSettings.md) + - [Model.FIAttributionForSecurities](docs/FIAttributionForSecurities.md) - [Model.FIBalloonExtension](docs/FIBalloonExtension.md) - [Model.FIBankLoans](docs/FIBankLoans.md) - [Model.FICalculationParameters](docs/FICalculationParameters.md) @@ -392,6 +396,8 @@ Class | Method | HTTP request | Description - [Model.SPARBenchmarkRoot](docs/SPARBenchmarkRoot.md) - [Model.SPARCalculationParameters](docs/SPARCalculationParameters.md) - [Model.SPARCalculationParametersRoot](docs/SPARCalculationParametersRoot.md) + - [Model.SPARComponent](docs/SPARComponent.md) + - [Model.SPARComponentRoot](docs/SPARComponentRoot.md) - [Model.SPARDateParameters](docs/SPARDateParameters.md) - [Model.SPARIdentifier](docs/SPARIdentifier.md) - [Model.TemplateContentTypes](docs/TemplateContentTypes.md) @@ -421,6 +427,8 @@ Class | Method | HTTP request | Description - [Model.UnlinkedPATemplateSummaryRoot](docs/UnlinkedPATemplateSummaryRoot.md) - [Model.UnlinkedPATemplateUpdateParameters](docs/UnlinkedPATemplateUpdateParameters.md) - [Model.UnlinkedPATemplateUpdateParametersRoot](docs/UnlinkedPATemplateUpdateParametersRoot.md) + - [Model.VaultAttributionLoaderResponse](docs/VaultAttributionLoaderResponse.md) + - [Model.VaultAttributionLoaderResponseRoot](docs/VaultAttributionLoaderResponseRoot.md) - [Model.VaultCalculationParameters](docs/VaultCalculationParameters.md) - [Model.VaultCalculationParametersRoot](docs/VaultCalculationParametersRoot.md) - [Model.VaultComponent](docs/VaultComponent.md) diff --git a/auto-generated-sdk/docs/CalculationUnitStatus.md b/auto-generated-sdk/docs/CalculationUnitStatus.md index 3c33352e..3527f5d0 100644 --- a/auto-generated-sdk/docs/CalculationUnitStatus.md +++ b/auto-generated-sdk/docs/CalculationUnitStatus.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **Result** | **string** | The result URL of the calculation. | [optional] **Progress** | **string** | The progress of the calculation unit. | [optional] **Points** | **int** | The points for the calculation unit. | [optional] +**Warnings** | **List<string>** | The warnings in a calculation unit. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/auto-generated-sdk/docs/ComponentsApi.md b/auto-generated-sdk/docs/ComponentsApi.md index ef1437e7..36794fcf 100644 --- a/auto-generated-sdk/docs/ComponentsApi.md +++ b/auto-generated-sdk/docs/ComponentsApi.md @@ -6,6 +6,7 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**GetPAComponentById**](ComponentsApi.md#getpacomponentbyid) | **GET** /analytics/engines/pa/v3/components/{id} | Get PA component by id [**GetPAComponents**](ComponentsApi.md#getpacomponents) | **GET** /analytics/engines/pa/v3/components | Get PA components +[**GetSPARComponentById**](ComponentsApi.md#getsparcomponentbyid) | **GET** /analytics/engines/spar/v3/components/{id} | Get SPAR component by id [**GetSPARComponents**](ComponentsApi.md#getsparcomponents) | **GET** /analytics/engines/spar/v3/components | Get SPAR components [**GetVaultComponentById**](ComponentsApi.md#getvaultcomponentbyid) | **GET** /analytics/engines/vault/v3/components/{id} | Get Vault component by id [**GetVaultComponents**](ComponentsApi.md#getvaultcomponents) | **GET** /analytics/engines/vault/v3/components | Get Vault components @@ -181,6 +182,91 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **GetSPARComponentById** +> SPARComponentRoot GetSPARComponentById (string id) + +Get SPAR component by id + +This endpoint returns the default settings of a SPAR component. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using FactSet.AnalyticsAPI.Engines.Api; +using FactSet.AnalyticsAPI.Engines.Client; +using FactSet.AnalyticsAPI.Engines.Model; + +namespace Example +{ + public class GetSPARComponentByIdExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.factset.com"; + // Configure HTTP basic authorization: Basic + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + // Configure Bearer token for authorization: Bearer + config.AccessToken = "YOUR_BEARER_TOKEN"; + + var apiInstance = new ComponentsApi(config); + var id = id_example; // string | Unique identifier for a SPAR component + + try + { + // Get SPAR component by id + SPARComponentRoot result = apiInstance.GetSPARComponentById(id); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling ComponentsApi.GetSPARComponentById: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **string**| Unique identifier for a SPAR component | + +### Return type + +[**SPARComponentRoot**](SPARComponentRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Expected response, returns the default settings of a SPAR component. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid SPAR component id. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Component not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **GetSPARComponents** > ComponentSummaryRoot GetSPARComponents (string document) diff --git a/auto-generated-sdk/docs/Error.md b/auto-generated-sdk/docs/Error.md index 54a3e9cf..d8f4a327 100644 --- a/auto-generated-sdk/docs/Error.md +++ b/auto-generated-sdk/docs/Error.md @@ -5,6 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | **string** | | [optional] +**Code** | **string** | | [optional] +**Title** | **string** | | [optional] **Detail** | **string** | | [optional] **Source** | [**ErrorSource**](ErrorSource.md) | | [optional] diff --git a/auto-generated-sdk/docs/FIAttributionForJobSettings.md b/auto-generated-sdk/docs/FIAttributionForJobSettings.md new file mode 100644 index 00000000..2eb83c6c --- /dev/null +++ b/auto-generated-sdk/docs/FIAttributionForJobSettings.md @@ -0,0 +1,11 @@ +# FactSet.AnalyticsAPI.Engines.Model.FIAttributionForJobSettings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**StartDate** | **string** | Start Date | [optional] +**EndDate** | **string** | End Date | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/auto-generated-sdk/docs/FIAttributionForSecurities.md b/auto-generated-sdk/docs/FIAttributionForSecurities.md new file mode 100644 index 00000000..0614a4af --- /dev/null +++ b/auto-generated-sdk/docs/FIAttributionForSecurities.md @@ -0,0 +1,14 @@ +# FactSet.AnalyticsAPI.Engines.Model.FIAttributionForSecurities + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**StartPrice** | **double** | Start Price | [optional] +**EndPrice** | **double** | End Price | [optional] +**StartSpread** | **double** | Start Spread | [optional] +**EndSpread** | **double** | End Spread | [optional] +**PricingMethod** | **string** | Pricing Method | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/auto-generated-sdk/docs/FIJobSettings.md b/auto-generated-sdk/docs/FIJobSettings.md index 7a079a2d..39ffb4af 100644 --- a/auto-generated-sdk/docs/FIJobSettings.md +++ b/auto-generated-sdk/docs/FIJobSettings.md @@ -13,6 +13,7 @@ Name | Type | Description | Notes **MunicipalBonds** | [**FIMunicipalBondsForJobSettings**](FIMunicipalBondsForJobSettings.md) | | [optional] **MarketEnvironment** | [**FIMarketEnvironment**](FIMarketEnvironment.md) | | [optional] **StructuredProducts** | [**FIStructuredProductsForJobSettings**](FIStructuredProductsForJobSettings.md) | | [optional] +**Attribution** | [**FIAttributionForJobSettings**](FIAttributionForJobSettings.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/auto-generated-sdk/docs/FISecurity.md b/auto-generated-sdk/docs/FISecurity.md index 7a75c762..662d95aa 100644 --- a/auto-generated-sdk/docs/FISecurity.md +++ b/auto-generated-sdk/docs/FISecurity.md @@ -14,6 +14,7 @@ Name | Type | Description | Notes **MatrixSpreadAdjustment** | **double** | Matrix Spread Adjustment | [optional] **MatrixMultiplier** | **double** | Matrix Multiplier | [optional] **StructuredProducts** | [**FIStructuredProductsForSecurities**](FIStructuredProductsForSecurities.md) | | [optional] +**Attribution** | [**FIAttributionForSecurities**](FIAttributionForSecurities.md) | | [optional] **CalcFromMethod** | **string** | Calculation Method. Methods : Active Spread, Actual Spread, Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act Yield To No Call, Bond Equivalent Yield, Yield To Worst Call, Discount Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread To Worst Call, Pricing Matrix | [optional] **CalcFromValue** | **double** | Calculation from value | **Face** | **double** | Face | [optional] [default to 1D] diff --git a/auto-generated-sdk/docs/PACalculationsApi.md b/auto-generated-sdk/docs/PACalculationsApi.md index 12dea28e..af8faaf0 100644 --- a/auto-generated-sdk/docs/PACalculationsApi.md +++ b/auto-generated-sdk/docs/PACalculationsApi.md @@ -438,7 +438,7 @@ Name | Type | Description | Notes Create and Run PA calculation -This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. +This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. ### Example ```csharp @@ -529,7 +529,7 @@ Name | Type | Description | Notes Create or Update PA calculation and run it. -This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. +This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. ### Example ```csharp diff --git a/auto-generated-sdk/docs/PAComponentData.md b/auto-generated-sdk/docs/PAComponentData.md index 2dbea3e5..f8a466af 100644 --- a/auto-generated-sdk/docs/PAComponentData.md +++ b/auto-generated-sdk/docs/PAComponentData.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **Dates** | [**PADateParameters**](PADateParameters.md) | | [optional] **Datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] **Currencyisocode** | **string** | Currency ISO code for calculation. | [optional] -**Componentdetail** | **string** | PA Storage type. It can be GROUPS or TOTALS or SECURITIES. | [optional] +**Componentdetail** | **string** | PA Storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/auto-generated-sdk/docs/QuantCalculationsApi.md b/auto-generated-sdk/docs/QuantCalculationsApi.md index 6c1f837f..5c507df7 100644 --- a/auto-generated-sdk/docs/QuantCalculationsApi.md +++ b/auto-generated-sdk/docs/QuantCalculationsApi.md @@ -417,7 +417,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json, application/x-protobuf, application/octet-stream + - **Accept**: application/octet-stream, application/json ### HTTP response details @@ -425,9 +425,9 @@ Name | Type | Description | Notes |-------------|-------------|------------------| | **200** | Expected response once calculation is completed. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| | **400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -| **404** | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| | **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| | **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| | **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| | **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| @@ -502,7 +502,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json, application/x-protobuf, application/octet-stream + - **Accept**: application/octet-stream, application/json ### HTTP response details @@ -510,9 +510,9 @@ Name | Type | Description | Notes |-------------|-------------|------------------| | **200** | Expected response once calculation is completed, returns JSON in the format specified in the Calculation parameters. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| | **400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -| **404** | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| | **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| | **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| | **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| | **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| @@ -587,19 +587,20 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json - - **Accept**: application/json, application/x-protobuf + - **Accept**: application/json, application/octet-stream ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -| **201** | Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| | **200** | Expected response if the calculation has one unit and is completed with an error. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **201** | Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| | **400** | Invalid calculation parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -| **404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| | **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| | **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **413** | Request body too large | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| | **415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| | **429** | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| | **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| @@ -678,20 +679,21 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json - - **Accept**: application/json, application/x-protobuf + - **Accept**: application/json, application/octet-stream ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| | **200** | Expected response if the calculation has one unit and is completed with an error. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| | **201** | Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| | **400** | Invalid Calculation Parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -| **404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -| **409** | Duplicate calculation exists with same parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| | **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| | **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **409** | Duplicate calculation exists with same parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **413** | Request body too large | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| | **415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| | **429** | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| | **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| diff --git a/auto-generated-sdk/docs/SPARComponent.md b/auto-generated-sdk/docs/SPARComponent.md new file mode 100644 index 00000000..d7a2163d --- /dev/null +++ b/auto-generated-sdk/docs/SPARComponent.md @@ -0,0 +1,16 @@ +# FactSet.AnalyticsAPI.Engines.Model.SPARComponent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Component identifier. | [optional] +**Accounts** | [**List<SPARIdentifier>**](SPARIdentifier.md) | List of accounts in SPAR document. | [optional] +**Benchmarks** | [**SPARIdentifier**](SPARIdentifier.md) | | [optional] +**CurrencyIsoCode** | **string** | CurrencyCode in SPAR document. | [optional] +**Path** | **string** | The path to the document | [optional] +**Name** | **string** | Component name. | [optional] +**Category** | **string** | Component category. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/auto-generated-sdk/docs/SPARComponentRoot.md b/auto-generated-sdk/docs/SPARComponentRoot.md new file mode 100644 index 00000000..6b024dd7 --- /dev/null +++ b/auto-generated-sdk/docs/SPARComponentRoot.md @@ -0,0 +1,10 @@ +# FactSet.AnalyticsAPI.Engines.Model.SPARComponentRoot + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | [**SPARComponent**](SPARComponent.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentsApi.md b/auto-generated-sdk/docs/TemplatedPAComponentsApi.md index 188b515e..886b08fc 100644 --- a/auto-generated-sdk/docs/TemplatedPAComponentsApi.md +++ b/auto-generated-sdk/docs/TemplatedPAComponentsApi.md @@ -17,7 +17,7 @@ Method | HTTP request | Description Create templated PA component -This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. +This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. ### Example ```csharp @@ -355,7 +355,7 @@ Name | Type | Description | Notes Update templated PA component -This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. +This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. ### Example ```csharp diff --git a/auto-generated-sdk/docs/UnlinkedPATemplate.md b/auto-generated-sdk/docs/UnlinkedPATemplate.md index 79cb1d6b..f06a68ca 100644 --- a/auto-generated-sdk/docs/UnlinkedPATemplate.md +++ b/auto-generated-sdk/docs/UnlinkedPATemplate.md @@ -15,7 +15,7 @@ Name | Type | Description | Notes **Groups** | [**List<PACalculationGroup>**](PACalculationGroup.md) | List of groupings for the PA calculation | [optional] **Datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] **Currencyisocode** | **string** | Currency ISO code for calculation. | [optional] -**Componentdetail** | **string** | PA storage type. It can be GROUPS or TOTALS or SECURITIES. | [optional] +**Componentdetail** | **string** | PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] **Content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] **Description** | **string** | Template description. | [optional] **Name** | **string** | Template name. | [optional] diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md b/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md index 72e58797..c17d6533 100644 --- a/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md +++ b/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes **Groups** | [**List<PACalculationGroup>**](PACalculationGroup.md) | List of groupings for the PA calculation | [optional] **Datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] **Currencyisocode** | **string** | Currency ISO code for calculation. | [optional] -**Componentdetail** | **string** | PA storage type. It can be GROUPS or TOTALS or SECURITIES. | [optional] +**Componentdetail** | **string** | PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] **Content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md b/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md index a0868db7..008f9b89 100644 --- a/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md +++ b/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **Groups** | [**List<PACalculationGroup>**](PACalculationGroup.md) | List of groupings for the PA calculation | [optional] **Datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] **Currencyisocode** | **string** | Currency ISO code for calculation. | [optional] -**Componentdetail** | **string** | PA storage type. It can be GROUPS or TOTALS or SECURITIES. | [optional] +**Componentdetail** | **string** | PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] **Content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/auto-generated-sdk/docs/UnlinkedPATemplatesApi.md b/auto-generated-sdk/docs/UnlinkedPATemplatesApi.md index 297b0d40..e32a62bf 100644 --- a/auto-generated-sdk/docs/UnlinkedPATemplatesApi.md +++ b/auto-generated-sdk/docs/UnlinkedPATemplatesApi.md @@ -19,7 +19,7 @@ Method | HTTP request | Description Create unlinked PA template -This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. +This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. ### Example ```csharp @@ -522,7 +522,7 @@ Name | Type | Description | Notes Update unlinked PA template -This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. +This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. ### Example ```csharp diff --git a/auto-generated-sdk/docs/VaultAttributionLoaderApi.md b/auto-generated-sdk/docs/VaultAttributionLoaderApi.md new file mode 100644 index 00000000..4c6fefcb --- /dev/null +++ b/auto-generated-sdk/docs/VaultAttributionLoaderApi.md @@ -0,0 +1,95 @@ +# FactSet.AnalyticsAPI.Engines.Api.VaultAttributionLoaderApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**VaultAttributionLoader**](VaultAttributionLoaderApi.md#vaultattributionloader) | **POST** /analytics/engines/vault/v3/load/{batchId} | Vault - External Attribution Loader + + + +# **VaultAttributionLoader** +> VaultAttributionLoaderResponseRoot VaultAttributionLoader (string batchId, System.IO.Stream file = null) + +Vault - External Attribution Loader + +This endpoint loads Vault External Attributions. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using FactSet.AnalyticsAPI.Engines.Api; +using FactSet.AnalyticsAPI.Engines.Client; +using FactSet.AnalyticsAPI.Engines.Model; + +namespace Example +{ + public class VaultAttributionLoaderExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.factset.com"; + // Configure HTTP basic authorization: Basic + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + // Configure Bearer token for authorization: Bearer + config.AccessToken = "YOUR_BEARER_TOKEN"; + + var apiInstance = new VaultAttributionLoaderApi(config); + var batchId = batchId_example; // string | + var file = BINARY_DATA_HERE; // System.IO.Stream | (optional) + + try + { + // Vault - External Attribution Loader + VaultAttributionLoaderResponseRoot result = apiInstance.VaultAttributionLoader(batchId, file); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling VaultAttributionLoaderApi.VaultAttributionLoader: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **batchId** | **string**| | + **file** | **System.IO.Stream****System.IO.Stream**| | [optional] + +### Return type + +[**VaultAttributionLoaderResponseRoot**](VaultAttributionLoaderResponseRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Expected response, returns a status of operation along with errors and warnings if found any. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Bad Request | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/auto-generated-sdk/docs/VaultAttributionLoaderResponse.md b/auto-generated-sdk/docs/VaultAttributionLoaderResponse.md new file mode 100644 index 00000000..e56a9685 --- /dev/null +++ b/auto-generated-sdk/docs/VaultAttributionLoaderResponse.md @@ -0,0 +1,12 @@ +# FactSet.AnalyticsAPI.Engines.Model.VaultAttributionLoaderResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProcessId** | **string** | ProcessId. | [optional] +**GroupId** | **string** | GroupId. | [optional] +**ObjectId** | **string** | ObjectId. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/auto-generated-sdk/docs/VaultAttributionLoaderResponseRoot.md b/auto-generated-sdk/docs/VaultAttributionLoaderResponseRoot.md new file mode 100644 index 00000000..b4316bc1 --- /dev/null +++ b/auto-generated-sdk/docs/VaultAttributionLoaderResponseRoot.md @@ -0,0 +1,11 @@ +# FactSet.AnalyticsAPI.Engines.Model.VaultAttributionLoaderResponseRoot + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | [**VaultAttributionLoaderResponse**](VaultAttributionLoaderResponse.md) | | +**Meta** | **Object** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/ComponentsApi.cs b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/ComponentsApi.cs index 0c37d2bb..0f3e1701 100644 --- a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/ComponentsApi.cs +++ b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/ComponentsApi.cs @@ -70,6 +70,27 @@ public interface IComponentsApiSync : IApiAccessor /// ApiResponse of ComponentSummaryRoot ApiResponse GetPAComponentsWithHttpInfo(string document); /// + /// Get SPAR component by id + /// + /// + /// This endpoint returns the default settings of a SPAR component. + /// + /// Thrown when fails to make API call + /// Unique identifier for a SPAR component + /// SPARComponentRoot + SPARComponentRoot GetSPARComponentById(string id); + + /// + /// Get SPAR component by id + /// + /// + /// This endpoint returns the default settings of a SPAR component. + /// + /// Thrown when fails to make API call + /// Unique identifier for a SPAR component + /// ApiResponse of SPARComponentRoot + ApiResponse GetSPARComponentByIdWithHttpInfo(string id); + /// /// Get SPAR components /// /// @@ -188,6 +209,29 @@ public interface IComponentsApiAsync : IApiAccessor /// Task of ApiResponse of ComponentSummaryRoot System.Threading.Tasks.Task> GetPAComponentsWithHttpInfoAsync(string document, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// + /// Get SPAR component by id + /// + /// + /// This endpoint returns the default settings of a SPAR component. + /// + /// Thrown when fails to make API call + /// Unique identifier for a SPAR component + /// Cancellation Token to cancel the request. + /// Task of SPARComponentRoot + System.Threading.Tasks.Task GetSPARComponentByIdAsync(string id, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + + /// + /// Get SPAR component by id + /// + /// + /// This endpoint returns the default settings of a SPAR component. + /// + /// Thrown when fails to make API call + /// Unique identifier for a SPAR component + /// Cancellation Token to cancel the request. + /// Task of ApiResponse of SPARComponentRoot + System.Threading.Tasks.Task> GetSPARComponentByIdWithHttpInfoAsync(string id, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + /// /// Get SPAR components /// /// @@ -680,6 +724,158 @@ public FactSet.AnalyticsAPI.Engines.Client.ApiResponse Get return localVarResponse; } + /// + /// Get SPAR component by id This endpoint returns the default settings of a SPAR component. + /// + /// Thrown when fails to make API call + /// Unique identifier for a SPAR component + /// SPARComponentRoot + public SPARComponentRoot GetSPARComponentById(string id) + { + FactSet.AnalyticsAPI.Engines.Client.ApiResponse localVarResponse = GetSPARComponentByIdWithHttpInfo(id); + return localVarResponse.Data; + } + + /// + /// Get SPAR component by id This endpoint returns the default settings of a SPAR component. + /// + /// Thrown when fails to make API call + /// Unique identifier for a SPAR component + /// ApiResponse of SPARComponentRoot + public FactSet.AnalyticsAPI.Engines.Client.ApiResponse GetSPARComponentByIdWithHttpInfo(string id) + { + // verify the required parameter 'id' is set + if (id == null) + throw new FactSet.AnalyticsAPI.Engines.Client.ApiException(400, "Missing required parameter 'id' when calling ComponentsApi->GetSPARComponentById"); + + FactSet.AnalyticsAPI.Engines.Client.RequestOptions localVarRequestOptions = new FactSet.AnalyticsAPI.Engines.Client.RequestOptions(); + + String[] _contentTypes = new String[] { + }; + + // to determine the Accept header + String[] _accepts = new String[] { + "application/json" + }; + + localVarRequestOptions.ResponseReturnTypes = new Dictionary + { + { 200, typeof(SPARComponentRoot) }, + { 400, typeof(ClientErrorResponse) }, + { 404, typeof(ClientErrorResponse) }, + }; + + var localVarContentType = FactSet.AnalyticsAPI.Engines.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + if (localVarContentType != null) localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + + var localVarAccept = FactSet.AnalyticsAPI.Engines.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + + localVarRequestOptions.PathParameters.Add("id", FactSet.AnalyticsAPI.Engines.Client.ClientUtils.ParameterToString(id)); // path parameter + + // authentication (Basic) required + // http basic authentication required + if (!String.IsNullOrEmpty(this.Configuration.Username) || !String.IsNullOrEmpty(this.Configuration.Password)) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + FactSet.AnalyticsAPI.Engines.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + // authentication (Bearer) required + // bearer authentication required + if (!String.IsNullOrEmpty(this.Configuration.AccessToken)) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Bearer " + this.Configuration.AccessToken); + } + + // make the HTTP request + var localVarResponse = this.Client.Get("/analytics/engines/spar/v3/components/{id}", localVarRequestOptions, this.Configuration); + + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("GetSPARComponentById", localVarResponse); + if (_exception != null) throw _exception; + } + + return localVarResponse; + } + + /// + /// Get SPAR component by id This endpoint returns the default settings of a SPAR component. + /// + /// Thrown when fails to make API call + /// Unique identifier for a SPAR component + /// Cancellation Token to cancel the request. + /// Task of SPARComponentRoot + public async System.Threading.Tasks.Task GetSPARComponentByIdAsync(string id, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + { + FactSet.AnalyticsAPI.Engines.Client.ApiResponse localVarResponse = await GetSPARComponentByIdWithHttpInfoAsync(id, cancellationToken).ConfigureAwait(false); + return localVarResponse.Data; + } + + /// + /// Get SPAR component by id This endpoint returns the default settings of a SPAR component. + /// + /// Thrown when fails to make API call + /// Unique identifier for a SPAR component + /// Cancellation Token to cancel the request. + /// Task of ApiResponse of SPARComponentRoot + public async System.Threading.Tasks.Task> GetSPARComponentByIdWithHttpInfoAsync(string id, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + { + // verify the required parameter 'id' is set + if (id == null) + throw new FactSet.AnalyticsAPI.Engines.Client.ApiException(400, "Missing required parameter 'id' when calling ComponentsApi->GetSPARComponentById"); + + + FactSet.AnalyticsAPI.Engines.Client.RequestOptions localVarRequestOptions = new FactSet.AnalyticsAPI.Engines.Client.RequestOptions(); + + String[] _contentTypes = new String[] { + }; + + // to determine the Accept header + String[] _accepts = new String[] { + "application/json" + }; + + localVarRequestOptions.ResponseReturnTypes = new Dictionary + { + { 200, typeof(SPARComponentRoot) }, + { 400, typeof(ClientErrorResponse) }, + { 404, typeof(ClientErrorResponse) }, + }; + + var localVarContentType = FactSet.AnalyticsAPI.Engines.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + if (localVarContentType != null) localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + + var localVarAccept = FactSet.AnalyticsAPI.Engines.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + + localVarRequestOptions.PathParameters.Add("id", FactSet.AnalyticsAPI.Engines.Client.ClientUtils.ParameterToString(id)); // path parameter + + // authentication (Basic) required + // http basic authentication required + if (!String.IsNullOrEmpty(this.Configuration.Username) || !String.IsNullOrEmpty(this.Configuration.Password)) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + FactSet.AnalyticsAPI.Engines.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + // authentication (Bearer) required + // bearer authentication required + if (!String.IsNullOrEmpty(this.Configuration.AccessToken)) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Bearer " + this.Configuration.AccessToken); + } + + // make the HTTP request + + var localVarResponse = await this.AsynchronousClient.GetAsync("/analytics/engines/spar/v3/components/{id}", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); + + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("GetSPARComponentById", localVarResponse); + if (_exception != null) throw _exception; + } + + return localVarResponse; + } + /// /// Get SPAR components This endpoint returns the list of SPAR components in a given SPAR document. /// diff --git a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/PACalculationsApi.cs b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/PACalculationsApi.cs index 2d982133..d13bbaf8 100644 --- a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/PACalculationsApi.cs +++ b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/PACalculationsApi.cs @@ -138,7 +138,7 @@ public interface IPACalculationsApiSync : IApiAccessor /// Create and Run PA calculation /// /// - /// This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. /// /// Thrown when fails to make API call /// Long running deadline in seconds when only one unit is passed in the POST body. (optional) @@ -154,7 +154,7 @@ public interface IPACalculationsApiSync : IApiAccessor /// Create and Run PA calculation /// /// - /// This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. /// /// Thrown when fails to make API call /// Long running deadline in seconds when only one unit is passed in the POST body. (optional) @@ -169,7 +169,7 @@ public interface IPACalculationsApiSync : IApiAccessor /// Create or Update PA calculation and run it. /// /// - /// This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. /// /// Thrown when fails to make API call /// from url, provided from the location header in the Create and Run PA calculation endpoint @@ -186,7 +186,7 @@ public interface IPACalculationsApiSync : IApiAccessor /// Create or Update PA calculation and run it. /// /// - /// This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. /// /// Thrown when fails to make API call /// from url, provided from the location header in the Create and Run PA calculation endpoint @@ -328,7 +328,7 @@ public interface IPACalculationsApiAsync : IApiAccessor /// Create and Run PA calculation /// /// - /// This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. /// /// Thrown when fails to make API call /// Long running deadline in seconds when only one unit is passed in the POST body. (optional) @@ -345,7 +345,7 @@ public interface IPACalculationsApiAsync : IApiAccessor /// Create and Run PA calculation /// /// - /// This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. /// /// Thrown when fails to make API call /// Long running deadline in seconds when only one unit is passed in the POST body. (optional) @@ -361,7 +361,7 @@ public interface IPACalculationsApiAsync : IApiAccessor /// Create or Update PA calculation and run it. /// /// - /// This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. /// /// Thrown when fails to make API call /// from url, provided from the location header in the Create and Run PA calculation endpoint @@ -379,7 +379,7 @@ public interface IPACalculationsApiAsync : IApiAccessor /// Create or Update PA calculation and run it. /// /// - /// This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. /// /// Thrown when fails to make API call /// from url, provided from the location header in the Create and Run PA calculation endpoint @@ -1283,7 +1283,7 @@ public FactSet.AnalyticsAPI.Engines.Client.ApiResponse GetCalculatio } /// - /// Create and Run PA calculation This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Create and Run PA calculation This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. /// /// Thrown when fails to make API call /// Long running deadline in seconds when only one unit is passed in the POST body. (optional) @@ -1300,7 +1300,7 @@ public FactSet.AnalyticsAPI.Engines.Client.ApiResponse GetCalculatio } /// - /// Create and Run PA calculation This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Create and Run PA calculation This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. /// /// Thrown when fails to make API call /// Long running deadline in seconds when only one unit is passed in the POST body. (optional) @@ -1375,7 +1375,7 @@ public FactSet.AnalyticsAPI.Engines.Client.ApiResponse GetCalculatio } /// - /// Create and Run PA calculation This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Create and Run PA calculation This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. /// /// Thrown when fails to make API call /// Long running deadline in seconds when only one unit is passed in the POST body. (optional) @@ -1393,7 +1393,7 @@ public FactSet.AnalyticsAPI.Engines.Client.ApiResponse GetCalculatio } /// - /// Create and Run PA calculation This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Create and Run PA calculation This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. /// /// Thrown when fails to make API call /// Long running deadline in seconds when only one unit is passed in the POST body. (optional) @@ -1471,7 +1471,7 @@ public FactSet.AnalyticsAPI.Engines.Client.ApiResponse GetCalculatio } /// - /// Create or Update PA calculation and run it. This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Create or Update PA calculation and run it. This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. /// /// Thrown when fails to make API call /// from url, provided from the location header in the Create and Run PA calculation endpoint @@ -1489,7 +1489,7 @@ public FactSet.AnalyticsAPI.Engines.Client.ApiResponse GetCalculatio } /// - /// Create or Update PA calculation and run it. This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Create or Update PA calculation and run it. This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. /// /// Thrown when fails to make API call /// from url, provided from the location header in the Create and Run PA calculation endpoint @@ -1571,7 +1571,7 @@ public FactSet.AnalyticsAPI.Engines.Client.ApiResponse GetCalculatio } /// - /// Create or Update PA calculation and run it. This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Create or Update PA calculation and run it. This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. /// /// Thrown when fails to make API call /// from url, provided from the location header in the Create and Run PA calculation endpoint @@ -1590,7 +1590,7 @@ public FactSet.AnalyticsAPI.Engines.Client.ApiResponse GetCalculatio } /// - /// Create or Update PA calculation and run it. This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Create or Update PA calculation and run it. This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. /// /// Thrown when fails to make API call /// from url, provided from the location header in the Create and Run PA calculation endpoint diff --git a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/QuantCalculationsApi.cs b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/QuantCalculationsApi.cs index 955a38bc..3cf66c41 100644 --- a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/QuantCalculationsApi.cs +++ b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/QuantCalculationsApi.cs @@ -166,9 +166,9 @@ public interface IQuantCalculationsApiSync : IApiAccessor /// Thrown when fails to make API call /// Standard HTTP header. Accepts no-store, max-age, max-stale. (optional) /// (optional) - /// CalculationStatusRoot for 202 status - /// ObjectRoot for 201 status /// CalculationStatusRoot for 200 status + /// File for 201 status + /// CalculationStatusRoot for 202 status object PostAndCalculate(string cacheControl = default(string), QuantCalculationParametersRoot quantCalculationParametersRoot = default(QuantCalculationParametersRoot)); @@ -181,9 +181,9 @@ public interface IQuantCalculationsApiSync : IApiAccessor /// Thrown when fails to make API call /// Standard HTTP header. Accepts no-store, max-age, max-stale. (optional) /// (optional) - /// ApiResponse of CalculationStatusRoot for 202 status - /// ApiResponse of ObjectRoot for 201 status /// ApiResponse of CalculationStatusRoot for 200 status + /// ApiResponse of File for 201 status + /// ApiResponse of CalculationStatusRoot for 202 status ApiResponse PostAndCalculateWithHttpInfo(string cacheControl = default(string), QuantCalculationParametersRoot quantCalculationParametersRoot = default(QuantCalculationParametersRoot)); /// @@ -196,9 +196,9 @@ public interface IQuantCalculationsApiSync : IApiAccessor /// from url, provided from the location header in the Create and Run Quant Engine calculation endpoint /// Standard HTTP header. Accepts no-store, max-age, max-stale. (optional) /// Calculation Parameters (optional) - /// CalculationStatusRoot for 202 status /// CalculationStatusRoot for 200 status - /// ObjectRoot for 201 status + /// File for 201 status + /// CalculationStatusRoot for 202 status object PutAndCalculate(string id, string cacheControl = default(string), QuantCalculationParametersRoot quantCalculationParametersRoot = default(QuantCalculationParametersRoot)); @@ -212,9 +212,9 @@ public interface IQuantCalculationsApiSync : IApiAccessor /// from url, provided from the location header in the Create and Run Quant Engine calculation endpoint /// Standard HTTP header. Accepts no-store, max-age, max-stale. (optional) /// Calculation Parameters (optional) - /// ApiResponse of CalculationStatusRoot for 202 status /// ApiResponse of CalculationStatusRoot for 200 status - /// ApiResponse of ObjectRoot for 201 status + /// ApiResponse of File for 201 status + /// ApiResponse of CalculationStatusRoot for 202 status ApiResponse PutAndCalculateWithHttpInfo(string id, string cacheControl = default(string), QuantCalculationParametersRoot quantCalculationParametersRoot = default(QuantCalculationParametersRoot)); #endregion Synchronous Operations @@ -378,9 +378,9 @@ public interface IQuantCalculationsApiAsync : IApiAccessor /// Standard HTTP header. Accepts no-store, max-age, max-stale. (optional) /// (optional) /// Cancellation Token to cancel the request. - /// Task of CalculationStatusRoot for 202 status - /// Task of ObjectRoot for 201 status /// Task of CalculationStatusRoot for 200 status + /// Task of File for 201 status + /// Task of CalculationStatusRoot for 202 status System.Threading.Tasks.Task PostAndCalculateAsync(string cacheControl = default(string), QuantCalculationParametersRoot quantCalculationParametersRoot = default(QuantCalculationParametersRoot), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); @@ -394,9 +394,9 @@ public interface IQuantCalculationsApiAsync : IApiAccessor /// Standard HTTP header. Accepts no-store, max-age, max-stale. (optional) /// (optional) /// Cancellation Token to cancel the request. - /// Task of ApiResponse of CalculationStatusRoot for 202 status - /// Task of ApiResponse of ObjectRoot for 201 status /// Task of ApiResponse of CalculationStatusRoot for 200 status + /// Task of ApiResponse of File for 201 status + /// Task of ApiResponse of CalculationStatusRoot for 202 status System.Threading.Tasks.Task> PostAndCalculateWithHttpInfoAsync(string cacheControl = default(string), QuantCalculationParametersRoot quantCalculationParametersRoot = default(QuantCalculationParametersRoot), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// @@ -410,9 +410,9 @@ public interface IQuantCalculationsApiAsync : IApiAccessor /// Standard HTTP header. Accepts no-store, max-age, max-stale. (optional) /// Calculation Parameters (optional) /// Cancellation Token to cancel the request. - /// Task of CalculationStatusRoot for 202 status /// Task of CalculationStatusRoot for 200 status - /// Task of ObjectRoot for 201 status + /// Task of File for 201 status + /// Task of CalculationStatusRoot for 202 status System.Threading.Tasks.Task PutAndCalculateAsync(string id, string cacheControl = default(string), QuantCalculationParametersRoot quantCalculationParametersRoot = default(QuantCalculationParametersRoot), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); @@ -427,9 +427,9 @@ public interface IQuantCalculationsApiAsync : IApiAccessor /// Standard HTTP header. Accepts no-store, max-age, max-stale. (optional) /// Calculation Parameters (optional) /// Cancellation Token to cancel the request. - /// Task of ApiResponse of CalculationStatusRoot for 202 status /// Task of ApiResponse of CalculationStatusRoot for 200 status - /// Task of ApiResponse of ObjectRoot for 201 status + /// Task of ApiResponse of File for 201 status + /// Task of ApiResponse of CalculationStatusRoot for 202 status System.Threading.Tasks.Task> PutAndCalculateWithHttpInfoAsync(string id, string cacheControl = default(string), QuantCalculationParametersRoot quantCalculationParametersRoot = default(QuantCalculationParametersRoot), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); #endregion Asynchronous Operations @@ -1191,9 +1191,8 @@ public System.IO.Stream GetCalculationUnitInfoById(string id, string unitId) // to determine the Accept header String[] _accepts = new String[] { - "application/json", - "application/x-protobuf", - "application/octet-stream" + "application/octet-stream", + "application/json" }; localVarRequestOptions.ResponseReturnTypes = new Dictionary @@ -1277,9 +1276,8 @@ public System.IO.Stream GetCalculationUnitInfoById(string id, string unitId) // to determine the Accept header String[] _accepts = new String[] { - "application/json", - "application/x-protobuf", - "application/octet-stream" + "application/octet-stream", + "application/json" }; localVarRequestOptions.ResponseReturnTypes = new Dictionary @@ -1361,9 +1359,8 @@ public System.IO.Stream GetCalculationUnitResultById(string id, string unitId) // to determine the Accept header String[] _accepts = new String[] { - "application/json", - "application/x-protobuf", - "application/octet-stream" + "application/octet-stream", + "application/json" }; localVarRequestOptions.ResponseReturnTypes = new Dictionary @@ -1447,9 +1444,8 @@ public System.IO.Stream GetCalculationUnitResultById(string id, string unitId) // to determine the Accept header String[] _accepts = new String[] { - "application/json", - "application/x-protobuf", - "application/octet-stream" + "application/octet-stream", + "application/json" }; localVarRequestOptions.ResponseReturnTypes = new Dictionary @@ -1500,9 +1496,9 @@ public System.IO.Stream GetCalculationUnitResultById(string id, string unitId) /// Thrown when fails to make API call /// Standard HTTP header. Accepts no-store, max-age, max-stale. (optional) /// (optional) - /// CalculationStatusRoot for 202 status - /// ObjectRoot for 201 status /// CalculationStatusRoot for 200 status + /// File for 201 status + /// CalculationStatusRoot for 202 status public object PostAndCalculate(string cacheControl = default(string), QuantCalculationParametersRoot quantCalculationParametersRoot = default(QuantCalculationParametersRoot)) { @@ -1516,9 +1512,9 @@ public System.IO.Stream GetCalculationUnitResultById(string id, string unitId) /// Thrown when fails to make API call /// Standard HTTP header. Accepts no-store, max-age, max-stale. (optional) /// (optional) - /// ApiResponse of CalculationStatusRoot for 202 status - /// ApiResponse of ObjectRoot for 201 status /// ApiResponse of CalculationStatusRoot for 200 status + /// ApiResponse of File for 201 status + /// ApiResponse of CalculationStatusRoot for 202 status public FactSet.AnalyticsAPI.Engines.Client.ApiResponse PostAndCalculateWithHttpInfo(string cacheControl = default(string), QuantCalculationParametersRoot quantCalculationParametersRoot = default(QuantCalculationParametersRoot)) { @@ -1531,16 +1527,17 @@ public System.IO.Stream GetCalculationUnitResultById(string id, string unitId) // to determine the Accept header String[] _accepts = new String[] { "application/json", - "application/x-protobuf" + "application/octet-stream" }; localVarRequestOptions.ResponseReturnTypes = new Dictionary { - { 202, typeof(CalculationStatusRoot) }, - { 201, typeof(ObjectRoot) }, { 200, typeof(CalculationStatusRoot) }, + { 201, typeof(System.IO.Stream) }, + { 202, typeof(CalculationStatusRoot) }, { 400, typeof(ClientErrorResponse) }, { 404, typeof(ClientErrorResponse) }, + { 413, typeof(ClientErrorResponse) }, }; var localVarContentType = FactSet.AnalyticsAPI.Engines.Client.ClientUtils.SelectHeaderContentType(_contentTypes); @@ -1587,9 +1584,9 @@ public System.IO.Stream GetCalculationUnitResultById(string id, string unitId) /// Standard HTTP header. Accepts no-store, max-age, max-stale. (optional) /// (optional) /// Cancellation Token to cancel the request. - /// Task of CalculationStatusRoot for 202 status - /// Task of ObjectRoot for 201 status /// Task of CalculationStatusRoot for 200 status + /// Task of File for 201 status + /// Task of CalculationStatusRoot for 202 status public async System.Threading.Tasks.Task PostAndCalculateAsync(string cacheControl = default(string), QuantCalculationParametersRoot quantCalculationParametersRoot = default(QuantCalculationParametersRoot), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { @@ -1604,9 +1601,9 @@ public System.IO.Stream GetCalculationUnitResultById(string id, string unitId) /// Standard HTTP header. Accepts no-store, max-age, max-stale. (optional) /// (optional) /// Cancellation Token to cancel the request. - /// Task of ApiResponse of CalculationStatusRoot for 202 status - /// Task of ApiResponse of ObjectRoot for 201 status /// Task of ApiResponse of CalculationStatusRoot for 200 status + /// Task of ApiResponse of File for 201 status + /// Task of ApiResponse of CalculationStatusRoot for 202 status public async System.Threading.Tasks.Task> PostAndCalculateWithHttpInfoAsync(string cacheControl = default(string), QuantCalculationParametersRoot quantCalculationParametersRoot = default(QuantCalculationParametersRoot), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { @@ -1620,16 +1617,17 @@ public System.IO.Stream GetCalculationUnitResultById(string id, string unitId) // to determine the Accept header String[] _accepts = new String[] { "application/json", - "application/x-protobuf" + "application/octet-stream" }; localVarRequestOptions.ResponseReturnTypes = new Dictionary { - { 202, typeof(CalculationStatusRoot) }, - { 201, typeof(ObjectRoot) }, { 200, typeof(CalculationStatusRoot) }, + { 201, typeof(System.IO.Stream) }, + { 202, typeof(CalculationStatusRoot) }, { 400, typeof(ClientErrorResponse) }, { 404, typeof(ClientErrorResponse) }, + { 413, typeof(ClientErrorResponse) }, }; var localVarContentType = FactSet.AnalyticsAPI.Engines.Client.ClientUtils.SelectHeaderContentType(_contentTypes); @@ -1677,9 +1675,9 @@ public System.IO.Stream GetCalculationUnitResultById(string id, string unitId) /// from url, provided from the location header in the Create and Run Quant Engine calculation endpoint /// Standard HTTP header. Accepts no-store, max-age, max-stale. (optional) /// Calculation Parameters (optional) - /// CalculationStatusRoot for 202 status /// CalculationStatusRoot for 200 status - /// ObjectRoot for 201 status + /// File for 201 status + /// CalculationStatusRoot for 202 status public object PutAndCalculate(string id, string cacheControl = default(string), QuantCalculationParametersRoot quantCalculationParametersRoot = default(QuantCalculationParametersRoot)) { @@ -1694,9 +1692,9 @@ public System.IO.Stream GetCalculationUnitResultById(string id, string unitId) /// from url, provided from the location header in the Create and Run Quant Engine calculation endpoint /// Standard HTTP header. Accepts no-store, max-age, max-stale. (optional) /// Calculation Parameters (optional) - /// ApiResponse of CalculationStatusRoot for 202 status /// ApiResponse of CalculationStatusRoot for 200 status - /// ApiResponse of ObjectRoot for 201 status + /// ApiResponse of File for 201 status + /// ApiResponse of CalculationStatusRoot for 202 status public FactSet.AnalyticsAPI.Engines.Client.ApiResponse PutAndCalculateWithHttpInfo(string id, string cacheControl = default(string), QuantCalculationParametersRoot quantCalculationParametersRoot = default(QuantCalculationParametersRoot)) { @@ -1713,17 +1711,18 @@ public System.IO.Stream GetCalculationUnitResultById(string id, string unitId) // to determine the Accept header String[] _accepts = new String[] { "application/json", - "application/x-protobuf" + "application/octet-stream" }; localVarRequestOptions.ResponseReturnTypes = new Dictionary { - { 202, typeof(CalculationStatusRoot) }, { 200, typeof(CalculationStatusRoot) }, - { 201, typeof(ObjectRoot) }, + { 201, typeof(System.IO.Stream) }, + { 202, typeof(CalculationStatusRoot) }, { 400, typeof(ClientErrorResponse) }, { 404, typeof(ClientErrorResponse) }, { 409, typeof(ClientErrorResponse) }, + { 413, typeof(ClientErrorResponse) }, }; var localVarContentType = FactSet.AnalyticsAPI.Engines.Client.ClientUtils.SelectHeaderContentType(_contentTypes); @@ -1772,9 +1771,9 @@ public System.IO.Stream GetCalculationUnitResultById(string id, string unitId) /// Standard HTTP header. Accepts no-store, max-age, max-stale. (optional) /// Calculation Parameters (optional) /// Cancellation Token to cancel the request. - /// Task of CalculationStatusRoot for 202 status /// Task of CalculationStatusRoot for 200 status - /// Task of ObjectRoot for 201 status + /// Task of File for 201 status + /// Task of CalculationStatusRoot for 202 status public async System.Threading.Tasks.Task PutAndCalculateAsync(string id, string cacheControl = default(string), QuantCalculationParametersRoot quantCalculationParametersRoot = default(QuantCalculationParametersRoot), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { @@ -1790,9 +1789,9 @@ public System.IO.Stream GetCalculationUnitResultById(string id, string unitId) /// Standard HTTP header. Accepts no-store, max-age, max-stale. (optional) /// Calculation Parameters (optional) /// Cancellation Token to cancel the request. - /// Task of ApiResponse of CalculationStatusRoot for 202 status /// Task of ApiResponse of CalculationStatusRoot for 200 status - /// Task of ApiResponse of ObjectRoot for 201 status + /// Task of ApiResponse of File for 201 status + /// Task of ApiResponse of CalculationStatusRoot for 202 status public async System.Threading.Tasks.Task> PutAndCalculateWithHttpInfoAsync(string id, string cacheControl = default(string), QuantCalculationParametersRoot quantCalculationParametersRoot = default(QuantCalculationParametersRoot), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { @@ -1810,17 +1809,18 @@ public System.IO.Stream GetCalculationUnitResultById(string id, string unitId) // to determine the Accept header String[] _accepts = new String[] { "application/json", - "application/x-protobuf" + "application/octet-stream" }; localVarRequestOptions.ResponseReturnTypes = new Dictionary { - { 202, typeof(CalculationStatusRoot) }, { 200, typeof(CalculationStatusRoot) }, - { 201, typeof(ObjectRoot) }, + { 201, typeof(System.IO.Stream) }, + { 202, typeof(CalculationStatusRoot) }, { 400, typeof(ClientErrorResponse) }, { 404, typeof(ClientErrorResponse) }, { 409, typeof(ClientErrorResponse) }, + { 413, typeof(ClientErrorResponse) }, }; var localVarContentType = FactSet.AnalyticsAPI.Engines.Client.ClientUtils.SelectHeaderContentType(_contentTypes); diff --git a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/TemplatedPAComponentsApi.cs b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/TemplatedPAComponentsApi.cs index 9c6cdd3f..84af96eb 100644 --- a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/TemplatedPAComponentsApi.cs +++ b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/TemplatedPAComponentsApi.cs @@ -31,7 +31,7 @@ public interface ITemplatedPAComponentsApiSync : IApiAccessor /// Create templated PA component /// /// - /// This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Request Parameters @@ -42,7 +42,7 @@ public interface ITemplatedPAComponentsApiSync : IApiAccessor /// Create templated PA component /// /// - /// This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Request Parameters @@ -115,7 +115,7 @@ public interface ITemplatedPAComponentsApiSync : IApiAccessor /// Update templated PA component /// /// - /// This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Unique identifier for a templated PA component @@ -127,7 +127,7 @@ public interface ITemplatedPAComponentsApiSync : IApiAccessor /// Update templated PA component /// /// - /// This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Unique identifier for a templated PA component @@ -147,7 +147,7 @@ public interface ITemplatedPAComponentsApiAsync : IApiAccessor /// Create templated PA component /// /// - /// This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Request Parameters @@ -159,7 +159,7 @@ public interface ITemplatedPAComponentsApiAsync : IApiAccessor /// Create templated PA component /// /// - /// This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Request Parameters @@ -239,7 +239,7 @@ public interface ITemplatedPAComponentsApiAsync : IApiAccessor /// Update templated PA component /// /// - /// This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Unique identifier for a templated PA component @@ -252,7 +252,7 @@ public interface ITemplatedPAComponentsApiAsync : IApiAccessor /// Update templated PA component /// /// - /// This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Unique identifier for a templated PA component @@ -381,7 +381,7 @@ public FactSet.AnalyticsAPI.Engines.Client.ExceptionFactory ExceptionFactory } /// - /// Create templated PA component This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Create templated PA component This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Request Parameters @@ -393,7 +393,7 @@ public TemplatedPAComponentPostSummaryRoot CreateTemplatedPAComponents(Templated } /// - /// Create templated PA component This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Create templated PA component This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Request Parameters @@ -457,7 +457,7 @@ public FactSet.AnalyticsAPI.Engines.Client.ApiResponse - /// Create templated PA component This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Create templated PA component This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Request Parameters @@ -470,7 +470,7 @@ public FactSet.AnalyticsAPI.Engines.Client.ApiResponse - /// Create templated PA component This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Create templated PA component This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Request Parameters @@ -991,7 +991,7 @@ public FactSet.AnalyticsAPI.Engines.Client.ApiResponse - /// Update templated PA component This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Update templated PA component This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Unique identifier for a templated PA component @@ -1004,7 +1004,7 @@ public TemplatedPAComponentPostSummaryRoot UpdateTemplatedPAComponents(string id } /// - /// Update templated PA component This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Update templated PA component This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Unique identifier for a templated PA component @@ -1073,7 +1073,7 @@ public FactSet.AnalyticsAPI.Engines.Client.ApiResponse - /// Update templated PA component This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Update templated PA component This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Unique identifier for a templated PA component @@ -1087,7 +1087,7 @@ public FactSet.AnalyticsAPI.Engines.Client.ApiResponse - /// Update templated PA component This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Update templated PA component This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Unique identifier for a templated PA component diff --git a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/UnlinkedPATemplatesApi.cs b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/UnlinkedPATemplatesApi.cs index 30f5f6ef..d44294a2 100644 --- a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/UnlinkedPATemplatesApi.cs +++ b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/UnlinkedPATemplatesApi.cs @@ -31,7 +31,7 @@ public interface IUnlinkedPATemplatesApiSync : IApiAccessor /// Create unlinked PA template /// /// - /// This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Request Parameters @@ -42,7 +42,7 @@ public interface IUnlinkedPATemplatesApiSync : IApiAccessor /// Create unlinked PA template /// /// - /// This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Request Parameters @@ -157,7 +157,7 @@ public interface IUnlinkedPATemplatesApiSync : IApiAccessor /// Update unlinked PA template /// /// - /// This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Unique identifier for an unlinked PA template @@ -169,7 +169,7 @@ public interface IUnlinkedPATemplatesApiSync : IApiAccessor /// Update unlinked PA template /// /// - /// This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Unique identifier for an unlinked PA template @@ -189,7 +189,7 @@ public interface IUnlinkedPATemplatesApiAsync : IApiAccessor /// Create unlinked PA template /// /// - /// This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Request Parameters @@ -201,7 +201,7 @@ public interface IUnlinkedPATemplatesApiAsync : IApiAccessor /// Create unlinked PA template /// /// - /// This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Request Parameters @@ -327,7 +327,7 @@ public interface IUnlinkedPATemplatesApiAsync : IApiAccessor /// Update unlinked PA template /// /// - /// This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Unique identifier for an unlinked PA template @@ -340,7 +340,7 @@ public interface IUnlinkedPATemplatesApiAsync : IApiAccessor /// Update unlinked PA template /// /// - /// This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Unique identifier for an unlinked PA template @@ -469,7 +469,7 @@ public FactSet.AnalyticsAPI.Engines.Client.ExceptionFactory ExceptionFactory } /// - /// Create unlinked PA template This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Create unlinked PA template This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Request Parameters @@ -481,7 +481,7 @@ public UnlinkedPATemplatePostSummaryRoot CreateUnlinkedPATemplates(UnlinkedPATem } /// - /// Create unlinked PA template This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Create unlinked PA template This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Request Parameters @@ -543,7 +543,7 @@ public FactSet.AnalyticsAPI.Engines.Client.ApiResponse - /// Create unlinked PA template This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Create unlinked PA template This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Request Parameters @@ -556,7 +556,7 @@ public FactSet.AnalyticsAPI.Engines.Client.ApiResponse - /// Create unlinked PA template This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Create unlinked PA template This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Request Parameters @@ -1367,7 +1367,7 @@ public FactSet.AnalyticsAPI.Engines.Client.ApiResponse G } /// - /// Update unlinked PA template This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Update unlinked PA template This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Unique identifier for an unlinked PA template @@ -1380,7 +1380,7 @@ public UnlinkedPATemplatePostSummaryRoot UpdateUnlinkedPATemplates(string id, Un } /// - /// Update unlinked PA template This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Update unlinked PA template This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Unique identifier for an unlinked PA template @@ -1449,7 +1449,7 @@ public FactSet.AnalyticsAPI.Engines.Client.ApiResponse - /// Update unlinked PA template This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Update unlinked PA template This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Unique identifier for an unlinked PA template @@ -1463,7 +1463,7 @@ public FactSet.AnalyticsAPI.Engines.Client.ApiResponse - /// Update unlinked PA template This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, and totals as well but if we don't pass anything that defaults to securities. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + /// Update unlinked PA template This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding gouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. /// /// Thrown when fails to make API call /// Unique identifier for an unlinked PA template diff --git a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/VaultAttributionLoaderApi.cs b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/VaultAttributionLoaderApi.cs new file mode 100644 index 00000000..6309833e --- /dev/null +++ b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Api/VaultAttributionLoaderApi.cs @@ -0,0 +1,372 @@ +/* + * Engines API + * + * Allow clients to fetch Analytics through APIs. + * + * The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + * Contact: api@factset.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Net; +using System.Net.Mime; +using FactSet.AnalyticsAPI.Engines.Client; +using FactSet.AnalyticsAPI.Engines.Model; + +namespace FactSet.AnalyticsAPI.Engines.Api +{ + + /// + /// Represents a collection of functions to interact with the API endpoints + /// + public interface IVaultAttributionLoaderApiSync : IApiAccessor + { + #region Synchronous Operations + /// + /// Vault - External Attribution Loader + /// + /// + /// This endpoint loads Vault External Attributions. + /// + /// Thrown when fails to make API call + /// + /// (optional) + /// VaultAttributionLoaderResponseRoot + VaultAttributionLoaderResponseRoot VaultAttributionLoader(string batchId, System.IO.Stream file = default(System.IO.Stream)); + + /// + /// Vault - External Attribution Loader + /// + /// + /// This endpoint loads Vault External Attributions. + /// + /// Thrown when fails to make API call + /// + /// (optional) + /// ApiResponse of VaultAttributionLoaderResponseRoot + ApiResponse VaultAttributionLoaderWithHttpInfo(string batchId, System.IO.Stream file = default(System.IO.Stream)); + #endregion Synchronous Operations + } + + /// + /// Represents a collection of functions to interact with the API endpoints + /// + public interface IVaultAttributionLoaderApiAsync : IApiAccessor + { + #region Asynchronous Operations + /// + /// Vault - External Attribution Loader + /// + /// + /// This endpoint loads Vault External Attributions. + /// + /// Thrown when fails to make API call + /// + /// (optional) + /// Cancellation Token to cancel the request. + /// Task of VaultAttributionLoaderResponseRoot + System.Threading.Tasks.Task VaultAttributionLoaderAsync(string batchId, System.IO.Stream file = default(System.IO.Stream), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + + /// + /// Vault - External Attribution Loader + /// + /// + /// This endpoint loads Vault External Attributions. + /// + /// Thrown when fails to make API call + /// + /// (optional) + /// Cancellation Token to cancel the request. + /// Task of ApiResponse of VaultAttributionLoaderResponseRoot + System.Threading.Tasks.Task> VaultAttributionLoaderWithHttpInfoAsync(string batchId, System.IO.Stream file = default(System.IO.Stream), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + #endregion Asynchronous Operations + } + + /// + /// Represents a collection of functions to interact with the API endpoints + /// + public interface IVaultAttributionLoaderApi : IVaultAttributionLoaderApiSync, IVaultAttributionLoaderApiAsync + { + + } + + /// + /// Represents a collection of functions to interact with the API endpoints + /// + public partial class VaultAttributionLoaderApi : IVaultAttributionLoaderApi + { + private FactSet.AnalyticsAPI.Engines.Client.ExceptionFactory _exceptionFactory = (name, response) => null; + + /// + /// Initializes a new instance of the class. + /// + /// + public VaultAttributionLoaderApi() : this((string)null) + { + } + + /// + /// Initializes a new instance of the class. + /// + /// + public VaultAttributionLoaderApi(String basePath) + { + this.Configuration = FactSet.AnalyticsAPI.Engines.Client.Configuration.MergeConfigurations( + FactSet.AnalyticsAPI.Engines.Client.GlobalConfiguration.Instance, + new FactSet.AnalyticsAPI.Engines.Client.Configuration { BasePath = basePath } + ); + this.Client = new FactSet.AnalyticsAPI.Engines.Client.ApiClient(this.Configuration.BasePath); + this.AsynchronousClient = new FactSet.AnalyticsAPI.Engines.Client.ApiClient(this.Configuration.BasePath); + this.ExceptionFactory = FactSet.AnalyticsAPI.Engines.Client.Configuration.DefaultExceptionFactory; + } + + /// + /// Initializes a new instance of the class + /// using Configuration object + /// + /// An instance of Configuration + /// + public VaultAttributionLoaderApi(FactSet.AnalyticsAPI.Engines.Client.Configuration configuration) + { + if (configuration == null) throw new ArgumentNullException("configuration"); + + this.Configuration = FactSet.AnalyticsAPI.Engines.Client.Configuration.MergeConfigurations( + FactSet.AnalyticsAPI.Engines.Client.GlobalConfiguration.Instance, + configuration + ); + this.Client = new FactSet.AnalyticsAPI.Engines.Client.ApiClient(this.Configuration.BasePath); + this.AsynchronousClient = new FactSet.AnalyticsAPI.Engines.Client.ApiClient(this.Configuration.BasePath); + ExceptionFactory = FactSet.AnalyticsAPI.Engines.Client.Configuration.DefaultExceptionFactory; + } + + /// + /// Initializes a new instance of the class + /// using a Configuration object and client instance. + /// + /// The client interface for synchronous API access. + /// The client interface for asynchronous API access. + /// The configuration object. + public VaultAttributionLoaderApi(FactSet.AnalyticsAPI.Engines.Client.ISynchronousClient client, FactSet.AnalyticsAPI.Engines.Client.IAsynchronousClient asyncClient, FactSet.AnalyticsAPI.Engines.Client.IReadableConfiguration configuration) + { + if (client == null) throw new ArgumentNullException("client"); + if (asyncClient == null) throw new ArgumentNullException("asyncClient"); + if (configuration == null) throw new ArgumentNullException("configuration"); + + this.Client = client; + this.AsynchronousClient = asyncClient; + this.Configuration = configuration; + this.ExceptionFactory = FactSet.AnalyticsAPI.Engines.Client.Configuration.DefaultExceptionFactory; + } + + /// + /// The client for accessing this underlying API asynchronously. + /// + public FactSet.AnalyticsAPI.Engines.Client.IAsynchronousClient AsynchronousClient { get; set; } + + /// + /// The client for accessing this underlying API synchronously. + /// + public FactSet.AnalyticsAPI.Engines.Client.ISynchronousClient Client { get; set; } + + /// + /// Gets the base path of the API client. + /// + /// The base path + public String GetBasePath() + { + return this.Configuration.BasePath; + } + + /// + /// Gets or sets the configuration object + /// + /// An instance of the Configuration + public FactSet.AnalyticsAPI.Engines.Client.IReadableConfiguration Configuration { get; set; } + + /// + /// Provides a factory method hook for the creation of exceptions. + /// + public FactSet.AnalyticsAPI.Engines.Client.ExceptionFactory ExceptionFactory + { + get + { + if (_exceptionFactory != null && _exceptionFactory.GetInvocationList().Length > 1) + { + throw new InvalidOperationException("Multicast delegate for ExceptionFactory is unsupported."); + } + return _exceptionFactory; + } + set { _exceptionFactory = value; } + } + + /// + /// Vault - External Attribution Loader This endpoint loads Vault External Attributions. + /// + /// Thrown when fails to make API call + /// + /// (optional) + /// VaultAttributionLoaderResponseRoot + public VaultAttributionLoaderResponseRoot VaultAttributionLoader(string batchId, System.IO.Stream file = default(System.IO.Stream)) + { + FactSet.AnalyticsAPI.Engines.Client.ApiResponse localVarResponse = VaultAttributionLoaderWithHttpInfo(batchId, file); + return localVarResponse.Data; + } + + /// + /// Vault - External Attribution Loader This endpoint loads Vault External Attributions. + /// + /// Thrown when fails to make API call + /// + /// (optional) + /// ApiResponse of VaultAttributionLoaderResponseRoot + public FactSet.AnalyticsAPI.Engines.Client.ApiResponse VaultAttributionLoaderWithHttpInfo(string batchId, System.IO.Stream file = default(System.IO.Stream)) + { + // verify the required parameter 'batchId' is set + if (batchId == null) + throw new FactSet.AnalyticsAPI.Engines.Client.ApiException(400, "Missing required parameter 'batchId' when calling VaultAttributionLoaderApi->VaultAttributionLoader"); + + FactSet.AnalyticsAPI.Engines.Client.RequestOptions localVarRequestOptions = new FactSet.AnalyticsAPI.Engines.Client.RequestOptions(); + + String[] _contentTypes = new String[] { + "multipart/form-data" + }; + + // to determine the Accept header + String[] _accepts = new String[] { + "application/json" + }; + + localVarRequestOptions.ResponseReturnTypes = new Dictionary + { + { 200, typeof(VaultAttributionLoaderResponseRoot) }, + { 400, typeof(ClientErrorResponse) }, + }; + + var localVarContentType = FactSet.AnalyticsAPI.Engines.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + if (localVarContentType != null) localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + + var localVarAccept = FactSet.AnalyticsAPI.Engines.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + + localVarRequestOptions.PathParameters.Add("batchId", FactSet.AnalyticsAPI.Engines.Client.ClientUtils.ParameterToString(batchId)); // path parameter + if (file != null) + { + localVarRequestOptions.FileParameters.Add("file", file); + } + + // authentication (Basic) required + // http basic authentication required + if (!String.IsNullOrEmpty(this.Configuration.Username) || !String.IsNullOrEmpty(this.Configuration.Password)) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + FactSet.AnalyticsAPI.Engines.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + // authentication (Bearer) required + // bearer authentication required + if (!String.IsNullOrEmpty(this.Configuration.AccessToken)) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Bearer " + this.Configuration.AccessToken); + } + + // make the HTTP request + var localVarResponse = this.Client.Post("/analytics/engines/vault/v3/load/{batchId}", localVarRequestOptions, this.Configuration); + + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("VaultAttributionLoader", localVarResponse); + if (_exception != null) throw _exception; + } + + return localVarResponse; + } + + /// + /// Vault - External Attribution Loader This endpoint loads Vault External Attributions. + /// + /// Thrown when fails to make API call + /// + /// (optional) + /// Cancellation Token to cancel the request. + /// Task of VaultAttributionLoaderResponseRoot + public async System.Threading.Tasks.Task VaultAttributionLoaderAsync(string batchId, System.IO.Stream file = default(System.IO.Stream), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + { + FactSet.AnalyticsAPI.Engines.Client.ApiResponse localVarResponse = await VaultAttributionLoaderWithHttpInfoAsync(batchId, file, cancellationToken).ConfigureAwait(false); + return localVarResponse.Data; + } + + /// + /// Vault - External Attribution Loader This endpoint loads Vault External Attributions. + /// + /// Thrown when fails to make API call + /// + /// (optional) + /// Cancellation Token to cancel the request. + /// Task of ApiResponse of VaultAttributionLoaderResponseRoot + public async System.Threading.Tasks.Task> VaultAttributionLoaderWithHttpInfoAsync(string batchId, System.IO.Stream file = default(System.IO.Stream), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + { + // verify the required parameter 'batchId' is set + if (batchId == null) + throw new FactSet.AnalyticsAPI.Engines.Client.ApiException(400, "Missing required parameter 'batchId' when calling VaultAttributionLoaderApi->VaultAttributionLoader"); + + + FactSet.AnalyticsAPI.Engines.Client.RequestOptions localVarRequestOptions = new FactSet.AnalyticsAPI.Engines.Client.RequestOptions(); + + String[] _contentTypes = new String[] { + "multipart/form-data" + }; + + // to determine the Accept header + String[] _accepts = new String[] { + "application/json" + }; + + localVarRequestOptions.ResponseReturnTypes = new Dictionary + { + { 200, typeof(VaultAttributionLoaderResponseRoot) }, + { 400, typeof(ClientErrorResponse) }, + }; + + var localVarContentType = FactSet.AnalyticsAPI.Engines.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + if (localVarContentType != null) localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + + var localVarAccept = FactSet.AnalyticsAPI.Engines.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + + localVarRequestOptions.PathParameters.Add("batchId", FactSet.AnalyticsAPI.Engines.Client.ClientUtils.ParameterToString(batchId)); // path parameter + if (file != null) + { + localVarRequestOptions.FileParameters.Add("file", file); + } + + // authentication (Basic) required + // http basic authentication required + if (!String.IsNullOrEmpty(this.Configuration.Username) || !String.IsNullOrEmpty(this.Configuration.Password)) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + FactSet.AnalyticsAPI.Engines.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + // authentication (Bearer) required + // bearer authentication required + if (!String.IsNullOrEmpty(this.Configuration.AccessToken)) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Bearer " + this.Configuration.AccessToken); + } + + // make the HTTP request + + var localVarResponse = await this.AsynchronousClient.PostAsync("/analytics/engines/vault/v3/load/{batchId}", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); + + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("VaultAttributionLoader", localVarResponse); + if (_exception != null) throw _exception; + } + + return localVarResponse; + } + + } +} \ No newline at end of file diff --git a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/CalculationUnitStatus.cs b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/CalculationUnitStatus.cs index 394f16e1..257d5bd7 100644 --- a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/CalculationUnitStatus.cs +++ b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/CalculationUnitStatus.cs @@ -85,13 +85,15 @@ public enum StatusEnum /// The result URL of the calculation.. /// The progress of the calculation unit.. /// The points for the calculation unit.. - public CalculationUnitStatus(StatusEnum? status = default(StatusEnum?), List errors = default(List), string result = default(string), string progress = default(string), int points = default(int)) + /// The warnings in a calculation unit.. + public CalculationUnitStatus(StatusEnum? status = default(StatusEnum?), List errors = default(List), string result = default(string), string progress = default(string), int points = default(int), List warnings = default(List)) { this.Status = status; this.Errors = errors; this.Result = result; this.Progress = progress; this.Points = points; + this.Warnings = warnings; } /// @@ -122,6 +124,13 @@ public enum StatusEnum [DataMember(Name = "points", EmitDefaultValue = false)] public int Points { get; set; } + /// + /// The warnings in a calculation unit. + /// + /// The warnings in a calculation unit. + [DataMember(Name = "warnings", EmitDefaultValue = false)] + public List Warnings { get; set; } + /// /// Returns the string presentation of the object /// @@ -135,6 +144,7 @@ public override string ToString() sb.Append(" Result: ").Append(Result).Append("\n"); sb.Append(" Progress: ").Append(Progress).Append("\n"); sb.Append(" Points: ").Append(Points).Append("\n"); + sb.Append(" Warnings: ").Append(Warnings).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -192,6 +202,12 @@ public bool Equals(CalculationUnitStatus input) ( this.Points == input.Points || this.Points.Equals(input.Points) + ) && + ( + this.Warnings == input.Warnings || + this.Warnings != null && + input.Warnings != null && + this.Warnings.SequenceEqual(input.Warnings) ); } @@ -212,6 +228,8 @@ public override int GetHashCode() if (this.Progress != null) hashCode = hashCode * 59 + this.Progress.GetHashCode(); hashCode = hashCode * 59 + this.Points.GetHashCode(); + if (this.Warnings != null) + hashCode = hashCode * 59 + this.Warnings.GetHashCode(); return hashCode; } } diff --git a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/Error.cs b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/Error.cs index 690a03d3..7a532e48 100644 --- a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/Error.cs +++ b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/Error.cs @@ -36,11 +36,15 @@ public partial class Error : IEquatable, IValidatableObject /// Initializes a new instance of the class. /// /// id. + /// code. + /// title. /// detail. /// source. - public Error(string id = default(string), string detail = default(string), ErrorSource source = default(ErrorSource)) + public Error(string id = default(string), string code = default(string), string title = default(string), string detail = default(string), ErrorSource source = default(ErrorSource)) { this.Id = id; + this.Code = code; + this.Title = title; this.Detail = detail; this.Source = source; } @@ -51,6 +55,18 @@ public partial class Error : IEquatable, IValidatableObject [DataMember(Name = "id", EmitDefaultValue = false)] public string Id { get; set; } + /// + /// Gets or Sets Code + /// + [DataMember(Name = "code", EmitDefaultValue = false)] + public string Code { get; set; } + + /// + /// Gets or Sets Title + /// + [DataMember(Name = "title", EmitDefaultValue = false)] + public string Title { get; set; } + /// /// Gets or Sets Detail /// @@ -72,6 +88,8 @@ public override string ToString() var sb = new StringBuilder(); sb.Append("class Error {\n"); sb.Append(" Id: ").Append(Id).Append("\n"); + sb.Append(" Code: ").Append(Code).Append("\n"); + sb.Append(" Title: ").Append(Title).Append("\n"); sb.Append(" Detail: ").Append(Detail).Append("\n"); sb.Append(" Source: ").Append(Source).Append("\n"); sb.Append("}\n"); @@ -113,6 +131,16 @@ public bool Equals(Error input) (this.Id != null && this.Id.Equals(input.Id)) ) && + ( + this.Code == input.Code || + (this.Code != null && + this.Code.Equals(input.Code)) + ) && + ( + this.Title == input.Title || + (this.Title != null && + this.Title.Equals(input.Title)) + ) && ( this.Detail == input.Detail || (this.Detail != null && @@ -136,6 +164,10 @@ public override int GetHashCode() int hashCode = 41; if (this.Id != null) hashCode = hashCode * 59 + this.Id.GetHashCode(); + if (this.Code != null) + hashCode = hashCode * 59 + this.Code.GetHashCode(); + if (this.Title != null) + hashCode = hashCode * 59 + this.Title.GetHashCode(); if (this.Detail != null) hashCode = hashCode * 59 + this.Detail.GetHashCode(); if (this.Source != null) diff --git a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/FIAttributionForJobSettings.cs b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/FIAttributionForJobSettings.cs new file mode 100644 index 00000000..20908655 --- /dev/null +++ b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/FIAttributionForJobSettings.cs @@ -0,0 +1,144 @@ +/* + * Engines API + * + * Allow clients to fetch Analytics through APIs. + * + * The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + * Contact: api@factset.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = FactSet.AnalyticsAPI.Engines.Client.OpenAPIDateConverter; + +namespace FactSet.AnalyticsAPI.Engines.Model +{ + /// + /// FIAttributionForJobSettings + /// + [DataContract(Name = "FIAttributionForJobSettings")] + public partial class FIAttributionForJobSettings : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + /// Start Date. + /// End Date. + public FIAttributionForJobSettings(string startDate = default(string), string endDate = default(string)) + { + this.StartDate = startDate; + this.EndDate = endDate; + } + + /// + /// Start Date + /// + /// Start Date + [DataMember(Name = "startDate", EmitDefaultValue = false)] + public string StartDate { get; set; } + + /// + /// End Date + /// + /// End Date + [DataMember(Name = "endDate", EmitDefaultValue = false)] + public string EndDate { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class FIAttributionForJobSettings {\n"); + sb.Append(" StartDate: ").Append(StartDate).Append("\n"); + sb.Append(" EndDate: ").Append(EndDate).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as FIAttributionForJobSettings); + } + + /// + /// Returns true if FIAttributionForJobSettings instances are equal + /// + /// Instance of FIAttributionForJobSettings to be compared + /// Boolean + public bool Equals(FIAttributionForJobSettings input) + { + if (input == null) + return false; + + return + ( + this.StartDate == input.StartDate || + (this.StartDate != null && + this.StartDate.Equals(input.StartDate)) + ) && + ( + this.EndDate == input.EndDate || + (this.EndDate != null && + this.EndDate.Equals(input.EndDate)) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.StartDate != null) + hashCode = hashCode * 59 + this.StartDate.GetHashCode(); + if (this.EndDate != null) + hashCode = hashCode * 59 + this.EndDate.GetHashCode(); + return hashCode; + } + } + + /// + /// To validate all properties of the instance + /// + /// Validation context + /// Validation Result + IEnumerable IValidatableObject.Validate(ValidationContext validationContext) + { + yield break; + } + } + +} diff --git a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/FIAttributionForSecurities.cs b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/FIAttributionForSecurities.cs new file mode 100644 index 00000000..164a694d --- /dev/null +++ b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/FIAttributionForSecurities.cs @@ -0,0 +1,217 @@ +/* + * Engines API + * + * Allow clients to fetch Analytics through APIs. + * + * The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + * Contact: api@factset.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = FactSet.AnalyticsAPI.Engines.Client.OpenAPIDateConverter; + +namespace FactSet.AnalyticsAPI.Engines.Model +{ + /// + /// FIAttributionForSecurities + /// + [DataContract(Name = "FIAttributionForSecurities")] + public partial class FIAttributionForSecurities : IEquatable, IValidatableObject + { + /// + /// Pricing Method + /// + /// Pricing Method + [JsonConverter(typeof(StringEnumConverter))] + public enum PricingMethodEnum + { + /// + /// Enum InputtedPrice for value: Inputted Price + /// + [EnumMember(Value = "Inputted Price")] + InputtedPrice = 1, + + /// + /// Enum PricingMatrix for value: Pricing Matrix + /// + [EnumMember(Value = "Pricing Matrix")] + PricingMatrix = 2, + + /// + /// Enum ActualSpread for value: Actual Spread + /// + [EnumMember(Value = "Actual Spread")] + ActualSpread = 3, + + /// + /// Enum OAS for value: OAS + /// + [EnumMember(Value = "OAS")] + OAS = 4 + + } + + /// + /// Pricing Method + /// + /// Pricing Method + [DataMember(Name = "pricingMethod", EmitDefaultValue = false)] + public PricingMethodEnum? PricingMethod { get; set; } + /// + /// Initializes a new instance of the class. + /// + /// Start Price. + /// End Price. + /// Start Spread. + /// End Spread. + /// Pricing Method. + public FIAttributionForSecurities(double startPrice = default(double), double endPrice = default(double), double startSpread = default(double), double endSpread = default(double), PricingMethodEnum? pricingMethod = default(PricingMethodEnum?)) + { + this.StartPrice = startPrice; + this.EndPrice = endPrice; + this.StartSpread = startSpread; + this.EndSpread = endSpread; + this.PricingMethod = pricingMethod; + } + + /// + /// Start Price + /// + /// Start Price + [DataMember(Name = "startPrice", EmitDefaultValue = false)] + public double StartPrice { get; set; } + + /// + /// End Price + /// + /// End Price + [DataMember(Name = "endPrice", EmitDefaultValue = false)] + public double EndPrice { get; set; } + + /// + /// Start Spread + /// + /// Start Spread + [DataMember(Name = "startSpread", EmitDefaultValue = false)] + public double StartSpread { get; set; } + + /// + /// End Spread + /// + /// End Spread + [DataMember(Name = "endSpread", EmitDefaultValue = false)] + public double EndSpread { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class FIAttributionForSecurities {\n"); + sb.Append(" StartPrice: ").Append(StartPrice).Append("\n"); + sb.Append(" EndPrice: ").Append(EndPrice).Append("\n"); + sb.Append(" StartSpread: ").Append(StartSpread).Append("\n"); + sb.Append(" EndSpread: ").Append(EndSpread).Append("\n"); + sb.Append(" PricingMethod: ").Append(PricingMethod).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as FIAttributionForSecurities); + } + + /// + /// Returns true if FIAttributionForSecurities instances are equal + /// + /// Instance of FIAttributionForSecurities to be compared + /// Boolean + public bool Equals(FIAttributionForSecurities input) + { + if (input == null) + return false; + + return + ( + this.StartPrice == input.StartPrice || + this.StartPrice.Equals(input.StartPrice) + ) && + ( + this.EndPrice == input.EndPrice || + this.EndPrice.Equals(input.EndPrice) + ) && + ( + this.StartSpread == input.StartSpread || + this.StartSpread.Equals(input.StartSpread) + ) && + ( + this.EndSpread == input.EndSpread || + this.EndSpread.Equals(input.EndSpread) + ) && + ( + this.PricingMethod == input.PricingMethod || + this.PricingMethod.Equals(input.PricingMethod) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + hashCode = hashCode * 59 + this.StartPrice.GetHashCode(); + hashCode = hashCode * 59 + this.EndPrice.GetHashCode(); + hashCode = hashCode * 59 + this.StartSpread.GetHashCode(); + hashCode = hashCode * 59 + this.EndSpread.GetHashCode(); + hashCode = hashCode * 59 + this.PricingMethod.GetHashCode(); + return hashCode; + } + } + + /// + /// To validate all properties of the instance + /// + /// Validation context + /// Validation Result + IEnumerable IValidatableObject.Validate(ValidationContext validationContext) + { + yield break; + } + } + +} diff --git a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/FIJobSettings.cs b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/FIJobSettings.cs index 5c249985..24cdd89a 100644 --- a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/FIJobSettings.cs +++ b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/FIJobSettings.cs @@ -88,7 +88,8 @@ protected FIJobSettings() { } /// municipalBonds. /// marketEnvironment. /// structuredProducts. - public FIJobSettings(string asOfDate = default(string), List partialDurationMonths = default(List), CallMethodEnum? callMethod = default(CallMethodEnum?), string settlement = default(string), string calcFromMethod = default(string), FIBankLoans bankLoans = default(FIBankLoans), FIMunicipalBondsForJobSettings municipalBonds = default(FIMunicipalBondsForJobSettings), FIMarketEnvironment marketEnvironment = default(FIMarketEnvironment), FIStructuredProductsForJobSettings structuredProducts = default(FIStructuredProductsForJobSettings)) + /// attribution. + public FIJobSettings(string asOfDate = default(string), List partialDurationMonths = default(List), CallMethodEnum? callMethod = default(CallMethodEnum?), string settlement = default(string), string calcFromMethod = default(string), FIBankLoans bankLoans = default(FIBankLoans), FIMunicipalBondsForJobSettings municipalBonds = default(FIMunicipalBondsForJobSettings), FIMarketEnvironment marketEnvironment = default(FIMarketEnvironment), FIStructuredProductsForJobSettings structuredProducts = default(FIStructuredProductsForJobSettings), FIAttributionForJobSettings attribution = default(FIAttributionForJobSettings)) { // to ensure "asOfDate" is required (not null) this.AsOfDate = asOfDate ?? throw new ArgumentNullException("asOfDate is a required property for FIJobSettings and cannot be null"); @@ -100,6 +101,7 @@ protected FIJobSettings() { } this.MunicipalBonds = municipalBonds; this.MarketEnvironment = marketEnvironment; this.StructuredProducts = structuredProducts; + this.Attribution = attribution; } /// @@ -154,6 +156,12 @@ protected FIJobSettings() { } [DataMember(Name = "structuredProducts", EmitDefaultValue = false)] public FIStructuredProductsForJobSettings StructuredProducts { get; set; } + /// + /// Gets or Sets Attribution + /// + [DataMember(Name = "attribution", EmitDefaultValue = false)] + public FIAttributionForJobSettings Attribution { get; set; } + /// /// Returns the string presentation of the object /// @@ -171,6 +179,7 @@ public override string ToString() sb.Append(" MunicipalBonds: ").Append(MunicipalBonds).Append("\n"); sb.Append(" MarketEnvironment: ").Append(MarketEnvironment).Append("\n"); sb.Append(" StructuredProducts: ").Append(StructuredProducts).Append("\n"); + sb.Append(" Attribution: ").Append(Attribution).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -249,6 +258,11 @@ public bool Equals(FIJobSettings input) this.StructuredProducts == input.StructuredProducts || (this.StructuredProducts != null && this.StructuredProducts.Equals(input.StructuredProducts)) + ) && + ( + this.Attribution == input.Attribution || + (this.Attribution != null && + this.Attribution.Equals(input.Attribution)) ); } @@ -278,6 +292,8 @@ public override int GetHashCode() hashCode = hashCode * 59 + this.MarketEnvironment.GetHashCode(); if (this.StructuredProducts != null) hashCode = hashCode * 59 + this.StructuredProducts.GetHashCode(); + if (this.Attribution != null) + hashCode = hashCode * 59 + this.Attribution.GetHashCode(); return hashCode; } } diff --git a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/FISecurity.cs b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/FISecurity.cs index 089a0357..37249682 100644 --- a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/FISecurity.cs +++ b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/FISecurity.cs @@ -116,13 +116,14 @@ protected FISecurity() { } /// Matrix Spread Adjustment. /// Matrix Multiplier. /// structuredProducts. + /// attribution. /// Calculation Method. Methods : Active Spread, Actual Spread, Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act Yield To No Call, Bond Equivalent Yield, Yield To Worst Call, Discount Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread To Worst Call, Pricing Matrix. /// Calculation from value (required). /// Face (default to 1D). /// Face type (default to FaceTypeEnum.Current). /// Symbol (required). /// Discount curve. - public FISecurity(string settlement = default(string), CallMethodEnum? callMethod = default(CallMethodEnum?), FIReferenceSecurity referenceSecurity = default(FIReferenceSecurity), FIBankLoans bankLoans = default(FIBankLoans), FIMunicipalBonds municipalBonds = default(FIMunicipalBonds), FILoss loss = default(FILoss), FIPrepay prepay = default(FIPrepay), double matrixSpreadAdjustment = default(double), double matrixMultiplier = default(double), FIStructuredProductsForSecurities structuredProducts = default(FIStructuredProductsForSecurities), string calcFromMethod = default(string), double calcFromValue = default(double), double face = 1D, FaceTypeEnum? faceType = FaceTypeEnum.Current, string symbol = default(string), string discountCurve = default(string)) + public FISecurity(string settlement = default(string), CallMethodEnum? callMethod = default(CallMethodEnum?), FIReferenceSecurity referenceSecurity = default(FIReferenceSecurity), FIBankLoans bankLoans = default(FIBankLoans), FIMunicipalBonds municipalBonds = default(FIMunicipalBonds), FILoss loss = default(FILoss), FIPrepay prepay = default(FIPrepay), double matrixSpreadAdjustment = default(double), double matrixMultiplier = default(double), FIStructuredProductsForSecurities structuredProducts = default(FIStructuredProductsForSecurities), FIAttributionForSecurities attribution = default(FIAttributionForSecurities), string calcFromMethod = default(string), double calcFromValue = default(double), double face = 1D, FaceTypeEnum? faceType = FaceTypeEnum.Current, string symbol = default(string), string discountCurve = default(string)) { this.CalcFromValue = calcFromValue; // to ensure "symbol" is required (not null) @@ -137,6 +138,7 @@ protected FISecurity() { } this.MatrixSpreadAdjustment = matrixSpreadAdjustment; this.MatrixMultiplier = matrixMultiplier; this.StructuredProducts = structuredProducts; + this.Attribution = attribution; this.CalcFromMethod = calcFromMethod; this.Face = face; this.FaceType = faceType; @@ -200,6 +202,12 @@ protected FISecurity() { } [DataMember(Name = "structuredProducts", EmitDefaultValue = false)] public FIStructuredProductsForSecurities StructuredProducts { get; set; } + /// + /// Gets or Sets Attribution + /// + [DataMember(Name = "attribution", EmitDefaultValue = false)] + public FIAttributionForSecurities Attribution { get; set; } + /// /// Calculation Method. Methods : Active Spread, Actual Spread, Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act Yield To No Call, Bond Equivalent Yield, Yield To Worst Call, Discount Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread To Worst Call, Pricing Matrix /// @@ -253,6 +261,7 @@ public override string ToString() sb.Append(" MatrixSpreadAdjustment: ").Append(MatrixSpreadAdjustment).Append("\n"); sb.Append(" MatrixMultiplier: ").Append(MatrixMultiplier).Append("\n"); sb.Append(" StructuredProducts: ").Append(StructuredProducts).Append("\n"); + sb.Append(" Attribution: ").Append(Attribution).Append("\n"); sb.Append(" CalcFromMethod: ").Append(CalcFromMethod).Append("\n"); sb.Append(" CalcFromValue: ").Append(CalcFromValue).Append("\n"); sb.Append(" Face: ").Append(Face).Append("\n"); @@ -340,6 +349,11 @@ public bool Equals(FISecurity input) (this.StructuredProducts != null && this.StructuredProducts.Equals(input.StructuredProducts)) ) && + ( + this.Attribution == input.Attribution || + (this.Attribution != null && + this.Attribution.Equals(input.Attribution)) + ) && ( this.CalcFromMethod == input.CalcFromMethod || (this.CalcFromMethod != null && @@ -395,6 +409,8 @@ public override int GetHashCode() hashCode = hashCode * 59 + this.MatrixMultiplier.GetHashCode(); if (this.StructuredProducts != null) hashCode = hashCode * 59 + this.StructuredProducts.GetHashCode(); + if (this.Attribution != null) + hashCode = hashCode * 59 + this.Attribution.GetHashCode(); if (this.CalcFromMethod != null) hashCode = hashCode * 59 + this.CalcFromMethod.GetHashCode(); hashCode = hashCode * 59 + this.CalcFromValue.GetHashCode(); diff --git a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/PAComponentData.cs b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/PAComponentData.cs index 2e4156f9..a01aa199 100644 --- a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/PAComponentData.cs +++ b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/PAComponentData.cs @@ -42,7 +42,7 @@ public partial class PAComponentData : IEquatable, IValidatable /// dates. /// datasources. /// Currency ISO code for calculation.. - /// PA Storage type. It can be GROUPS or TOTALS or SECURITIES.. + /// PA Storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.. public PAComponentData(List accounts = default(List), List benchmarks = default(List), List groups = default(List), List columns = default(List), PADateParameters dates = default(PADateParameters), PACalculationDataSources datasources = default(PACalculationDataSources), string currencyisocode = default(string), string componentdetail = default(string)) { this.Accounts = accounts; @@ -103,9 +103,9 @@ public partial class PAComponentData : IEquatable, IValidatable public string Currencyisocode { get; set; } /// - /// PA Storage type. It can be GROUPS or TOTALS or SECURITIES. + /// PA Storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. /// - /// PA Storage type. It can be GROUPS or TOTALS or SECURITIES. + /// PA Storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. [DataMember(Name = "componentdetail", EmitDefaultValue = false)] public string Componentdetail { get; set; } diff --git a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/SPARComponent.cs b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/SPARComponent.cs new file mode 100644 index 00000000..2128b399 --- /dev/null +++ b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/SPARComponent.cs @@ -0,0 +1,229 @@ +/* + * Engines API + * + * Allow clients to fetch Analytics through APIs. + * + * The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + * Contact: api@factset.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = FactSet.AnalyticsAPI.Engines.Client.OpenAPIDateConverter; + +namespace FactSet.AnalyticsAPI.Engines.Model +{ + /// + /// SPARComponent + /// + [DataContract(Name = "SPARComponent")] + public partial class SPARComponent : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + /// Component identifier.. + /// List of accounts in SPAR document.. + /// benchmarks. + /// CurrencyCode in SPAR document.. + /// The path to the document. + /// Component name.. + /// Component category.. + public SPARComponent(string id = default(string), List accounts = default(List), SPARIdentifier benchmarks = default(SPARIdentifier), string currencyIsoCode = default(string), string path = default(string), string name = default(string), string category = default(string)) + { + this.Id = id; + this.Accounts = accounts; + this.Benchmarks = benchmarks; + this.CurrencyIsoCode = currencyIsoCode; + this.Path = path; + this.Name = name; + this.Category = category; + } + + /// + /// Component identifier. + /// + /// Component identifier. + [DataMember(Name = "id", EmitDefaultValue = false)] + public string Id { get; set; } + + /// + /// List of accounts in SPAR document. + /// + /// List of accounts in SPAR document. + [DataMember(Name = "accounts", EmitDefaultValue = false)] + public List Accounts { get; set; } + + /// + /// Gets or Sets Benchmarks + /// + [DataMember(Name = "benchmarks", EmitDefaultValue = false)] + public SPARIdentifier Benchmarks { get; set; } + + /// + /// CurrencyCode in SPAR document. + /// + /// CurrencyCode in SPAR document. + [DataMember(Name = "currencyIsoCode", EmitDefaultValue = false)] + public string CurrencyIsoCode { get; set; } + + /// + /// The path to the document + /// + /// The path to the document + [DataMember(Name = "path", EmitDefaultValue = false)] + public string Path { get; set; } + + /// + /// Component name. + /// + /// Component name. + [DataMember(Name = "name", EmitDefaultValue = false)] + public string Name { get; set; } + + /// + /// Component category. + /// + /// Component category. + [DataMember(Name = "category", EmitDefaultValue = false)] + public string Category { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class SPARComponent {\n"); + sb.Append(" Id: ").Append(Id).Append("\n"); + sb.Append(" Accounts: ").Append(Accounts).Append("\n"); + sb.Append(" Benchmarks: ").Append(Benchmarks).Append("\n"); + sb.Append(" CurrencyIsoCode: ").Append(CurrencyIsoCode).Append("\n"); + sb.Append(" Path: ").Append(Path).Append("\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Category: ").Append(Category).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as SPARComponent); + } + + /// + /// Returns true if SPARComponent instances are equal + /// + /// Instance of SPARComponent to be compared + /// Boolean + public bool Equals(SPARComponent input) + { + if (input == null) + return false; + + return + ( + this.Id == input.Id || + (this.Id != null && + this.Id.Equals(input.Id)) + ) && + ( + this.Accounts == input.Accounts || + this.Accounts != null && + input.Accounts != null && + this.Accounts.SequenceEqual(input.Accounts) + ) && + ( + this.Benchmarks == input.Benchmarks || + (this.Benchmarks != null && + this.Benchmarks.Equals(input.Benchmarks)) + ) && + ( + this.CurrencyIsoCode == input.CurrencyIsoCode || + (this.CurrencyIsoCode != null && + this.CurrencyIsoCode.Equals(input.CurrencyIsoCode)) + ) && + ( + this.Path == input.Path || + (this.Path != null && + this.Path.Equals(input.Path)) + ) && + ( + this.Name == input.Name || + (this.Name != null && + this.Name.Equals(input.Name)) + ) && + ( + this.Category == input.Category || + (this.Category != null && + this.Category.Equals(input.Category)) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.Id != null) + hashCode = hashCode * 59 + this.Id.GetHashCode(); + if (this.Accounts != null) + hashCode = hashCode * 59 + this.Accounts.GetHashCode(); + if (this.Benchmarks != null) + hashCode = hashCode * 59 + this.Benchmarks.GetHashCode(); + if (this.CurrencyIsoCode != null) + hashCode = hashCode * 59 + this.CurrencyIsoCode.GetHashCode(); + if (this.Path != null) + hashCode = hashCode * 59 + this.Path.GetHashCode(); + if (this.Name != null) + hashCode = hashCode * 59 + this.Name.GetHashCode(); + if (this.Category != null) + hashCode = hashCode * 59 + this.Category.GetHashCode(); + return hashCode; + } + } + + /// + /// To validate all properties of the instance + /// + /// Validation context + /// Validation Result + IEnumerable IValidatableObject.Validate(ValidationContext validationContext) + { + yield break; + } + } + +} diff --git a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/SPARComponentRoot.cs b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/SPARComponentRoot.cs new file mode 100644 index 00000000..4e3e4e9a --- /dev/null +++ b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/SPARComponentRoot.cs @@ -0,0 +1,126 @@ +/* + * Engines API + * + * Allow clients to fetch Analytics through APIs. + * + * The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + * Contact: api@factset.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = FactSet.AnalyticsAPI.Engines.Client.OpenAPIDateConverter; + +namespace FactSet.AnalyticsAPI.Engines.Model +{ + /// + /// SPARComponentRoot + /// + [DataContract(Name = "SPARComponentRoot")] + public partial class SPARComponentRoot : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + /// data. + public SPARComponentRoot(SPARComponent data = default(SPARComponent)) + { + this.Data = data; + } + + /// + /// Gets or Sets Data + /// + [DataMember(Name = "data", EmitDefaultValue = false)] + public SPARComponent Data { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class SPARComponentRoot {\n"); + sb.Append(" Data: ").Append(Data).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as SPARComponentRoot); + } + + /// + /// Returns true if SPARComponentRoot instances are equal + /// + /// Instance of SPARComponentRoot to be compared + /// Boolean + public bool Equals(SPARComponentRoot input) + { + if (input == null) + return false; + + return + ( + this.Data == input.Data || + (this.Data != null && + this.Data.Equals(input.Data)) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.Data != null) + hashCode = hashCode * 59 + this.Data.GetHashCode(); + return hashCode; + } + } + + /// + /// To validate all properties of the instance + /// + /// Validation context + /// Validation Result + IEnumerable IValidatableObject.Validate(ValidationContext validationContext) + { + yield break; + } + } + +} diff --git a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/UnlinkedPATemplate.cs b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/UnlinkedPATemplate.cs index 48212087..bc7f1f64 100644 --- a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/UnlinkedPATemplate.cs +++ b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/UnlinkedPATemplate.cs @@ -46,7 +46,7 @@ public partial class UnlinkedPATemplate : IEquatable, IValid /// List of groupings for the PA calculation. /// datasources. /// Currency ISO code for calculation.. - /// PA storage type. It can be GROUPS or TOTALS or SECURITIES.. + /// PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.. /// content. /// Template description.. /// Template name.. @@ -147,9 +147,9 @@ public partial class UnlinkedPATemplate : IEquatable, IValid public string Currencyisocode { get; set; } /// - /// PA storage type. It can be GROUPS or TOTALS or SECURITIES. + /// PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. /// - /// PA storage type. It can be GROUPS or TOTALS or SECURITIES. + /// PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. [DataMember(Name = "componentdetail", EmitDefaultValue = false)] public string Componentdetail { get; set; } diff --git a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/UnlinkedPATemplateParameters.cs b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/UnlinkedPATemplateParameters.cs index 0d831a47..982cdf51 100644 --- a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/UnlinkedPATemplateParameters.cs +++ b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/UnlinkedPATemplateParameters.cs @@ -50,7 +50,7 @@ protected UnlinkedPATemplateParameters() { } /// List of groupings for the PA calculation. /// datasources. /// Currency ISO code for calculation.. - /// PA storage type. It can be GROUPS or TOTALS or SECURITIES.. + /// PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.. /// content. public UnlinkedPATemplateParameters(string directory = default(string), string templateTypeId = default(string), string description = default(string), List accounts = default(List), List benchmarks = default(List), List columns = default(List), PADateParameters dates = default(PADateParameters), List groups = default(List), PACalculationDataSources datasources = default(PACalculationDataSources), string currencyisocode = default(string), string componentdetail = default(string), TemplateContentTypes content = default(TemplateContentTypes)) { @@ -139,9 +139,9 @@ protected UnlinkedPATemplateParameters() { } public string Currencyisocode { get; set; } /// - /// PA storage type. It can be GROUPS or TOTALS or SECURITIES. + /// PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. /// - /// PA storage type. It can be GROUPS or TOTALS or SECURITIES. + /// PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. [DataMember(Name = "componentdetail", EmitDefaultValue = false)] public string Componentdetail { get; set; } diff --git a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/UnlinkedPATemplateUpdateParameters.cs b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/UnlinkedPATemplateUpdateParameters.cs index 1eb046a4..b44b68be 100644 --- a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/UnlinkedPATemplateUpdateParameters.cs +++ b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/UnlinkedPATemplateUpdateParameters.cs @@ -43,7 +43,7 @@ public partial class UnlinkedPATemplateUpdateParameters : IEquatableList of groupings for the PA calculation. /// datasources. /// Currency ISO code for calculation.. - /// PA storage type. It can be GROUPS or TOTALS or SECURITIES.. + /// PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.. /// content. public UnlinkedPATemplateUpdateParameters(string description = default(string), List accounts = default(List), List benchmarks = default(List), List columns = default(List), PADateParameters dates = default(PADateParameters), List groups = default(List), PACalculationDataSources datasources = default(PACalculationDataSources), string currencyisocode = default(string), string componentdetail = default(string), TemplateContentTypes content = default(TemplateContentTypes)) { @@ -114,9 +114,9 @@ public partial class UnlinkedPATemplateUpdateParameters : IEquatable - /// PA storage type. It can be GROUPS or TOTALS or SECURITIES. + /// PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. /// - /// PA storage type. It can be GROUPS or TOTALS or SECURITIES. + /// PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. [DataMember(Name = "componentdetail", EmitDefaultValue = false)] public string Componentdetail { get; set; } diff --git a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/VaultAttributionLoaderResponse.cs b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/VaultAttributionLoaderResponse.cs new file mode 100644 index 00000000..23ad2ec8 --- /dev/null +++ b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/VaultAttributionLoaderResponse.cs @@ -0,0 +1,161 @@ +/* + * Engines API + * + * Allow clients to fetch Analytics through APIs. + * + * The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + * Contact: api@factset.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = FactSet.AnalyticsAPI.Engines.Client.OpenAPIDateConverter; + +namespace FactSet.AnalyticsAPI.Engines.Model +{ + /// + /// VaultAttributionLoaderResponse + /// + [DataContract(Name = "VaultAttributionLoaderResponse")] + public partial class VaultAttributionLoaderResponse : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + /// ProcessId.. + /// GroupId.. + /// ObjectId.. + public VaultAttributionLoaderResponse(string processId = default(string), string groupId = default(string), string objectId = default(string)) + { + this.ProcessId = processId; + this.GroupId = groupId; + this.ObjectId = objectId; + } + + /// + /// ProcessId. + /// + /// ProcessId. + [DataMember(Name = "processId", EmitDefaultValue = false)] + public string ProcessId { get; set; } + + /// + /// GroupId. + /// + /// GroupId. + [DataMember(Name = "groupId", EmitDefaultValue = false)] + public string GroupId { get; set; } + + /// + /// ObjectId. + /// + /// ObjectId. + [DataMember(Name = "objectId", EmitDefaultValue = false)] + public string ObjectId { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class VaultAttributionLoaderResponse {\n"); + sb.Append(" ProcessId: ").Append(ProcessId).Append("\n"); + sb.Append(" GroupId: ").Append(GroupId).Append("\n"); + sb.Append(" ObjectId: ").Append(ObjectId).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as VaultAttributionLoaderResponse); + } + + /// + /// Returns true if VaultAttributionLoaderResponse instances are equal + /// + /// Instance of VaultAttributionLoaderResponse to be compared + /// Boolean + public bool Equals(VaultAttributionLoaderResponse input) + { + if (input == null) + return false; + + return + ( + this.ProcessId == input.ProcessId || + (this.ProcessId != null && + this.ProcessId.Equals(input.ProcessId)) + ) && + ( + this.GroupId == input.GroupId || + (this.GroupId != null && + this.GroupId.Equals(input.GroupId)) + ) && + ( + this.ObjectId == input.ObjectId || + (this.ObjectId != null && + this.ObjectId.Equals(input.ObjectId)) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.ProcessId != null) + hashCode = hashCode * 59 + this.ProcessId.GetHashCode(); + if (this.GroupId != null) + hashCode = hashCode * 59 + this.GroupId.GetHashCode(); + if (this.ObjectId != null) + hashCode = hashCode * 59 + this.ObjectId.GetHashCode(); + return hashCode; + } + } + + /// + /// To validate all properties of the instance + /// + /// Validation context + /// Validation Result + IEnumerable IValidatableObject.Validate(ValidationContext validationContext) + { + yield break; + } + } + +} diff --git a/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/VaultAttributionLoaderResponseRoot.cs b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/VaultAttributionLoaderResponseRoot.cs new file mode 100644 index 00000000..230acfad --- /dev/null +++ b/auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines/Model/VaultAttributionLoaderResponseRoot.cs @@ -0,0 +1,148 @@ +/* + * Engines API + * + * Allow clients to fetch Analytics through APIs. + * + * The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + * Contact: api@factset.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = FactSet.AnalyticsAPI.Engines.Client.OpenAPIDateConverter; + +namespace FactSet.AnalyticsAPI.Engines.Model +{ + /// + /// VaultAttributionLoaderResponseRoot + /// + [DataContract(Name = "VaultAttributionLoaderResponseRoot")] + public partial class VaultAttributionLoaderResponseRoot : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected VaultAttributionLoaderResponseRoot() { } + /// + /// Initializes a new instance of the class. + /// + /// data (required). + /// meta. + public VaultAttributionLoaderResponseRoot(VaultAttributionLoaderResponse data = default(VaultAttributionLoaderResponse), Object meta = default(Object)) + { + // to ensure "data" is required (not null) + this.Data = data ?? throw new ArgumentNullException("data is a required property for VaultAttributionLoaderResponseRoot and cannot be null"); + this.Meta = meta; + } + + /// + /// Gets or Sets Data + /// + [DataMember(Name = "data", IsRequired = true, EmitDefaultValue = false)] + public VaultAttributionLoaderResponse Data { get; set; } + + /// + /// Gets or Sets Meta + /// + [DataMember(Name = "meta", EmitDefaultValue = false)] + public Object Meta { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class VaultAttributionLoaderResponseRoot {\n"); + sb.Append(" Data: ").Append(Data).Append("\n"); + sb.Append(" Meta: ").Append(Meta).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as VaultAttributionLoaderResponseRoot); + } + + /// + /// Returns true if VaultAttributionLoaderResponseRoot instances are equal + /// + /// Instance of VaultAttributionLoaderResponseRoot to be compared + /// Boolean + public bool Equals(VaultAttributionLoaderResponseRoot input) + { + if (input == null) + return false; + + return + ( + this.Data == input.Data || + (this.Data != null && + this.Data.Equals(input.Data)) + ) && + ( + this.Meta == input.Meta || + (this.Meta != null && + this.Meta.Equals(input.Meta)) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.Data != null) + hashCode = hashCode * 59 + this.Data.GetHashCode(); + if (this.Meta != null) + hashCode = hashCode * 59 + this.Meta.GetHashCode(); + return hashCode; + } + } + + /// + /// To validate all properties of the instance + /// + /// Validation context + /// Validation Result + IEnumerable IValidatableObject.Validate(ValidationContext validationContext) + { + yield break; + } + } + +}