diff --git a/auto-generated-sdk/.openapi-generator/FILES b/auto-generated-sdk/.openapi-generator/FILES index 2b2a1b78..62fc5984 100644 --- a/auto-generated-sdk/.openapi-generator/FILES +++ b/auto-generated-sdk/.openapi-generator/FILES @@ -69,10 +69,17 @@ docs/FIABIdentifier.md docs/FICalculationParameters.md docs/FICalculationParametersRoot.md docs/FIJobSettings.md +docs/FILoss.md +docs/FIPrepay.md +docs/FIReferencePrepay.md +docs/FIReferenceSecurity.md docs/FISecurity.md docs/FPOAccount.md +docs/FPOObjective.md docs/FPOOptimizationParameters.md docs/FPOOptimizationParametersRoot.md +docs/FPOOptimizerStrategy.md +docs/FPOOptimizerStrategyOverrides.md docs/FiCalculationsApi.md docs/FiabCalculationsApi.md docs/FpoOptimizerApi.md @@ -82,26 +89,39 @@ docs/FrequencyRoot.md docs/Group.md docs/GroupRoot.md docs/GroupsApi.md +docs/LinkedPATemplate.md +docs/LinkedPATemplateParameters.md +docs/LinkedPATemplateParametersRoot.md +docs/LinkedPATemplatePostSummary.md +docs/LinkedPATemplatePostSummaryRoot.md +docs/LinkedPATemplateRoot.md +docs/LinkedPATemplateSummary.md +docs/LinkedPATemplateSummaryRoot.md +docs/LinkedPATemplateUpdateParameters.md +docs/LinkedPATemplateUpdateParametersRoot.md +docs/LinkedPaTemplatesApi.md docs/NPOOptimizationParameters.md docs/NPOOptimizationParametersRoot.md docs/NPOOptimizerStrategy.md docs/NPOOptimizerStrategyOverrides.md docs/NpoOptimizerApi.md docs/ObjectRoot.md +docs/OneOfQuantDates.md +docs/OneOfQuantFormulasArray.md +docs/OneOfQuantUniverse.md docs/OptimalPortfolio.md docs/Optimization.md docs/OptimizerAccount.md docs/OptimizerAccountOverrides.md docs/OptimizerOptimalHoldings.md docs/OptimizerOutputTypes.md -docs/OptimizerStrategy.md -docs/OptimizerStrategyOverrides.md docs/OptimizerTradesList.md docs/PACalculationColumn.md docs/PACalculationGroup.md docs/PACalculationParameters.md docs/PACalculationParametersRoot.md docs/PAComponent.md +docs/PAComponentData.md docs/PAComponentRoot.md docs/PADateParameters.md docs/PAIdentifier.md @@ -112,18 +132,33 @@ docs/PubCalculationParametersRoot.md docs/PubCalculationsApi.md docs/PubDateParameters.md docs/PubIdentifier.md +docs/QuantAllUniversalScreenParameters.md docs/QuantCalculationMeta.md docs/QuantCalculationParameters.md docs/QuantCalculationParametersRoot.md docs/QuantCalculationsApi.md +docs/QuantDate.md docs/QuantDateList.md +docs/QuantDateListObsolete.md docs/QuantFdsDate.md +docs/QuantFdsDateObsolete.md +docs/QuantFormula.md docs/QuantFqlExpression.md +docs/QuantFqlExpressionObsolete.md docs/QuantIdentifierUniverse.md +docs/QuantIdentifierUniverseObsolete.md docs/QuantScreeningExpression.md +docs/QuantScreeningExpressionObsolete.md docs/QuantScreeningExpressionUniverse.md +docs/QuantScreeningExpressionUniverseObsolete.md docs/QuantUniversalScreenParameter.md +docs/QuantUniversalScreenParameterObsolete.md docs/QuantUniversalScreenUniverse.md +docs/QuantUniversalScreenUniverseObsolete.md +docs/QuantUniverse.md +docs/ReturnType.md +docs/SPARAccounts.md +docs/SPARAccountsRoot.md docs/SPARBenchmark.md docs/SPARBenchmarkRoot.md docs/SPARCalculationParameters.md @@ -132,6 +167,35 @@ docs/SPARDateParameters.md docs/SPARIdentifier.md docs/SparCalculationsApi.md docs/StrategyDocumentsApi.md +docs/TemplateContentTypes.md +docs/TemplatedPAComponent.md +docs/TemplatedPAComponentParameters.md +docs/TemplatedPAComponentParametersRoot.md +docs/TemplatedPAComponentPostSummary.md +docs/TemplatedPAComponentPostSummaryRoot.md +docs/TemplatedPAComponentRoot.md +docs/TemplatedPAComponentSummary.md +docs/TemplatedPAComponentSummaryRoot.md +docs/TemplatedPAComponentUpdateParameters.md +docs/TemplatedPAComponentUpdateParametersRoot.md +docs/TemplatedPaComponentsApi.md +docs/UnlinkedPATemplate.md +docs/UnlinkedPATemplateCategoryAndType.md +docs/UnlinkedPATemplateCategoryAndTypeDetails.md +docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md +docs/UnlinkedPATemplateCategoryAndTypeRoot.md +docs/UnlinkedPATemplateColumnDetails.md +docs/UnlinkedPATemplateGroupDetails.md +docs/UnlinkedPATemplateParameters.md +docs/UnlinkedPATemplateParametersRoot.md +docs/UnlinkedPATemplatePostSummary.md +docs/UnlinkedPATemplatePostSummaryRoot.md +docs/UnlinkedPATemplateRoot.md +docs/UnlinkedPATemplateSummary.md +docs/UnlinkedPATemplateSummaryRoot.md +docs/UnlinkedPATemplateUpdateParameters.md +docs/UnlinkedPATemplateUpdateParametersRoot.md +docs/UnlinkedPaTemplatesApi.md docs/VaultCalculationParameters.md docs/VaultCalculationParametersRoot.md docs/VaultCalculationsApi.md @@ -181,12 +245,15 @@ src/main/java/factset/analyticsapi/engines/api/FiabCalculationsApi.java src/main/java/factset/analyticsapi/engines/api/FpoOptimizerApi.java src/main/java/factset/analyticsapi/engines/api/FrequenciesApi.java src/main/java/factset/analyticsapi/engines/api/GroupsApi.java +src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java src/main/java/factset/analyticsapi/engines/api/NpoOptimizerApi.java src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java src/main/java/factset/analyticsapi/engines/api/QuantCalculationsApi.java src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java +src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java +src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java src/main/java/factset/analyticsapi/engines/auth/ApiKeyAuth.java src/main/java/factset/analyticsapi/engines/auth/Authentication.java @@ -245,33 +312,52 @@ src/main/java/factset/analyticsapi/engines/models/FIABIdentifier.java src/main/java/factset/analyticsapi/engines/models/FICalculationParameters.java src/main/java/factset/analyticsapi/engines/models/FICalculationParametersRoot.java src/main/java/factset/analyticsapi/engines/models/FIJobSettings.java +src/main/java/factset/analyticsapi/engines/models/FILoss.java +src/main/java/factset/analyticsapi/engines/models/FIPrepay.java +src/main/java/factset/analyticsapi/engines/models/FIReferencePrepay.java +src/main/java/factset/analyticsapi/engines/models/FIReferenceSecurity.java src/main/java/factset/analyticsapi/engines/models/FISecurity.java src/main/java/factset/analyticsapi/engines/models/FPOAccount.java +src/main/java/factset/analyticsapi/engines/models/FPOObjective.java src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParameters.java src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParametersRoot.java +src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategy.java +src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategyOverrides.java src/main/java/factset/analyticsapi/engines/models/Frequency.java src/main/java/factset/analyticsapi/engines/models/FrequencyRoot.java src/main/java/factset/analyticsapi/engines/models/Group.java src/main/java/factset/analyticsapi/engines/models/GroupRoot.java +src/main/java/factset/analyticsapi/engines/models/LinkedPATemplate.java +src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParameters.java +src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParametersRoot.java +src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummary.java +src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummaryRoot.java +src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateRoot.java +src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummary.java +src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummaryRoot.java +src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParameters.java +src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParametersRoot.java src/main/java/factset/analyticsapi/engines/models/NPOOptimizationParameters.java src/main/java/factset/analyticsapi/engines/models/NPOOptimizationParametersRoot.java src/main/java/factset/analyticsapi/engines/models/NPOOptimizerStrategy.java src/main/java/factset/analyticsapi/engines/models/NPOOptimizerStrategyOverrides.java src/main/java/factset/analyticsapi/engines/models/ObjectRoot.java +src/main/java/factset/analyticsapi/engines/models/OneOfQuantDates.java +src/main/java/factset/analyticsapi/engines/models/OneOfQuantFormulasArray.java +src/main/java/factset/analyticsapi/engines/models/OneOfQuantUniverse.java src/main/java/factset/analyticsapi/engines/models/OptimalPortfolio.java src/main/java/factset/analyticsapi/engines/models/Optimization.java src/main/java/factset/analyticsapi/engines/models/OptimizerAccount.java src/main/java/factset/analyticsapi/engines/models/OptimizerAccountOverrides.java src/main/java/factset/analyticsapi/engines/models/OptimizerOptimalHoldings.java src/main/java/factset/analyticsapi/engines/models/OptimizerOutputTypes.java -src/main/java/factset/analyticsapi/engines/models/OptimizerStrategy.java -src/main/java/factset/analyticsapi/engines/models/OptimizerStrategyOverrides.java src/main/java/factset/analyticsapi/engines/models/OptimizerTradesList.java src/main/java/factset/analyticsapi/engines/models/PACalculationColumn.java src/main/java/factset/analyticsapi/engines/models/PACalculationGroup.java src/main/java/factset/analyticsapi/engines/models/PACalculationParameters.java src/main/java/factset/analyticsapi/engines/models/PACalculationParametersRoot.java src/main/java/factset/analyticsapi/engines/models/PAComponent.java +src/main/java/factset/analyticsapi/engines/models/PAComponentData.java src/main/java/factset/analyticsapi/engines/models/PAComponentRoot.java src/main/java/factset/analyticsapi/engines/models/PADateParameters.java src/main/java/factset/analyticsapi/engines/models/PAIdentifier.java @@ -280,23 +366,65 @@ src/main/java/factset/analyticsapi/engines/models/PubCalculationParameters.java src/main/java/factset/analyticsapi/engines/models/PubCalculationParametersRoot.java src/main/java/factset/analyticsapi/engines/models/PubDateParameters.java src/main/java/factset/analyticsapi/engines/models/PubIdentifier.java +src/main/java/factset/analyticsapi/engines/models/QuantAllUniversalScreenParameters.java src/main/java/factset/analyticsapi/engines/models/QuantCalculationMeta.java src/main/java/factset/analyticsapi/engines/models/QuantCalculationParameters.java src/main/java/factset/analyticsapi/engines/models/QuantCalculationParametersRoot.java +src/main/java/factset/analyticsapi/engines/models/QuantDate.java src/main/java/factset/analyticsapi/engines/models/QuantDateList.java +src/main/java/factset/analyticsapi/engines/models/QuantDateListObsolete.java src/main/java/factset/analyticsapi/engines/models/QuantFdsDate.java +src/main/java/factset/analyticsapi/engines/models/QuantFdsDateObsolete.java +src/main/java/factset/analyticsapi/engines/models/QuantFormula.java src/main/java/factset/analyticsapi/engines/models/QuantFqlExpression.java +src/main/java/factset/analyticsapi/engines/models/QuantFqlExpressionObsolete.java src/main/java/factset/analyticsapi/engines/models/QuantIdentifierUniverse.java +src/main/java/factset/analyticsapi/engines/models/QuantIdentifierUniverseObsolete.java src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpression.java +src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionObsolete.java src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionUniverse.java +src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionUniverseObsolete.java src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenParameter.java +src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenParameterObsolete.java src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenUniverse.java +src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenUniverseObsolete.java +src/main/java/factset/analyticsapi/engines/models/QuantUniverse.java +src/main/java/factset/analyticsapi/engines/models/ReturnType.java +src/main/java/factset/analyticsapi/engines/models/SPARAccounts.java +src/main/java/factset/analyticsapi/engines/models/SPARAccountsRoot.java src/main/java/factset/analyticsapi/engines/models/SPARBenchmark.java src/main/java/factset/analyticsapi/engines/models/SPARBenchmarkRoot.java src/main/java/factset/analyticsapi/engines/models/SPARCalculationParameters.java src/main/java/factset/analyticsapi/engines/models/SPARCalculationParametersRoot.java src/main/java/factset/analyticsapi/engines/models/SPARDateParameters.java src/main/java/factset/analyticsapi/engines/models/SPARIdentifier.java +src/main/java/factset/analyticsapi/engines/models/TemplateContentTypes.java +src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponent.java +src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParameters.java +src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParametersRoot.java +src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummary.java +src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummaryRoot.java +src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentRoot.java +src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummary.java +src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummaryRoot.java +src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParameters.java +src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParametersRoot.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplate.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndType.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetails.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetailsRoot.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeRoot.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateColumnDetails.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateGroupDetails.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParameters.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParametersRoot.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummary.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummaryRoot.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateRoot.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummary.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummaryRoot.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParameters.java +src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParametersRoot.java src/main/java/factset/analyticsapi/engines/models/VaultCalculationParameters.java src/main/java/factset/analyticsapi/engines/models/VaultCalculationParametersRoot.java src/main/java/factset/analyticsapi/engines/models/VaultComponent.java diff --git a/auto-generated-sdk/.openapi-generator/VERSION b/auto-generated-sdk/.openapi-generator/VERSION index acf69b48..7d3cdbf0 100644 --- a/auto-generated-sdk/.openapi-generator/VERSION +++ b/auto-generated-sdk/.openapi-generator/VERSION @@ -1 +1 @@ -5.1.0 \ No newline at end of file +5.3.1 \ No newline at end of file diff --git a/auto-generated-sdk/README.md b/auto-generated-sdk/README.md index 06cf2d73..5a93c1f5 100644 --- a/auto-generated-sdk/README.md +++ b/auto-generated-sdk/README.md @@ -42,7 +42,7 @@ Add this dependency to your project's POM: com.factset.analyticsapi engines-sdk - 5.1.0 + 5.2.0 compile ``` @@ -52,7 +52,7 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "com.factset.analyticsapi:engines-sdk:5.1.0" +compile "com.factset.analyticsapi:engines-sdk:5.2.0" ``` ### Others @@ -65,7 +65,7 @@ mvn clean package Then manually install the following JARs: -- `target/engines-sdk-5.1.0.jar` +- `target/engines-sdk-5.2.0.jar` - `target/lib/*.jar` ## Usage @@ -142,6 +142,7 @@ All URIs are relative to *https://api.factset.com* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *AccountsApi* | [**getAccounts**](docs/AccountsApi.md#getAccounts) | **GET** /analytics/lookups/v3/accounts/{path} | Get accounts and sub-directories in a directory +*AccountsApi* | [**getSPARReturnsType**](docs/AccountsApi.md#getSPARReturnsType) | **GET** /analytics/engines/spar/v3/accounts/{accountPath}/returns-type | Get SPAR account returns type details *AfiOptimizerApi* | [**cancelOptimizationById**](docs/AfiOptimizerApi.md#cancelOptimizationById) | **DELETE** /analytics/engines/afi/v3/optimizations/{id} | Cancel AFI optimization by id *AfiOptimizerApi* | [**getOptimizationParameters**](docs/AfiOptimizerApi.md#getOptimizationParameters) | **GET** /analytics/engines/afi/v3/optimizations/{id} | Get AFI optimization parameters by id *AfiOptimizerApi* | [**getOptimizationResult**](docs/AfiOptimizerApi.md#getOptimizationResult) | **GET** /analytics/engines/afi/v3/optimizations/{id}/result | Get AFI optimization result by id @@ -197,6 +198,11 @@ Class | Method | HTTP request | Description *FrequenciesApi* | [**getSPARFrequencies**](docs/FrequenciesApi.md#getSPARFrequencies) | **GET** /analytics/engines/spar/v3/frequencies | Get SPAR frequencies *FrequenciesApi* | [**getVaultFrequencies**](docs/FrequenciesApi.md#getVaultFrequencies) | **GET** /analytics/engines/vault/v3/frequencies | Get Vault frequencies *GroupsApi* | [**getPAGroups**](docs/GroupsApi.md#getPAGroups) | **GET** /analytics/engines/pa/v3/groups | Get PA groups +*LinkedPaTemplatesApi* | [**createLinkedPATemplates**](docs/LinkedPaTemplatesApi.md#createLinkedPATemplates) | **POST** /analytics/engines/pa/v3/linked-templates | Create a linked PA template +*LinkedPaTemplatesApi* | [**deleteLinkedPATemplates**](docs/LinkedPaTemplatesApi.md#deleteLinkedPATemplates) | **DELETE** /analytics/engines/pa/v3/linked-templates/{id} | Delete a linked PA template. +*LinkedPaTemplatesApi* | [**getLinkedPATemplates**](docs/LinkedPaTemplatesApi.md#getLinkedPATemplates) | **GET** /analytics/engines/pa/v3/linked-templates | Get linked PA templates +*LinkedPaTemplatesApi* | [**getLinkedPATemplatesById**](docs/LinkedPaTemplatesApi.md#getLinkedPATemplatesById) | **GET** /analytics/engines/pa/v3/linked-templates/{id} | Get linked PA template by id +*LinkedPaTemplatesApi* | [**updateLinkedPATemplates**](docs/LinkedPaTemplatesApi.md#updateLinkedPATemplates) | **PUT** /analytics/engines/pa/v3/linked-templates/{id} | Update a linked PA template *NpoOptimizerApi* | [**cancelOptimizationById**](docs/NpoOptimizerApi.md#cancelOptimizationById) | **DELETE** /analytics/engines/npo/v3/optimizations/{id} | Cancel NPO optimization by id *NpoOptimizerApi* | [**getOptimizationParameters**](docs/NpoOptimizerApi.md#getOptimizationParameters) | **GET** /analytics/engines/npo/v3/optimizations/{id} | Get NPO optimization parameters by id *NpoOptimizerApi* | [**getOptimizationResult**](docs/NpoOptimizerApi.md#getOptimizationResult) | **GET** /analytics/engines/npo/v3/optimizations/{id}/result | Get NPO optimization result by id @@ -233,6 +239,18 @@ Class | Method | HTTP request | Description *StrategyDocumentsApi* | [**getBarraStrategyDocuments**](docs/StrategyDocumentsApi.md#getBarraStrategyDocuments) | **GET** /analytics/engines/bpm/v3/strategies/{path} | Get Barra strategy documents and sub-directories in a directory *StrategyDocumentsApi* | [**getFPOStrategyDocuments**](docs/StrategyDocumentsApi.md#getFPOStrategyDocuments) | **GET** /analytics/engines/fpo/v3/strategies/{path} | Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory *StrategyDocumentsApi* | [**getNorthfieldStrategyDocuments**](docs/StrategyDocumentsApi.md#getNorthfieldStrategyDocuments) | **GET** /analytics/engines/npo/v3/strategies/{path} | Get Northfield strategy documents and sub-directories in a directory +*TemplatedPaComponentsApi* | [**createTemplatedPAComponents**](docs/TemplatedPaComponentsApi.md#createTemplatedPAComponents) | **POST** /analytics/engines/pa/v3/templated-components | Create templated PA component +*TemplatedPaComponentsApi* | [**deleteTemplatedPAComponents**](docs/TemplatedPaComponentsApi.md#deleteTemplatedPAComponents) | **DELETE** /analytics/engines/pa/v3/templated-components/{id} | Delete templated PA component +*TemplatedPaComponentsApi* | [**getTemplatedPAComponentById**](docs/TemplatedPaComponentsApi.md#getTemplatedPAComponentById) | **GET** /analytics/engines/pa/v3/templated-components/{id} | Get templated PA component by id +*TemplatedPaComponentsApi* | [**getTemplatedPAComponentsInPath**](docs/TemplatedPaComponentsApi.md#getTemplatedPAComponentsInPath) | **GET** /analytics/engines/pa/v3/templated-components | Get templated PA components in path +*TemplatedPaComponentsApi* | [**updateTemplatedPAComponents**](docs/TemplatedPaComponentsApi.md#updateTemplatedPAComponents) | **PUT** /analytics/engines/pa/v3/templated-components/{id} | Update templated PA component +*UnlinkedPaTemplatesApi* | [**createUnlinkedPATemplates**](docs/UnlinkedPaTemplatesApi.md#createUnlinkedPATemplates) | **POST** /analytics/engines/pa/v3/unlinked-templates | Create unlinked PA template +*UnlinkedPaTemplatesApi* | [**deleteUnlinkedPATemplates**](docs/UnlinkedPaTemplatesApi.md#deleteUnlinkedPATemplates) | **DELETE** /analytics/engines/pa/v3/unlinked-templates/{id} | Delete unlinked PA template +*UnlinkedPaTemplatesApi* | [**getDefaultUnlinkedPATemplateTypes**](docs/UnlinkedPaTemplatesApi.md#getDefaultUnlinkedPATemplateTypes) | **GET** /analytics/engines/pa/v3/unlinked-templates/template-types | Get default unlinked PA template types. +*UnlinkedPaTemplatesApi* | [**getDetailsType**](docs/UnlinkedPaTemplatesApi.md#getDetailsType) | **GET** /analytics/engines/pa/v3/unlinked-templates/template-types/{id} | Get unlinked PA template type details by id. +*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 *VaultCalculationsApi* | [**cancelCalculationById**](docs/VaultCalculationsApi.md#cancelCalculationById) | **DELETE** /analytics/engines/vault/v3/calculations/{id} | Cancel Vault calculation by id *VaultCalculationsApi* | [**getCalculationParameters**](docs/VaultCalculationsApi.md#getCalculationParameters) | **GET** /analytics/engines/vault/v3/calculations/{id} | Get Vault calculation parameters by id *VaultCalculationsApi* | [**getCalculationStatusById**](docs/VaultCalculationsApi.md#getCalculationStatusById) | **GET** /analytics/engines/vault/v3/calculations/{id}/status | Get Vault calculation status by id @@ -295,33 +313,52 @@ Class | Method | HTTP request | Description - [FICalculationParameters](docs/FICalculationParameters.md) - [FICalculationParametersRoot](docs/FICalculationParametersRoot.md) - [FIJobSettings](docs/FIJobSettings.md) + - [FILoss](docs/FILoss.md) + - [FIPrepay](docs/FIPrepay.md) + - [FIReferencePrepay](docs/FIReferencePrepay.md) + - [FIReferenceSecurity](docs/FIReferenceSecurity.md) - [FISecurity](docs/FISecurity.md) - [FPOAccount](docs/FPOAccount.md) + - [FPOObjective](docs/FPOObjective.md) - [FPOOptimizationParameters](docs/FPOOptimizationParameters.md) - [FPOOptimizationParametersRoot](docs/FPOOptimizationParametersRoot.md) + - [FPOOptimizerStrategy](docs/FPOOptimizerStrategy.md) + - [FPOOptimizerStrategyOverrides](docs/FPOOptimizerStrategyOverrides.md) - [Frequency](docs/Frequency.md) - [FrequencyRoot](docs/FrequencyRoot.md) - [Group](docs/Group.md) - [GroupRoot](docs/GroupRoot.md) + - [LinkedPATemplate](docs/LinkedPATemplate.md) + - [LinkedPATemplateParameters](docs/LinkedPATemplateParameters.md) + - [LinkedPATemplateParametersRoot](docs/LinkedPATemplateParametersRoot.md) + - [LinkedPATemplatePostSummary](docs/LinkedPATemplatePostSummary.md) + - [LinkedPATemplatePostSummaryRoot](docs/LinkedPATemplatePostSummaryRoot.md) + - [LinkedPATemplateRoot](docs/LinkedPATemplateRoot.md) + - [LinkedPATemplateSummary](docs/LinkedPATemplateSummary.md) + - [LinkedPATemplateSummaryRoot](docs/LinkedPATemplateSummaryRoot.md) + - [LinkedPATemplateUpdateParameters](docs/LinkedPATemplateUpdateParameters.md) + - [LinkedPATemplateUpdateParametersRoot](docs/LinkedPATemplateUpdateParametersRoot.md) - [NPOOptimizationParameters](docs/NPOOptimizationParameters.md) - [NPOOptimizationParametersRoot](docs/NPOOptimizationParametersRoot.md) - [NPOOptimizerStrategy](docs/NPOOptimizerStrategy.md) - [NPOOptimizerStrategyOverrides](docs/NPOOptimizerStrategyOverrides.md) - [ObjectRoot](docs/ObjectRoot.md) + - [OneOfQuantDates](docs/OneOfQuantDates.md) + - [OneOfQuantFormulasArray](docs/OneOfQuantFormulasArray.md) + - [OneOfQuantUniverse](docs/OneOfQuantUniverse.md) - [OptimalPortfolio](docs/OptimalPortfolio.md) - [Optimization](docs/Optimization.md) - [OptimizerAccount](docs/OptimizerAccount.md) - [OptimizerAccountOverrides](docs/OptimizerAccountOverrides.md) - [OptimizerOptimalHoldings](docs/OptimizerOptimalHoldings.md) - [OptimizerOutputTypes](docs/OptimizerOutputTypes.md) - - [OptimizerStrategy](docs/OptimizerStrategy.md) - - [OptimizerStrategyOverrides](docs/OptimizerStrategyOverrides.md) - [OptimizerTradesList](docs/OptimizerTradesList.md) - [PACalculationColumn](docs/PACalculationColumn.md) - [PACalculationGroup](docs/PACalculationGroup.md) - [PACalculationParameters](docs/PACalculationParameters.md) - [PACalculationParametersRoot](docs/PACalculationParametersRoot.md) - [PAComponent](docs/PAComponent.md) + - [PAComponentData](docs/PAComponentData.md) - [PAComponentRoot](docs/PAComponentRoot.md) - [PADateParameters](docs/PADateParameters.md) - [PAIdentifier](docs/PAIdentifier.md) @@ -330,23 +367,65 @@ Class | Method | HTTP request | Description - [PubCalculationParametersRoot](docs/PubCalculationParametersRoot.md) - [PubDateParameters](docs/PubDateParameters.md) - [PubIdentifier](docs/PubIdentifier.md) + - [QuantAllUniversalScreenParameters](docs/QuantAllUniversalScreenParameters.md) - [QuantCalculationMeta](docs/QuantCalculationMeta.md) - [QuantCalculationParameters](docs/QuantCalculationParameters.md) - [QuantCalculationParametersRoot](docs/QuantCalculationParametersRoot.md) + - [QuantDate](docs/QuantDate.md) - [QuantDateList](docs/QuantDateList.md) + - [QuantDateListObsolete](docs/QuantDateListObsolete.md) - [QuantFdsDate](docs/QuantFdsDate.md) + - [QuantFdsDateObsolete](docs/QuantFdsDateObsolete.md) + - [QuantFormula](docs/QuantFormula.md) - [QuantFqlExpression](docs/QuantFqlExpression.md) + - [QuantFqlExpressionObsolete](docs/QuantFqlExpressionObsolete.md) - [QuantIdentifierUniverse](docs/QuantIdentifierUniverse.md) + - [QuantIdentifierUniverseObsolete](docs/QuantIdentifierUniverseObsolete.md) - [QuantScreeningExpression](docs/QuantScreeningExpression.md) + - [QuantScreeningExpressionObsolete](docs/QuantScreeningExpressionObsolete.md) - [QuantScreeningExpressionUniverse](docs/QuantScreeningExpressionUniverse.md) + - [QuantScreeningExpressionUniverseObsolete](docs/QuantScreeningExpressionUniverseObsolete.md) - [QuantUniversalScreenParameter](docs/QuantUniversalScreenParameter.md) + - [QuantUniversalScreenParameterObsolete](docs/QuantUniversalScreenParameterObsolete.md) - [QuantUniversalScreenUniverse](docs/QuantUniversalScreenUniverse.md) + - [QuantUniversalScreenUniverseObsolete](docs/QuantUniversalScreenUniverseObsolete.md) + - [QuantUniverse](docs/QuantUniverse.md) + - [ReturnType](docs/ReturnType.md) + - [SPARAccounts](docs/SPARAccounts.md) + - [SPARAccountsRoot](docs/SPARAccountsRoot.md) - [SPARBenchmark](docs/SPARBenchmark.md) - [SPARBenchmarkRoot](docs/SPARBenchmarkRoot.md) - [SPARCalculationParameters](docs/SPARCalculationParameters.md) - [SPARCalculationParametersRoot](docs/SPARCalculationParametersRoot.md) - [SPARDateParameters](docs/SPARDateParameters.md) - [SPARIdentifier](docs/SPARIdentifier.md) + - [TemplateContentTypes](docs/TemplateContentTypes.md) + - [TemplatedPAComponent](docs/TemplatedPAComponent.md) + - [TemplatedPAComponentParameters](docs/TemplatedPAComponentParameters.md) + - [TemplatedPAComponentParametersRoot](docs/TemplatedPAComponentParametersRoot.md) + - [TemplatedPAComponentPostSummary](docs/TemplatedPAComponentPostSummary.md) + - [TemplatedPAComponentPostSummaryRoot](docs/TemplatedPAComponentPostSummaryRoot.md) + - [TemplatedPAComponentRoot](docs/TemplatedPAComponentRoot.md) + - [TemplatedPAComponentSummary](docs/TemplatedPAComponentSummary.md) + - [TemplatedPAComponentSummaryRoot](docs/TemplatedPAComponentSummaryRoot.md) + - [TemplatedPAComponentUpdateParameters](docs/TemplatedPAComponentUpdateParameters.md) + - [TemplatedPAComponentUpdateParametersRoot](docs/TemplatedPAComponentUpdateParametersRoot.md) + - [UnlinkedPATemplate](docs/UnlinkedPATemplate.md) + - [UnlinkedPATemplateCategoryAndType](docs/UnlinkedPATemplateCategoryAndType.md) + - [UnlinkedPATemplateCategoryAndTypeDetails](docs/UnlinkedPATemplateCategoryAndTypeDetails.md) + - [UnlinkedPATemplateCategoryAndTypeDetailsRoot](docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md) + - [UnlinkedPATemplateCategoryAndTypeRoot](docs/UnlinkedPATemplateCategoryAndTypeRoot.md) + - [UnlinkedPATemplateColumnDetails](docs/UnlinkedPATemplateColumnDetails.md) + - [UnlinkedPATemplateGroupDetails](docs/UnlinkedPATemplateGroupDetails.md) + - [UnlinkedPATemplateParameters](docs/UnlinkedPATemplateParameters.md) + - [UnlinkedPATemplateParametersRoot](docs/UnlinkedPATemplateParametersRoot.md) + - [UnlinkedPATemplatePostSummary](docs/UnlinkedPATemplatePostSummary.md) + - [UnlinkedPATemplatePostSummaryRoot](docs/UnlinkedPATemplatePostSummaryRoot.md) + - [UnlinkedPATemplateRoot](docs/UnlinkedPATemplateRoot.md) + - [UnlinkedPATemplateSummary](docs/UnlinkedPATemplateSummary.md) + - [UnlinkedPATemplateSummaryRoot](docs/UnlinkedPATemplateSummaryRoot.md) + - [UnlinkedPATemplateUpdateParameters](docs/UnlinkedPATemplateUpdateParameters.md) + - [UnlinkedPATemplateUpdateParametersRoot](docs/UnlinkedPATemplateUpdateParametersRoot.md) - [VaultCalculationParameters](docs/VaultCalculationParameters.md) - [VaultCalculationParametersRoot](docs/VaultCalculationParametersRoot.md) - [VaultComponent](docs/VaultComponent.md) diff --git a/auto-generated-sdk/api/openapi.yaml b/auto-generated-sdk/api/openapi.yaml index ff7f1131..fd90eb30 100644 --- a/auto-generated-sdk/api/openapi.yaml +++ b/auto-generated-sdk/api/openapi.yaml @@ -16,20 +16,19 @@ security: - Basic: [] Bearer: [] paths: - /analytics/lookups/v3/accounts/{path}: + /analytics/engines/spar/v3/accounts/{accountPath}/returns-type: get: - description: This endpoint looks up all ACCT and ACTM files and sub-directories - in a given directory. - operationId: getAccounts + description: This endpoint returns the returns type of account associated with + SPAR + operationId: getSPARReturnsType parameters: - - description: The directory to get the accounts and sub-directories in + - description: URL encoded account path explode: false in: path - name: path + name: accountPath required: true schema: - default: "" - description: The directory to get the accounts and sub-directories in + description: URL encoded account path type: string style: simple responses: @@ -37,8 +36,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AccountDirectoriesRoot' - description: Expected response, returns a list of accounts and directories + $ref: '#/components/schemas/SPARAccountsRoot' + description: Expected response, returns the list of return types for the + account. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -79,7 +79,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter or value provided + description: Invalid account. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -120,7 +120,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Path not found + description: Account not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -157,7 +157,7 @@ paths: type: string style: simple "401": - description: Missing or invalid authentication + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -213,7 +213,7 @@ paths: type: string style: simple "406": - description: Unsupported Accept header. Header needs to be set to application/json + description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -278,7 +278,7 @@ paths: style: simple "500": description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting + in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -297,7 +297,7 @@ paths: type: string style: simple "503": - description: Request timed out. Retry the request in some time + description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -315,59 +315,38 @@ paths: available after successful authentication. type: string style: simple - summary: Get accounts and sub-directories in a directory + summary: Get SPAR account returns type details tags: - Accounts x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: AccountDirectoriesRoot + response-type: SPARAccountsRoot x-accepts: application/json - /analytics/engines/afi/v3/optimizations: - post: - description: "This endpoint creates and runs AFI optimization specified in the\ - \ POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\t\ - Any settings in POST body will act as a one-time override over the settings\ - \ saved in the strategy document." - operationId: postAndOptimize + /analytics/lookups/v3/accounts/{path}: + get: + description: This endpoint looks up all ACCT and ACTM files and sub-directories + in a given directory. + operationId: getAccounts parameters: - - description: Long running deadline in seconds. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. + - description: The directory to get the accounts and sub-directories in explode: false - in: header - name: Cache-Control - required: false + in: path + name: path + required: true schema: + default: "" + description: The directory to get the accounts and sub-directories in type: string style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AFIOptimizationParametersRoot' - description: Optimization Parameters responses: - "202": + "200": content: application/json: schema: - $ref: '#/components/schemas/CalculationInfoRoot' - description: Expected response, contains the poll URL in the Location header. + $ref: '#/components/schemas/AccountDirectoriesRoot' + description: Expected response, returns a list of accounts and directories headers: - Location: - description: URL to poll for the resulting optimization - explode: false - schema: - description: URL to poll for the resulting optimization - type: string - style: simple X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -402,13 +381,12 @@ paths: schema: type: string style: simple - "201": + "400": content: application/json: schema: - $ref: '#/components/schemas/ObjectRoot' - description: Expected response, returns json if optimization is completed - in a short span. + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid query parameter or value provided headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -444,12 +422,12 @@ paths: schema: type: string style: simple - "400": + "404": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid optimization parameters. + description: Path not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -485,12 +463,27 @@ paths: schema: type: string style: simple - "404": - content: - application/json: + "401": + description: Missing or invalid authentication + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: One or more optimization settings were unavailable. + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -526,8 +519,8 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. + "406": + description: Unsupported Accept header. Header needs to be set to application/json headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -545,9 +538,143 @@ paths: available after successful authentication. type: string style: simple - "403": - description: User is forbidden with current credentials + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in some time + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Get accounts and sub-directories in a directory + tags: + - Accounts + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: AccountDirectoriesRoot + x-accepts: application/json + /analytics/engines/afi/v3/optimizations: + post: + description: "This endpoint creates and runs AFI optimization specified in the\ + \ POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\t\ + Any settings in POST body will act as a one-time override over the settings\ + \ saved in the strategy document." + operationId: postAndOptimize + parameters: + - description: Long running deadline in seconds. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + type: integer + style: simple + - description: Standard HTTP header. Accepts max-stale. + explode: false + in: header + name: Cache-Control + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AFIOptimizationParametersRoot' + description: Optimization Parameters + responses: + "202": + content: + application/json: + schema: + $ref: '#/components/schemas/CalculationInfoRoot' + description: Expected response, contains the poll URL in the Location header. headers: + Location: + description: URL to poll for the resulting optimization + explode: false + schema: + description: URL to poll for the resulting optimization + type: string + style: simple X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -582,9 +709,189 @@ paths: schema: type: string style: simple - "415": - description: Missing/Invalid Content-Type header. Header needs to be set - to application/json. + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectRoot' + description: Expected response, returns json if optimization is completed + in a short span. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid optimization parameters. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: One or more optimization settings were unavailable. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "415": + description: Missing/Invalid Content-Type header. Header needs to be set + to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17340,51 +17647,90 @@ paths: - status-code: "200" response-type: GroupRoot x-accepts: application/json - /analytics/engines/npo/v3/optimizations: - post: - description: "This endpoint creates and runs NPO optimization specified in the\ - \ POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\t\ - Any settings in POST body will act as a one-time override over the settings\ - \ saved in the strategy document." - operationId: postAndOptimize + /analytics/engines/pa/v3/linked-templates: + get: + description: This endpoint returns the list of linked PA templates in given + path. + operationId: getLinkedPATemplates parameters: - - description: Long running deadline in seconds. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline + - description: Get linked PA templates in path. + explode: true + in: query + name: directory required: false schema: - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. - explode: false - in: header - name: Cache-Control + description: Get linked PA templates in path. + type: string + style: form + - description: Get linked PA templates for documents in document path + explode: true + in: query + name: documentDirectory required: false schema: + description: Get linked PA templates for documents in document path type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NPOOptimizationParametersRoot' - description: Optimization Parameters + style: form + - description: Get linked PA templates for documents by document name + explode: true + in: query + name: documentName + required: false + schema: + description: Get linked PA templates for documents by document name + type: string + style: form responses: - "202": + "200": content: application/json: schema: - $ref: '#/components/schemas/CalculationInfoRoot' - description: Expected response, contains the poll URL in the Location header. + $ref: '#/components/schemas/LinkedPATemplateSummaryRoot' + description: Expected response, returns a list of templates linked to PA3 + tile. headers: - Location: - description: URL to poll for the resulting optimization + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. explode: false schema: - description: URL to poll for the resulting optimization type: string style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid data provided. Please check the request parameters + before attempting again. + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -17419,13 +17765,12 @@ paths: schema: type: string style: simple - "201": + "404": content: application/json: schema: - $ref: '#/components/schemas/ObjectRoot' - description: Expected response, returns json if optimization is completed - in a short span. + $ref: '#/components/schemas/ClientErrorResponse' + description: Document not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17461,12 +17806,27 @@ paths: schema: type: string style: simple - "400": - content: - application/json: + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid optimization parameters. + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17502,12 +17862,8 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: One or more optimization settings were unavailable. + "406": + description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17543,8 +17899,9 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17562,8 +17919,16 @@ paths: available after successful authentication. type: string style: simple - "403": - description: User is forbidden with current credentials + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17581,27 +17946,60 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. explode: false schema: + description: FactSet's request key header. type: string style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. explode: false schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. type: string style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false + summary: Get linked PA templates + tags: + - LinkedPATemplates + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: LinkedPATemplateSummaryRoot + x-accepts: application/json + post: + description: "This endpoint creates a template from an **existing portfolio\ + \ analysis tile**, allowing the user to replicate and fetch reports settings.\r\ + \n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be passed in POST\ + \ requests and Optional fields are not necessary. \r\n If no mandatory\ + \ fields are passed, then we can use the template as a component and skip\ + \ the component creation.\r\n \r\n* Mandatory, optional and locked fields\ + \ can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"dates\"\ + , \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot override\ + \ the Locked fields when creating the Component.\r\n\r\n* Mandatory and\ + \ locked strings are mutually exclusive.\r\n\r\n* Multi-horizon frequencies\ + \ are not supported through this endpoint." + operationId: createLinkedPATemplates + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LinkedPATemplateParametersRoot' + description: Request Parameters + required: true + responses: + "201": + content: + application/json: schema: - type: string - style: simple - "415": - description: Missing/Invalid Content-Type header. Header needs to be set - to application/json. + $ref: '#/components/schemas/LinkedPATemplatePostSummaryRoot' + description: Expected response, created a template linked to a PA3 tile. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17637,9 +18035,13 @@ paths: schema: type: string style: simple - "429": - description: Rate limit reached. Cancel older requests using Cancel optimization - endpoint or wait for older requests to finish/expire. + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid data provided. Please check the request parameters + before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17675,35 +18077,8 @@ paths: schema: type: string style: simple - Retry-After: - description: Time to wait in seconds before making a new request as - the rate limit has reached. - explode: false - schema: - type: string - style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - "503": - description: Request timed out. Retry the request in sometime. + "401": + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17721,36 +18096,8 @@ paths: available after successful authentication. type: string style: simple - summary: Create and Run NPO optimization - tags: - - NPO Optimizer - x-are-multiple-success-responses-different: true - x-success-response-types: - - status-code: "202" - response-type: CalculationInfoRoot - - status-code: "201" - response-type: ObjectRoot - x-contentType: application/json - x-accepts: application/json - /analytics/engines/npo/v3/optimizations/{id}: - delete: - description: This is the endpoint to cancel a previously submitted optimization. - operationId: cancelOptimizationById - parameters: - - description: from url, provided from the location header in the Create and - Run NPO optimization endpoint - explode: false - in: path - name: id - required: true - schema: - description: from url, provided from the location header in the Create and - Run NPO optimization endpoint - type: string - style: simple - responses: - "204": - description: Expected response, optimization was canceled successfully. + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17786,18 +18133,8 @@ paths: schema: type: string style: simple - "400": - content: - text/plain: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - text/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + "404": + description: Component not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17833,19 +18170,8 @@ paths: schema: type: string style: simple - "404": - content: - text/plain: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - text/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: There was no request for the optimization identifier provided, - or the request was already canceled for the provided identifier. + "406": + description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17881,27 +18207,9 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - "403": - description: User is forbidden with current credentials + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -17919,20 +18227,9 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. explode: false schema: type: string @@ -17976,62 +18273,33 @@ paths: available after successful authentication. type: string style: simple - summary: Cancel NPO optimization by id + summary: Create a linked PA template tags: - - NPO Optimizer + - LinkedPATemplates x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "204" + - status-code: "201" + response-type: LinkedPATemplatePostSummaryRoot + x-contentType: application/json x-accepts: application/json - get: - description: This is the endpoint that returns the optimization parameters passed - for an optimization. - operationId: getOptimizationParameters + /analytics/engines/pa/v3/linked-templates/{id}: + delete: + description: This endpoint deletes an existing linked PA template. + operationId: deleteLinkedPATemplates parameters: - - description: from url, provided from the location header in the Create and - Run NPO optimization endpoint + - description: Unique identifier for a linked PA template explode: false in: path name: id required: true schema: - description: from url, provided from the location header in the Create and - Run NPO optimization endpoint + description: Unique identifier for a linked PA template type: string style: simple responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/NPOOptimizationParametersRoot' - description: Expected response, returns the NPO optimization parameters. + "204": + description: Expected response, deleted the linked PA template successfully. headers: - Content-Encoding: - description: Standard HTTP header. Header value based on Accept-Encoding - Request header. - explode: false - schema: - description: Standard HTTP header. Header value based on Accept-Encoding - Request header. - type: string - style: simple - Content-Type: - description: Standard HTTP header. - explode: false - schema: - description: Standard HTTP header. - type: string - style: simple - Transfer-Encoding: - description: Standard HTTP header. Header value will be set to Chunked - if Accept-Encoding header is specified. - explode: false - schema: - description: Standard HTTP header. Header value will be set to Chunked - if Accept-Encoding header is specified. - type: string - style: simple X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -18068,10 +18336,17 @@ paths: style: simple "400": content: + text/plain: + schema: + $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + text/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid data provided. Please check the request parameters + before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18109,10 +18384,16 @@ paths: style: simple "404": content: + text/plain: + schema: + $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Optimization id not found + text/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Template not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18204,9 +18485,8 @@ paths: schema: type: string style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting + "406": + description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18224,87 +18504,28 @@ paths: available after successful authentication. type: string style: simple - "503": - description: Request timed out. Retry the request in sometime. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. explode: false schema: - description: FactSet's request key header. type: string style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. explode: false schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. type: string style: simple - summary: Get NPO optimization parameters by id - tags: - - NPO Optimizer - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: NPOOptimizationParametersRoot - x-accepts: application/json - put: - description: This endpoint updates and run the NPO optimization specified in - the PUT body parameters. It also allows the creation of new NPO optimization - with custom id. - operationId: putAndOptimize - parameters: - - description: from url, provided from the location header in the Create and - Run NPO optimization endpoint - explode: false - in: path - name: id - required: true - schema: - description: from url, provided from the location header in the Create and - Run NPO optimization endpoint - type: string - style: simple - - description: Long running deadline in seconds. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. - explode: false - in: header - name: Cache-Control - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NPOOptimizationParametersRoot' - description: Optimization Parameters - responses: - "202": - content: - application/json: - schema: - $ref: '#/components/schemas/CalculationInfoRoot' - description: Expected response, contains the poll URL in the Location header. - headers: - Location: - description: URL to poll for the resulting optimization + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. explode: false schema: - description: URL to poll for the resulting optimization type: string style: simple + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -18321,31 +18542,16 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. explode: false schema: type: string style: simple - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/ObjectRoot' - description: Expected response, returns json if optimization is completed - in a short span. + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18363,30 +18569,52 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. explode: false schema: + description: FactSet's request key header. type: string style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. explode: false schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. type: string style: simple - "400": + summary: Delete a linked PA template. + tags: + - LinkedPATemplates + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "204" + x-accepts: application/json + get: + description: This endpoint fetches the linked PA template settings. + operationId: getLinkedPATemplatesById + parameters: + - description: Unique identifier for a linked PA template + explode: false + in: path + name: id + required: true + schema: + description: Unique identifier for a linked PA template + type: string + style: simple + responses: + "200": content: application/json: schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid Optimization Parameters. + $ref: '#/components/schemas/LinkedPATemplateRoot' + description: Expected response, linked PA template details. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18422,12 +18650,13 @@ paths: schema: type: string style: simple - "404": + "400": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: One or more optimization settings were unavailable. + description: Invalid data provided. Please check the request parameters + before attempting again. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18463,12 +18692,12 @@ paths: schema: type: string style: simple - "409": + "404": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Duplicate optimization exists with same parameters. + description: Template not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18560,9 +18789,8 @@ paths: schema: type: string style: simple - "415": - description: Missing/Invalid Content-Type header. Header needs to be set - to application/json. + "406": + description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18599,8 +18827,8 @@ paths: type: string style: simple "429": - description: Rate limit reached. Cancel older requests using Cancel optimization - endpoint or wait for older requests to finish/expire. + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18618,24 +18846,6 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple Retry-After: description: Time to wait in seconds before making a new request as the rate limit has reached. @@ -18682,44 +18892,50 @@ paths: available after successful authentication. type: string style: simple - summary: Create or Update NPO optimization and run it. + summary: Get linked PA template by id tags: - - NPO Optimizer - x-are-multiple-success-responses-different: true + - LinkedPATemplates + x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "202" - response-type: CalculationInfoRoot - - status-code: "201" - response-type: ObjectRoot - x-contentType: application/json + - status-code: "200" + response-type: LinkedPATemplateRoot x-accepts: application/json - /analytics/engines/npo/v3/optimizations/{id}/status: - get: - description: "This is the endpoint to check on the progress of a previously\ - \ requested optimization.\r\nIf the optimization has finished computing, the\ - \ body of the response will contain result in JSON.\r\nOtherwise, the optimization\ - \ is still running and the X-FactSet-Api-PickUp-Progress header will contain\ - \ a progress percentage." - operationId: getOptimizationStatusById + put: + description: "This endpoint allows the user to change the request body and description\ + \ from an existing template.\r\n\r\nRemarks:\r\n\r\n* Mandatory fields are\ + \ required to be passed in POST requests and Optional fields are not necessary.\ + \ \r\n If no mandatory fields are passed, then we can use the template\ + \ as a component and skip the component creation.\r\n \r\n* Mandatory,\ + \ optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\"\ + , \"columns\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\ + \r\n* We cannot override the Locked fields when creating the Component.\r\ + \n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* \ + \ Multi-horizon frequencies are not supported through this endpoint." + operationId: updateLinkedPATemplates parameters: - - description: from url, provided from the location header in the Create and - Run NPO optimization endpoint + - description: Unique identifier for a linked PA template explode: false in: path name: id required: true schema: - description: from url, provided from the location header in the Create and - Run NPO optimization endpoint + description: Unique identifier for a linked PA template type: string style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LinkedPATemplateUpdateParametersRoot' + description: Request Parameters + required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/ObjectRoot' - description: Expected response once optimization is completed, returns JSON. + $ref: '#/components/schemas/LinkedPATemplatePostSummaryRoot' + description: Expected response, updated a template linked to a PA3 tile. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18755,26 +18971,55 @@ paths: schema: type: string style: simple - "202": - description: Expected response returned if the optimization is not yet completed, - should contain X-FactSet-Api-PickUp-Progress header. + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid data provided. Please check the request parameters + before attempting again. headers: - X-FactSet-Api-PickUp-Progress: - description: FactSet's progress header. + X-DataDirect-Request-Key: + description: FactSet's request key header. explode: false schema: - description: FactSet's progress header. + description: FactSet's request key header. type: string style: simple - Cache-Control: - description: Standard HTTP header. Header will specify max-age in seconds. - Polling can be adjusted based on the max-age value. + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. explode: false schema: - description: Standard HTTP header. Header will specify max-age in - seconds. Polling can be adjusted based on the max-age value. - type: integer + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Template or component not found. + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -18809,12 +19054,27 @@ paths: schema: type: string style: simple - "400": - content: - application/json: + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18850,13 +19110,8 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Optimization result was already returned, provided id was not - a requested optimization, or the optimization was cancelled + "406": + description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18892,27 +19147,9 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - "403": - description: User is forbidden with current credentials + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18930,27 +19167,16 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. explode: false schema: type: string style: simple "500": description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting + in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -18987,65 +19213,102 @@ paths: available after successful authentication. type: string style: simple - summary: Get NPO optimization status by id + summary: Update a linked PA template tags: - - NPO Optimizer - x-are-multiple-success-responses-different: true + - LinkedPATemplates + x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "201" - response-type: ObjectRoot - - status-code: "202" + - status-code: "200" + response-type: LinkedPATemplatePostSummaryRoot + x-contentType: application/json x-accepts: application/json - /analytics/engines/npo/v3/optimizations/{id}/result: - get: - description: This is the endpoint to get the result of a previously requested - optimization. - operationId: getOptimizationResult + /analytics/engines/npo/v3/optimizations: + post: + description: "This endpoint creates and runs NPO optimization specified in the\ + \ POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\t\ + Any settings in POST body will act as a one-time override over the settings\ + \ saved in the strategy document." + operationId: postAndOptimize parameters: - - description: from url, provided from the location header in the Get NPO optimization - status by id endpoint + - description: Long running deadline in seconds. explode: false - in: path - name: id - required: true + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + type: integer + style: simple + - description: Standard HTTP header. Accepts max-stale. + explode: false + in: header + name: Cache-Control + required: false schema: - description: from url, provided from the location header in the Get NPO - optimization status by id endpoint type: string style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NPOOptimizationParametersRoot' + description: Optimization Parameters responses: - "200": + "202": content: application/json: schema: - $ref: '#/components/schemas/ObjectRoot' - description: Expected response once optimization is completed, returns JSON. + $ref: '#/components/schemas/CalculationInfoRoot' + description: Expected response, contains the poll URL in the Location header. headers: - Content-Encoding: - description: Standard HTTP header. Header value based on Accept-Encoding - Request header. + Location: + description: URL to poll for the resulting optimization explode: false schema: - description: Standard HTTP header. Header value based on Accept-Encoding - Request header. + description: URL to poll for the resulting optimization type: string style: simple - Content-Type: - description: Standard HTTP header. + X-DataDirect-Request-Key: + description: FactSet's request key header. explode: false schema: - description: Standard HTTP header. + description: FactSet's request key header. type: string style: simple - Transfer-Encoding: - description: Standard HTTP header. Header value will be set to Chunked - if Accept-Encoding header is specified. + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. explode: false schema: - description: Standard HTTP header. Header value will be set to Chunked - if Accept-Encoding header is specified. + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. type: string style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectRoot' + description: Expected response, returns json if optimization is completed + in a short span. + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -19085,7 +19348,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + description: Invalid optimization parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -19126,8 +19389,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Optimization result was already returned, provided id was not - a requested optimization, or the optimization was cancelled + description: One or more optimization settings were unavailable. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -19219,9 +19481,9 @@ paths: schema: type: string style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting + "415": + description: Missing/Invalid Content-Type header. Header needs to be set + to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -19239,82 +19501,28 @@ paths: available after successful authentication. type: string style: simple - "503": - description: Request timed out. Retry the request in sometime. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. explode: false schema: - description: FactSet's request key header. type: string style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. explode: false schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. type: string style: simple - summary: Get NPO optimization result by id - tags: - - NPO Optimizer - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: ObjectRoot - x-accepts: application/json - /analytics/engines/pa/v3/calculations: - post: - description: "This endpoint runs the PA calculation specified in the POST body\ - \ parameters.\r\nIt can take one or more calculation units as input.\r\n\r\ - \nRemarks:\r\n\r\n*\tAny settings in POST body will act as a one-time override\ - \ over the settings saved in the PA template." - operationId: postAndCalculate - parameters: - - description: Long running deadline in seconds when only one unit is passed - in the POST body. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. - explode: false - in: header - name: Cache-Control - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PACalculationParametersRoot' - description: Calculation Parameters - responses: - "202": - content: - application/json: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - application/x-protobuf: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, contains the poll URL in the Location header. - headers: - Location: - description: URL to poll for the resulting calculation + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. explode: false schema: - description: URL to poll for the resulting calculation type: string style: simple + "429": + description: Rate limit reached. Cancel older requests using Cancel optimization + endpoint or wait for older requests to finish/expire. + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -19349,17 +19557,16 @@ paths: schema: type: string style: simple - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/ObjectRoot' - application/x-protobuf: + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false schema: - $ref: '#/components/schemas/ObjectRoot' - description: 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. + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -19377,34 +19584,55 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. explode: false schema: + description: FactSet's request key header. type: string style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. explode: false schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. type: string style: simple - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - application/x-protobuf: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, if the calculation has one unit and is completed - with an error. + summary: Create and Run NPO optimization + tags: + - NPO Optimizer + x-are-multiple-success-responses-different: true + x-success-response-types: + - status-code: "202" + response-type: CalculationInfoRoot + - status-code: "201" + response-type: ObjectRoot + x-contentType: application/json + x-accepts: application/json + /analytics/engines/npo/v3/optimizations/{id}: + delete: + description: This is the endpoint to cancel a previously submitted optimization. + operationId: cancelOptimizationById + parameters: + - description: from url, provided from the location header in the Create and + Run NPO optimization endpoint + explode: false + in: path + name: id + required: true + schema: + description: from url, provided from the location header in the Create and + Run NPO optimization endpoint + type: string + style: simple + responses: + "204": + description: Expected response, optimization was canceled successfully. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -19442,13 +19670,16 @@ paths: style: simple "400": content: + text/plain: + schema: + $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: + text/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid calculation parameters. + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -19486,13 +19717,17 @@ paths: style: simple "404": content: + text/plain: + schema: + $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: + text/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: One or more calculation settings were unavailable. + description: There was no request for the optimization identifier provided, + or the request was already canceled for the provided identifier. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -19584,89 +19819,6 @@ paths: schema: type: string style: simple - "415": - description: Missing/Invalid Content-Type header. Header needs to be set - to application/json. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple - "429": - description: Rate limit reached. Cancel older requests using Cancel Calculation - endpoint or wait for older requests to finish/expire. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple - Retry-After: - description: Time to wait in seconds before making a new request as - the rate limit has reached. - explode: false - schema: - type: string - style: simple "500": description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. @@ -19706,39 +19858,62 @@ paths: available after successful authentication. type: string style: simple - summary: Create and Run PA calculation + summary: Cancel NPO optimization by id tags: - - PACalculations - x-are-multiple-success-responses-different: true + - NPO Optimizer + x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "202" - response-type: CalculationStatusRoot - - status-code: "201" - response-type: ObjectRoot - - status-code: "200" - response-type: CalculationStatusRoot - x-contentType: application/json + - status-code: "204" x-accepts: application/json - /analytics/engines/pa/v3/calculations/{id}: - delete: - description: This is the endpoint to cancel a previously submitted calculation. - operationId: cancelCalculationById + get: + description: This is the endpoint that returns the optimization parameters passed + for an optimization. + operationId: getOptimizationParameters parameters: - description: from url, provided from the location header in the Create and - Run PA calculation endpoint + Run NPO optimization endpoint explode: false in: path name: id required: true schema: description: from url, provided from the location header in the Create and - Run PA calculation endpoint + Run NPO optimization endpoint type: string style: simple responses: - "204": - description: Expected response, calculation was canceled successfully. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/NPOOptimizationParametersRoot' + description: Expected response, returns the NPO optimization parameters. headers: + Content-Encoding: + description: Standard HTTP header. Header value based on Accept-Encoding + Request header. + explode: false + schema: + description: Standard HTTP header. Header value based on Accept-Encoding + Request header. + type: string + style: simple + Content-Type: + description: Standard HTTP header. + explode: false + schema: + description: Standard HTTP header. + type: string + style: simple + Transfer-Encoding: + description: Standard HTTP header. Header value will be set to Chunked + if Accept-Encoding header is specified. + explode: false + schema: + description: Standard HTTP header. Header value will be set to Chunked + if Accept-Encoding header is specified. + type: string + style: simple X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -19775,15 +19950,9 @@ paths: style: simple "400": content: - text/plain: - schema: - $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - text/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' description: Invalid identifier provided. headers: X-DataDirect-Request-Key: @@ -19822,17 +19991,10 @@ paths: style: simple "404": content: - text/plain: - schema: - $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - text/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: There was no request for the calculation identifier provided, - or the request was already canceled for the provided identifier. + description: Optimization id not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -19926,7 +20088,7 @@ paths: style: simple "500": description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting. + in troubleshooting headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -19963,62 +20125,110 @@ paths: available after successful authentication. type: string style: simple - summary: Cancel PA calculation by id + summary: Get NPO optimization parameters by id tags: - - PACalculations + - NPO Optimizer x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "204" + - status-code: "200" + response-type: NPOOptimizationParametersRoot x-accepts: application/json - get: - description: This is the endpoint that returns the calculation parameters passed - for a calculation. - operationId: getCalculationParameters + put: + description: This endpoint updates and run the NPO optimization specified in + the PUT body parameters. It also allows the creation of new NPO optimization + with custom id. + operationId: putAndOptimize parameters: - description: from url, provided from the location header in the Create and - Run PA calculation endpoint + Run NPO optimization endpoint explode: false in: path name: id required: true schema: description: from url, provided from the location header in the Create and - Run PA calculation endpoint + Run NPO optimization endpoint + type: string + style: simple + - description: Long running deadline in seconds. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + type: integer + style: simple + - description: Standard HTTP header. Accepts max-stale. + explode: false + in: header + name: Cache-Control + required: false + schema: type: string style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NPOOptimizationParametersRoot' + description: Optimization Parameters responses: - "200": + "202": content: application/json: schema: - $ref: '#/components/schemas/PACalculationParametersRoot' - description: Expected response, returns the PA calculation parameters. + $ref: '#/components/schemas/CalculationInfoRoot' + description: Expected response, contains the poll URL in the Location header. headers: - Content-Encoding: - description: Standard HTTP header. Header value based on Accept-Encoding - Request header. + Location: + description: URL to poll for the resulting optimization explode: false schema: - description: Standard HTTP header. Header value based on Accept-Encoding - Request header. + description: URL to poll for the resulting optimization type: string style: simple - Content-Type: - description: Standard HTTP header. + X-DataDirect-Request-Key: + description: FactSet's request key header. explode: false schema: - description: Standard HTTP header. + description: FactSet's request key header. type: string style: simple - Transfer-Encoding: - description: Standard HTTP header. Header value will be set to Chunked - if Accept-Encoding header is specified. + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. explode: false schema: - description: Standard HTTP header. Header value will be set to Chunked - if Accept-Encoding header is specified. type: string style: simple + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectRoot' + description: Expected response, returns json if optimization is completed + in a short span. + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -20058,7 +20268,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + description: Invalid Optimization Parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20099,7 +20309,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Calculation id not found + description: One or more optimization settings were unavailable. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20135,27 +20345,12 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false + "409": + content: + application/json: schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - "403": - description: User is forbidden with current credentials + $ref: '#/components/schemas/ClientErrorResponse' + description: Duplicate optimization exists with same parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20191,9 +20386,8 @@ paths: schema: type: string style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting + "401": + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20211,8 +20405,8 @@ paths: available after successful authentication. type: string style: simple - "503": - description: Request timed out. Retry the request in sometime. + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20230,74 +20424,28 @@ paths: available after successful authentication. type: string style: simple - summary: Get PA calculation parameters by id - tags: - - PACalculations - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: PACalculationParametersRoot - x-accepts: application/json - put: - description: "This endpoint updates and run the PA calculation specified in\ - \ the PUT body parameters. This also allows creating new PA calculations with\ - \ custom ids.\r\nIt can take one or more calculation units as input.\r\n\r\ - \nRemarks:\r\n\r\n*\tAny settings in PUT body will act as a one-time override\ - \ over the settings saved in the PA template." - operationId: putAndCalculate - parameters: - - description: from url, provided from the location header in the Create and - Run PA calculation endpoint - explode: false - in: path - name: id - required: true - schema: - description: from url, provided from the location header in the Create and - Run PA calculation endpoint - type: string - style: simple - - description: Long running deadline in seconds when only one unit is passed - in the PUT body. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. - explode: false - in: header - name: Cache-Control - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PACalculationParametersRoot' - description: Calculation Parameters - responses: - "202": - content: - application/json: + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false schema: - $ref: '#/components/schemas/CalculationStatusRoot' - application/x-protobuf: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, contains the poll URL in the Location header. - headers: - Location: - description: URL to poll for the resulting calculation + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. explode: false schema: - description: URL to poll for the resulting calculation type: string style: simple + "415": + description: Missing/Invalid Content-Type header. Header needs to be set + to application/json. + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -20332,16 +20480,9 @@ paths: schema: type: string style: simple - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - application/x-protobuf: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, if the calculation has one unit and is completed - with an error. + "429": + description: Rate limit reached. Cancel older requests using Cancel optimization + endpoint or wait for older requests to finish/expire. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20377,17 +20518,16 @@ paths: schema: type: string style: simple - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/ObjectRoot' - application/x-protobuf: + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false schema: - $ref: '#/components/schemas/ObjectRoot' - description: 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. + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20405,33 +20545,63 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. explode: false schema: + description: FactSet's request key header. type: string style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. explode: false schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. type: string style: simple - "400": + summary: Create or Update NPO optimization and run it. + tags: + - NPO Optimizer + x-are-multiple-success-responses-different: true + x-success-response-types: + - status-code: "202" + response-type: CalculationInfoRoot + - status-code: "201" + response-type: ObjectRoot + x-contentType: application/json + x-accepts: application/json + /analytics/engines/npo/v3/optimizations/{id}/status: + get: + description: "This is the endpoint to check on the progress of a previously\ + \ requested optimization.\r\nIf the optimization has finished computing, the\ + \ body of the response will contain result in JSON.\r\nOtherwise, the optimization\ + \ is still running and the X-FactSet-Api-PickUp-Progress header will contain\ + \ a progress percentage." + operationId: getOptimizationStatusById + parameters: + - description: from url, provided from the location header in the Create and + Run NPO optimization endpoint + explode: false + in: path + name: id + required: true + schema: + description: from url, provided from the location header in the Create and + Run NPO optimization endpoint + type: string + style: simple + responses: + "201": content: application/json: schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid Calculation Parameters. + $ref: '#/components/schemas/ObjectRoot' + description: Expected response once optimization is completed, returns JSON. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20467,16 +20637,26 @@ paths: schema: type: string style: simple - "404": - content: - application/json: + "202": + description: Expected response returned if the optimization is not yet completed, + should contain X-FactSet-Api-PickUp-Progress header. + headers: + X-FactSet-Api-PickUp-Progress: + description: FactSet's progress header. + explode: false schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: + description: FactSet's progress header. + type: string + style: simple + Cache-Control: + description: Standard HTTP header. Header will specify max-age in seconds. + Polling can be adjusted based on the max-age value. + explode: false schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: One or more calculation settings were unavailable. - headers: + description: Standard HTTP header. Header will specify max-age in + seconds. Polling can be adjusted based on the max-age value. + type: integer + style: simple X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -20511,15 +20691,12 @@ paths: schema: type: string style: simple - "409": + "400": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Duplicate calculation exists with same parameters. + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20555,27 +20732,13 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false + "404": + content: + application/json: schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - "403": - description: User is forbidden with current credentials + $ref: '#/components/schemas/ClientErrorResponse' + description: Optimization result was already returned, provided id was not + a requested optimization, or the optimization was cancelled headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20611,9 +20774,8 @@ paths: schema: type: string style: simple - "415": - description: Missing/Invalid Content-Type header. Header needs to be set - to application/json. + "401": + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20631,27 +20793,8 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple - "429": - description: Rate limit reached. Cancel older requests using Cancel Calculation - endpoint or wait for older requests to finish/expire. + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20687,16 +20830,9 @@ paths: schema: type: string style: simple - Retry-After: - description: Time to wait in seconds before making a new request as - the rate limit has reached. - explode: false - schema: - type: string - style: simple "500": description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting. + in troubleshooting headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -20733,37 +20869,30 @@ paths: available after successful authentication. type: string style: simple - summary: Create or Update PA calculation and run it. + summary: Get NPO optimization status by id tags: - - PACalculations + - NPO Optimizer x-are-multiple-success-responses-different: true x-success-response-types: - - status-code: "202" - response-type: CalculationStatusRoot - - status-code: "200" - response-type: CalculationStatusRoot - status-code: "201" response-type: ObjectRoot - x-contentType: application/json + - status-code: "202" x-accepts: application/json - /analytics/engines/pa/v3/calculations/{id}/status: + /analytics/engines/npo/v3/optimizations/{id}/result: get: - description: "This is the endpoint to check on the progress of a previously\ - \ requested calculation.\r\nIf the calculation has finished computing, the\ - \ location header will point to the result url.\r\nOtherwise, the calculation\ - \ is still running and the X-FactSet-Api-PickUp-Progress header will contain\ - \ a progress percentage." - operationId: getCalculationStatusById + description: This is the endpoint to get the result of a previously requested + optimization. + operationId: getOptimizationResult parameters: - - description: from url, provided from the location header in the Create and - Run PA calculation endpoint + - description: from url, provided from the location header in the Get NPO optimization + status by id endpoint explode: false in: path name: id required: true schema: - description: from url, provided from the location header in the Create and - Run PA calculation endpoint + description: from url, provided from the location header in the Get NPO + optimization status by id endpoint type: string style: simple responses: @@ -20771,8 +20900,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response once calculation is completed. + $ref: '#/components/schemas/ObjectRoot' + description: Expected response once optimization is completed, returns JSON. headers: Content-Encoding: description: Standard HTTP header. Header value based on Accept-Encoding @@ -20833,64 +20962,6 @@ paths: schema: type: string style: simple - "202": - content: - application/json: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response returned if the calculation is not yet completed, - should contain X-FactSet-Api-PickUp-Progress header. - headers: - X-FactSet-Api-PickUp-Progress: - description: FactSet's progress header. - explode: false - schema: - description: FactSet's progress header. - type: string - style: simple - Cache-Control: - description: Standard HTTP header. Header will specify max-age in seconds. - Polling can be adjusted based on the max-age value. - explode: false - schema: - description: Standard HTTP header. Header will specify max-age in - seconds. Polling can be adjusted based on the max-age value. - type: integer - style: simple - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple "400": content: application/json: @@ -20937,8 +21008,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Calculation was already returned, provided id was not a requested - calculation, or the calculation was cancelled + description: Optimization result was already returned, provided id was not + a requested optimization, or the optimization was cancelled headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -21069,312 +21140,20 @@ paths: available after successful authentication. type: string style: simple - summary: Get PA calculation status by id - tags: - - PACalculations - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: CalculationStatusRoot - - status-code: "202" - response-type: CalculationStatusRoot - x-accepts: application/json - /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result: - get: - description: "This is the endpoint to get the result of a previously requested\ - \ calculation.\r\nIf the calculation has finished computing, the body of the\ - \ response will contain the requested document in JSON." - operationId: getCalculationUnitResultById - parameters: - - description: from url, provided from the location header in the Get PA calculation - status by id endpoint - explode: false - in: path - name: id - required: true - schema: - description: from url, provided from the location header in the Get PA calculation - status by id endpoint - type: string - style: simple - - description: from url, provided from the location header in the Get PA calculation - status by id endpoint - explode: false - in: path - name: unitId - required: true - schema: - description: from url, provided from the location header in the Get PA calculation - status by id endpoint - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ObjectRoot' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ObjectRoot' - description: Expected response once calculation is completed, returns JSON - in the format specified in the Calculation parameters. - headers: - Content-Encoding: - description: Standard HTTP header. Header value based on Accept-Encoding - Request header. - explode: false - schema: - description: Standard HTTP header. Header value based on Accept-Encoding - Request header. - type: string - style: simple - Content-Type: - description: Standard HTTP header. - explode: false - schema: - description: Standard HTTP header. - type: string - style: simple - Transfer-Encoding: - description: Standard HTTP header. Header value will be set to Chunked - if Accept-Encoding header is specified. - explode: false - schema: - description: Standard HTTP header. Header value will be set to Chunked - if Accept-Encoding header is specified. - type: string - style: simple - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Calculation was already returned, provided id was not a requested - calculation, or the calculation was cancelled - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple - "401": - description: Missing or invalid authentication. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - "403": - description: User is forbidden with current credentials - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - "503": - description: Request timed out. Retry the request in sometime. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - summary: Get PA calculation result by id + summary: Get NPO optimization result by id tags: - - PACalculations + - NPO Optimizer x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" response-type: ObjectRoot x-accepts: application/json - /analytics/engines/pub/v3/calculations: + /analytics/engines/pa/v3/calculations: post: - description: "This endpoint runs the Pub calculation specified in the POST body\ - \ parameters.\r\nIt can take one or more units as input." + description: "This endpoint runs the PA calculation specified in the POST body\ + \ parameters.\r\nIt can take one or more calculation units as input.\r\n\r\ + \nRemarks:\r\n\r\n*\tAny settings in POST body will act as a one-time override\ + \ over the settings saved in the PA template." operationId: postAndCalculate parameters: - description: Long running deadline in seconds when only one unit is passed @@ -21398,15 +21177,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PubCalculationParametersRoot' + $ref: '#/components/schemas/PACalculationParametersRoot' description: Calculation Parameters responses: "202": content: - application/pdf: + application/json: schema: $ref: '#/components/schemas/CalculationStatusRoot' - application/vnd.openxmlformats-officedocument.presentationml.presentation: + application/x-protobuf: schema: $ref: '#/components/schemas/CalculationStatusRoot' description: Expected response, contains the poll URL in the Location header. @@ -21452,16 +21231,17 @@ paths: schema: type: string style: simple - "200": + "201": content: - application/pdf: + application/json: schema: - $ref: '#/components/schemas/CalculationStatusRoot' - application/vnd.openxmlformats-officedocument.presentationml.presentation: + $ref: '#/components/schemas/ObjectRoot' + application/x-protobuf: schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, if the calculation has one unit and is completed - with an error. + $ref: '#/components/schemas/ObjectRoot' + description: 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. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -21497,19 +21277,16 @@ paths: schema: type: string style: simple - "201": + "200": content: - application/pdf: + application/json: schema: - format: binary - type: string - application/vnd.openxmlformats-officedocument.presentationml.presentation: + $ref: '#/components/schemas/CalculationStatusRoot' + application/x-protobuf: schema: - format: binary - type: string - description: 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. + $ref: '#/components/schemas/CalculationStatusRoot' + description: Expected response, if the calculation has one unit and is completed + with an error. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -21547,10 +21324,10 @@ paths: style: simple "400": content: - application/pdf: + application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/vnd.openxmlformats-officedocument.presentationml.presentation: + application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' description: Invalid calculation parameters. @@ -21591,10 +21368,10 @@ paths: style: simple "404": content: - application/pdf: + application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/vnd.openxmlformats-officedocument.presentationml.presentation: + application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' description: One or more calculation settings were unavailable. @@ -21811,33 +21588,33 @@ paths: available after successful authentication. type: string style: simple - summary: Create and Run Pub calculation + summary: Create and Run PA calculation tags: - - PubCalculations + - PACalculations x-are-multiple-success-responses-different: true x-success-response-types: - status-code: "202" response-type: CalculationStatusRoot + - status-code: "201" + response-type: ObjectRoot - status-code: "200" response-type: CalculationStatusRoot - - status-code: "201" - is-file: true x-contentType: application/json - x-accepts: application/pdf,application/vnd.openxmlformats-officedocument.presentationml.presentation - /analytics/engines/pub/v3/calculations/{id}: + x-accepts: application/json + /analytics/engines/pa/v3/calculations/{id}: delete: description: This is the endpoint to cancel a previously submitted calculation. operationId: cancelCalculationById parameters: - description: from url, provided from the location header in the Create and - Run Pub calculation endpoint + Run PA calculation endpoint explode: false in: path name: id required: true schema: description: from url, provided from the location header in the Create and - Run Pub calculation endpoint + Run PA calculation endpoint type: string style: simple responses: @@ -22068,9 +21845,9 @@ paths: available after successful authentication. type: string style: simple - summary: Cancel Pub calculation by id + summary: Cancel PA calculation by id tags: - - PubCalculations + - PACalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "204" @@ -22081,14 +21858,14 @@ paths: operationId: getCalculationParameters parameters: - description: from url, provided from the location header in the Create and - Run Pub calculation endpoint + Run PA calculation endpoint explode: false in: path name: id required: true schema: description: from url, provided from the location header in the Create and - Run Pub calculation endpoint + Run PA calculation endpoint type: string style: simple responses: @@ -22096,8 +21873,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PubCalculationParametersRoot' - description: Expected response, returns the Pub calculation parameters. + $ref: '#/components/schemas/PACalculationParametersRoot' + description: Expected response, returns the PA calculation parameters. headers: Content-Encoding: description: Standard HTTP header. Header value based on Accept-Encoding @@ -22335,31 +22112,31 @@ paths: available after successful authentication. type: string style: simple - summary: Get Pub calculation parameters by id + summary: Get PA calculation parameters by id tags: - - PubCalculations + - PACalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: PubCalculationParametersRoot + response-type: PACalculationParametersRoot x-accepts: application/json put: - description: "This endpoint updates and run the Pub calculation specified in\ - \ the PUT body parameters. This also allows creating new Pub calculations\ - \ with custom ids.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\ - \n\r\n* Start and and end date must be within the configuration's min and\ - \ max date range" + description: "This endpoint updates and run the PA calculation specified in\ + \ the PUT body parameters. This also allows creating new PA calculations with\ + \ custom ids.\r\nIt can take one or more calculation units as input.\r\n\r\ + \nRemarks:\r\n\r\n*\tAny settings in PUT body will act as a one-time override\ + \ over the settings saved in the PA template." operationId: putAndCalculate parameters: - description: from url, provided from the location header in the Create and - Run Pub calculation endpoint + Run PA calculation endpoint explode: false in: path name: id required: true schema: description: from url, provided from the location header in the Create and - Run Pub calculation endpoint + Run PA calculation endpoint type: string style: simple - description: Long running deadline in seconds when only one unit is passed @@ -22383,12 +22160,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PubCalculationParametersRoot' + $ref: '#/components/schemas/PACalculationParametersRoot' description: Calculation Parameters responses: "202": content: - application/pdf: + application/json: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + application/x-protobuf: schema: $ref: '#/components/schemas/CalculationStatusRoot' description: Expected response, contains the poll URL in the Location header. @@ -22416,20 +22196,6 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FI request limit. - explode: false - schema: - description: Maximum FI request limit. - type: string - style: simple - X-FactSet-Api-Calculations-Remaining: - description: Number of FI requests remaining till request limit reached. - explode: false - schema: - description: Number of FI requests remaining till request limit reached. - type: string - style: simple X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. explode: false @@ -22450,7 +22216,10 @@ paths: style: simple "200": content: - application/pdf: + application/json: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + application/x-protobuf: schema: $ref: '#/components/schemas/CalculationStatusRoot' description: Expected response, if the calculation has one unit and is completed @@ -22472,20 +22241,6 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FI request limit. - explode: false - schema: - description: Maximum FI request limit. - type: string - style: simple - X-FactSet-Api-Calculations-Remaining: - description: Number of FI requests remaining till request limit reached. - explode: false - schema: - description: Number of FI requests remaining till request limit reached. - type: string - style: simple X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. explode: false @@ -22506,10 +22261,12 @@ paths: style: simple "201": content: - application/pdf: + application/json: schema: - format: binary - type: string + $ref: '#/components/schemas/ObjectRoot' + application/x-protobuf: + schema: + $ref: '#/components/schemas/ObjectRoot' description: 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. @@ -22530,20 +22287,6 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FI request limit. - explode: false - schema: - description: Maximum FI request limit. - type: string - style: simple - X-FactSet-Api-Calculations-Remaining: - description: Number of FI requests remaining till request limit reached. - explode: false - schema: - description: Number of FI requests remaining till request limit reached. - type: string - style: simple X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. explode: false @@ -22564,7 +22307,10 @@ paths: style: simple "400": content: - application/pdf: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' description: Invalid Calculation Parameters. @@ -22585,20 +22331,6 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FI request limit. - explode: false - schema: - description: Maximum FI request limit. - type: string - style: simple - X-FactSet-Api-Calculations-Remaining: - description: Number of FI requests remaining till request limit reached. - explode: false - schema: - description: Number of FI requests remaining till request limit reached. - type: string - style: simple X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. explode: false @@ -22619,7 +22351,10 @@ paths: style: simple "404": content: - application/pdf: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' description: One or more calculation settings were unavailable. @@ -22640,20 +22375,6 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FI request limit. - explode: false - schema: - description: Maximum FI request limit. - type: string - style: simple - X-FactSet-Api-Calculations-Remaining: - description: Number of FI requests remaining till request limit reached. - explode: false - schema: - description: Number of FI requests remaining till request limit reached. - type: string - style: simple X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. explode: false @@ -22674,7 +22395,10 @@ paths: style: simple "409": content: - application/pdf: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' description: Duplicate calculation exists with same parameters. @@ -22695,20 +22419,6 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FI request limit. - explode: false - schema: - description: Maximum FI request limit. - type: string - style: simple - X-FactSet-Api-Calculations-Remaining: - description: Number of FI requests remaining till request limit reached. - explode: false - schema: - description: Number of FI requests remaining till request limit reached. - type: string - style: simple X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. explode: false @@ -22746,20 +22456,6 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FI request limit. - explode: false - schema: - description: Maximum FI request limit. - type: string - style: simple - X-FactSet-Api-Calculations-Remaining: - description: Number of FI requests remaining till request limit reached. - explode: false - schema: - description: Number of FI requests remaining till request limit reached. - type: string - style: simple "403": description: User is forbidden with current credentials headers: @@ -22779,20 +22475,6 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FI request limit. - explode: false - schema: - description: Maximum FI request limit. - type: string - style: simple - X-FactSet-Api-Calculations-Remaining: - description: Number of FI requests remaining till request limit reached. - explode: false - schema: - description: Number of FI requests remaining till request limit reached. - type: string - style: simple X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. explode: false @@ -22831,20 +22513,6 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FI request limit. - explode: false - schema: - description: Maximum FI request limit. - type: string - style: simple - X-FactSet-Api-Calculations-Remaining: - description: Number of FI requests remaining till request limit reached. - explode: false - schema: - description: Number of FI requests remaining till request limit reached. - type: string - style: simple X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. explode: false @@ -22883,20 +22551,6 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FI request limit. - explode: false - schema: - description: Maximum FI request limit. - type: string - style: simple - X-FactSet-Api-Calculations-Remaining: - description: Number of FI requests remaining till request limit reached. - explode: false - schema: - description: Number of FI requests remaining till request limit reached. - type: string - style: simple X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. explode: false @@ -22942,20 +22596,6 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FI request limit. - explode: false - schema: - description: Maximum FI request limit. - type: string - style: simple - X-FactSet-Api-Calculations-Remaining: - description: Number of FI requests remaining till request limit reached. - explode: false - schema: - description: Number of FI requests remaining till request limit reached. - type: string - style: simple "503": description: Request timed out. Retry the request in sometime. headers: @@ -22975,23 +22615,9 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-Calculations-Limit: - description: Maximum FI request limit. - explode: false - schema: - description: Maximum FI request limit. - type: string - style: simple - X-FactSet-Api-Calculations-Remaining: - description: Number of FI requests remaining till request limit reached. - explode: false - schema: - description: Number of FI requests remaining till request limit reached. - type: string - style: simple - summary: Create or Update Pub calculation and run it. + summary: Create or Update PA calculation and run it. tags: - - PubCalculations + - PACalculations x-are-multiple-success-responses-different: true x-success-response-types: - status-code: "202" @@ -22999,25 +22625,27 @@ paths: - status-code: "200" response-type: CalculationStatusRoot - status-code: "201" - is-file: true + response-type: ObjectRoot x-contentType: application/json - x-accepts: application/pdf - /analytics/engines/pub/v3/calculations/{id}/status: + x-accepts: application/json + /analytics/engines/pa/v3/calculations/{id}/status: get: description: "This is the endpoint to check on the progress of a previously\ \ requested calculation.\r\nIf the calculation has finished computing, the\ - \ location header will point to the result url." + \ location header will point to the result url.\r\nOtherwise, the calculation\ + \ is still running and the X-FactSet-Api-PickUp-Progress header will contain\ + \ a progress percentage." operationId: getCalculationStatusById parameters: - description: from url, provided from the location header in the Create and - Run Pub calculation endpoint + Run PA calculation endpoint explode: false in: path name: id required: true schema: description: from url, provided from the location header in the Create and - Run Pub calculation endpoint + Run PA calculation endpoint type: string style: simple responses: @@ -23092,7 +22720,8 @@ paths: application/json: schema: $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response returned if the calculation is not yet completed. + description: Expected response returned if the calculation is not yet completed, + should contain X-FactSet-Api-PickUp-Progress header. headers: X-FactSet-Api-PickUp-Progress: description: FactSet's progress header. @@ -23322,9 +22951,9 @@ paths: available after successful authentication. type: string style: simple - summary: Get Pub calculation status by id + summary: Get PA calculation status by id tags: - - PubCalculations + - PACalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" @@ -23332,33 +22961,33 @@ paths: - status-code: "202" response-type: CalculationStatusRoot x-accepts: application/json - /analytics/engines/pub/v3/calculations/{id}/units/{unitId}/result: + /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result: get: description: "This is the endpoint to get the result of a previously requested\ \ calculation.\r\nIf the calculation has finished computing, the body of the\ - \ response will contain the requested document in the specified format." + \ response will contain the requested document in JSON." operationId: getCalculationUnitResultById parameters: - - description: from url, provided from the location header in the Get Pub calculation + - description: from url, provided from the location header in the Get PA calculation status by id endpoint explode: false in: path name: id required: true schema: - description: from url, provided from the location header in the Get Pub - calculation status by id endpoint + description: from url, provided from the location header in the Get PA calculation + status by id endpoint type: string style: simple - - description: from url, provided from the location header in the Get Pub calculation + - description: from url, provided from the location header in the Get PA calculation status by id endpoint explode: false in: path name: unitId required: true schema: - description: from url, provided from the location header in the Get Pub - calculation status by id endpoint + description: from url, provided from the location header in the Get PA calculation + status by id endpoint type: string style: simple responses: @@ -23366,17 +22995,11 @@ paths: content: application/json: schema: - format: binary - type: string + $ref: '#/components/schemas/ObjectRoot' application/x-protobuf: schema: - format: binary - type: string - application/pdf: - schema: - format: binary - type: string - description: Expected response once calculation is completed, returns result + $ref: '#/components/schemas/ObjectRoot' + description: Expected response once calculation is completed, returns JSON in the format specified in the Calculation parameters. headers: Content-Encoding: @@ -23446,9 +23069,6 @@ paths: application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/pdf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' description: Invalid identifier provided. headers: X-DataDirect-Request-Key: @@ -23493,9 +23113,6 @@ paths: application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/pdf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' description: Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled headers: @@ -23628,21 +23245,30 @@ paths: available after successful authentication. type: string style: simple - summary: Get Pub calculation result by id + summary: Get PA calculation result by id tags: - - PubCalculations + - PACalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - is-file: true + response-type: ObjectRoot x-accepts: application/json - /analytics/engines/quant/v3/calculations: + /analytics/engines/pub/v3/calculations: post: - description: "This endpoint runs the Quant Engine calculation specified in the\ - \ POST body parameters.\r\nIt can take one or more calculation units as input." + description: "This endpoint runs the Pub calculation specified in the POST body\ + \ parameters.\r\nIt can take one or more units as input." operationId: postAndCalculate parameters: - - description: Standard HTTP header. Accepts no-store, max-age, max-stale. + - description: Long running deadline in seconds when only one unit is passed + in the POST body. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + type: integer + style: simple + - description: Standard HTTP header. Accepts max-stale. explode: false in: header name: Cache-Control @@ -23654,14 +23280,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/QuantCalculationParametersRoot' + $ref: '#/components/schemas/PubCalculationParametersRoot' + description: Calculation Parameters responses: "202": content: - application/json: + application/pdf: schema: $ref: '#/components/schemas/CalculationStatusRoot' - application/x-protobuf: + application/vnd.openxmlformats-officedocument.presentationml.presentation: schema: $ref: '#/components/schemas/CalculationStatusRoot' description: Expected response, contains the poll URL in the Location header. @@ -23707,17 +23334,16 @@ paths: schema: type: string style: simple - "201": + "200": content: - application/json: + application/pdf: schema: - $ref: '#/components/schemas/ObjectRoot' - application/x-protobuf: + $ref: '#/components/schemas/CalculationStatusRoot' + application/vnd.openxmlformats-officedocument.presentationml.presentation: schema: - $ref: '#/components/schemas/ObjectRoot' - description: 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. + $ref: '#/components/schemas/CalculationStatusRoot' + description: Expected response, if the calculation has one unit and is completed + with an error. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -23753,16 +23379,19 @@ paths: schema: type: string style: simple - "200": + "201": content: - application/json: + application/pdf: schema: - $ref: '#/components/schemas/CalculationStatusRoot' - application/x-protobuf: + format: binary + type: string + application/vnd.openxmlformats-officedocument.presentationml.presentation: schema: - $ref: '#/components/schemas/CalculationStatusRoot' + format: binary + type: string description: Expected response if the calculation has one unit and is completed - with an error. + in a short span, returns JSON in the format specified in the Calculation + parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -23800,10 +23429,10 @@ paths: style: simple "400": content: - application/json: + application/pdf: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: + application/vnd.openxmlformats-officedocument.presentationml.presentation: schema: $ref: '#/components/schemas/ClientErrorResponse' description: Invalid calculation parameters. @@ -23844,10 +23473,10 @@ paths: style: simple "404": content: - application/json: + application/pdf: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: + application/vnd.openxmlformats-officedocument.presentationml.presentation: schema: $ref: '#/components/schemas/ClientErrorResponse' description: One or more calculation settings were unavailable. @@ -24064,33 +23693,33 @@ paths: available after successful authentication. type: string style: simple - summary: Create and Run Quant Engine calculation + summary: Create and Run Pub calculation tags: - - QuantCalculations + - PubCalculations x-are-multiple-success-responses-different: true x-success-response-types: - status-code: "202" response-type: CalculationStatusRoot - - status-code: "201" - response-type: ObjectRoot - status-code: "200" response-type: CalculationStatusRoot + - status-code: "201" + is-file: true x-contentType: application/json - x-accepts: application/json - /analytics/engines/quant/v3/calculations/{id}: + x-accepts: application/pdf,application/vnd.openxmlformats-officedocument.presentationml.presentation + /analytics/engines/pub/v3/calculations/{id}: delete: description: This is the endpoint to cancel a previously submitted calculation. operationId: cancelCalculationById parameters: - description: from url, provided from the location header in the Create and - Run Quant calculation endpoint + Run Pub calculation endpoint explode: false in: path name: id required: true schema: description: from url, provided from the location header in the Create and - Run Quant calculation endpoint + Run Pub calculation endpoint type: string style: simple responses: @@ -24321,9 +23950,9 @@ paths: available after successful authentication. type: string style: simple - summary: Cancel Quant calculation by id + summary: Cancel Pub calculation by id tags: - - QuantCalculations + - PubCalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "204" @@ -24334,14 +23963,14 @@ paths: operationId: getCalculationParameters parameters: - description: from url, provided from the location header in the Create and - Run Quant Engine calculation endpoint + Run Pub calculation endpoint explode: false in: path name: id required: true schema: description: from url, provided from the location header in the Create and - Run Quant Engine calculation endpoint + Run Pub calculation endpoint type: string style: simple responses: @@ -24349,8 +23978,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/QuantCalculationParametersRoot' - description: Expected response, returns the Quant Engine calculation parameters. + $ref: '#/components/schemas/PubCalculationParametersRoot' + description: Expected response, returns the Pub calculation parameters. headers: Content-Encoding: description: Standard HTTP header. Header value based on Accept-Encoding @@ -24588,32 +24217,43 @@ paths: available after successful authentication. type: string style: simple - summary: Get Quant Engine calculation parameters by id + summary: Get Pub calculation parameters by id tags: - - QuantCalculations + - PubCalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: QuantCalculationParametersRoot + response-type: PubCalculationParametersRoot x-accepts: application/json put: - description: "This endpoint updates and runs the Quant Engine calculation specified\ - \ in the PUT body parameters. This also allows creating new Quant Engine calculations\ - \ with custom ids.\r\nIt can take one or more calculation units as input." + description: "This endpoint updates and run the Pub calculation specified in\ + \ the PUT body parameters. This also allows creating new Pub calculations\ + \ with custom ids.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\ + \n\r\n* Start and and end date must be within the configuration's min and\ + \ max date range" operationId: putAndCalculate parameters: - description: from url, provided from the location header in the Create and - Run Quant Engine calculation endpoint + Run Pub calculation endpoint explode: false in: path name: id required: true schema: description: from url, provided from the location header in the Create and - Run Quant Engine calculation endpoint + Run Pub calculation endpoint type: string style: simple - - description: Standard HTTP header. Accepts no-store, max-age, max-stale. + - description: Long running deadline in seconds when only one unit is passed + in the PUT body. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + type: integer + style: simple + - description: Standard HTTP header. Accepts max-stale. explode: false in: header name: Cache-Control @@ -24625,15 +24265,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/QuantCalculationParametersRoot' + $ref: '#/components/schemas/PubCalculationParametersRoot' description: Calculation Parameters responses: "202": content: - application/json: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - application/x-protobuf: + application/pdf: schema: $ref: '#/components/schemas/CalculationStatusRoot' description: Expected response, contains the poll URL in the Location header. @@ -24661,6 +24298,20 @@ paths: available after successful authentication. type: string style: simple + X-FactSet-Api-Calculations-Limit: + description: Maximum FI request limit. + explode: false + schema: + description: Maximum FI request limit. + type: string + style: simple + X-FactSet-Api-Calculations-Remaining: + description: Number of FI requests remaining till request limit reached. + explode: false + schema: + description: Number of FI requests remaining till request limit reached. + type: string + style: simple X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. explode: false @@ -24681,13 +24332,10 @@ paths: style: simple "200": content: - application/json: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - application/x-protobuf: + application/pdf: schema: $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response if the calculation has one unit and is completed + description: Expected response, if the calculation has one unit and is completed with an error. headers: X-DataDirect-Request-Key: @@ -24706,6 +24354,20 @@ paths: available after successful authentication. type: string style: simple + X-FactSet-Api-Calculations-Limit: + description: Maximum FI request limit. + explode: false + schema: + description: Maximum FI request limit. + type: string + style: simple + X-FactSet-Api-Calculations-Remaining: + description: Number of FI requests remaining till request limit reached. + explode: false + schema: + description: Number of FI requests remaining till request limit reached. + type: string + style: simple X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. explode: false @@ -24726,12 +24388,10 @@ paths: style: simple "201": content: - application/json: - schema: - $ref: '#/components/schemas/ObjectRoot' - application/x-protobuf: + application/pdf: schema: - $ref: '#/components/schemas/ObjectRoot' + format: binary + type: string description: 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. @@ -24752,6 +24412,20 @@ paths: available after successful authentication. type: string style: simple + X-FactSet-Api-Calculations-Limit: + description: Maximum FI request limit. + explode: false + schema: + description: Maximum FI request limit. + type: string + style: simple + X-FactSet-Api-Calculations-Remaining: + description: Number of FI requests remaining till request limit reached. + explode: false + schema: + description: Number of FI requests remaining till request limit reached. + type: string + style: simple X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. explode: false @@ -24772,10 +24446,7 @@ paths: style: simple "400": content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: + application/pdf: schema: $ref: '#/components/schemas/ClientErrorResponse' description: Invalid Calculation Parameters. @@ -24796,6 +24467,20 @@ paths: available after successful authentication. type: string style: simple + X-FactSet-Api-Calculations-Limit: + description: Maximum FI request limit. + explode: false + schema: + description: Maximum FI request limit. + type: string + style: simple + X-FactSet-Api-Calculations-Remaining: + description: Number of FI requests remaining till request limit reached. + explode: false + schema: + description: Number of FI requests remaining till request limit reached. + type: string + style: simple X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. explode: false @@ -24816,10 +24501,7 @@ paths: style: simple "404": content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: + application/pdf: schema: $ref: '#/components/schemas/ClientErrorResponse' description: One or more calculation settings were unavailable. @@ -24840,6 +24522,20 @@ paths: available after successful authentication. type: string style: simple + X-FactSet-Api-Calculations-Limit: + description: Maximum FI request limit. + explode: false + schema: + description: Maximum FI request limit. + type: string + style: simple + X-FactSet-Api-Calculations-Remaining: + description: Number of FI requests remaining till request limit reached. + explode: false + schema: + description: Number of FI requests remaining till request limit reached. + type: string + style: simple X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. explode: false @@ -24860,10 +24556,7 @@ paths: style: simple "409": content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: + application/pdf: schema: $ref: '#/components/schemas/ClientErrorResponse' description: Duplicate calculation exists with same parameters. @@ -24884,6 +24577,20 @@ paths: available after successful authentication. type: string style: simple + X-FactSet-Api-Calculations-Limit: + description: Maximum FI request limit. + explode: false + schema: + description: Maximum FI request limit. + type: string + style: simple + X-FactSet-Api-Calculations-Remaining: + description: Number of FI requests remaining till request limit reached. + explode: false + schema: + description: Number of FI requests remaining till request limit reached. + type: string + style: simple X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. explode: false @@ -24921,6 +24628,20 @@ paths: available after successful authentication. type: string style: simple + X-FactSet-Api-Calculations-Limit: + description: Maximum FI request limit. + explode: false + schema: + description: Maximum FI request limit. + type: string + style: simple + X-FactSet-Api-Calculations-Remaining: + description: Number of FI requests remaining till request limit reached. + explode: false + schema: + description: Number of FI requests remaining till request limit reached. + type: string + style: simple "403": description: User is forbidden with current credentials headers: @@ -24940,6 +24661,20 @@ paths: available after successful authentication. type: string style: simple + X-FactSet-Api-Calculations-Limit: + description: Maximum FI request limit. + explode: false + schema: + description: Maximum FI request limit. + type: string + style: simple + X-FactSet-Api-Calculations-Remaining: + description: Number of FI requests remaining till request limit reached. + explode: false + schema: + description: Number of FI requests remaining till request limit reached. + type: string + style: simple X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. explode: false @@ -24978,6 +24713,20 @@ paths: available after successful authentication. type: string style: simple + X-FactSet-Api-Calculations-Limit: + description: Maximum FI request limit. + explode: false + schema: + description: Maximum FI request limit. + type: string + style: simple + X-FactSet-Api-Calculations-Remaining: + description: Number of FI requests remaining till request limit reached. + explode: false + schema: + description: Number of FI requests remaining till request limit reached. + type: string + style: simple X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. explode: false @@ -25016,6 +24765,20 @@ paths: available after successful authentication. type: string style: simple + X-FactSet-Api-Calculations-Limit: + description: Maximum FI request limit. + explode: false + schema: + description: Maximum FI request limit. + type: string + style: simple + X-FactSet-Api-Calculations-Remaining: + description: Number of FI requests remaining till request limit reached. + explode: false + schema: + description: Number of FI requests remaining till request limit reached. + type: string + style: simple X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. explode: false @@ -25061,6 +24824,20 @@ paths: available after successful authentication. type: string style: simple + X-FactSet-Api-Calculations-Limit: + description: Maximum FI request limit. + explode: false + schema: + description: Maximum FI request limit. + type: string + style: simple + X-FactSet-Api-Calculations-Remaining: + description: Number of FI requests remaining till request limit reached. + explode: false + schema: + description: Number of FI requests remaining till request limit reached. + type: string + style: simple "503": description: Request timed out. Retry the request in sometime. headers: @@ -25080,9 +24857,23 @@ paths: available after successful authentication. type: string style: simple - summary: Create or update Quant Engine calculation and run it. + X-FactSet-Api-Calculations-Limit: + description: Maximum FI request limit. + explode: false + schema: + description: Maximum FI request limit. + type: string + style: simple + X-FactSet-Api-Calculations-Remaining: + description: Number of FI requests remaining till request limit reached. + explode: false + schema: + description: Number of FI requests remaining till request limit reached. + type: string + style: simple + summary: Create or Update Pub calculation and run it. tags: - - QuantCalculations + - PubCalculations x-are-multiple-success-responses-different: true x-success-response-types: - status-code: "202" @@ -25090,27 +24881,25 @@ paths: - status-code: "200" response-type: CalculationStatusRoot - status-code: "201" - response-type: ObjectRoot + is-file: true x-contentType: application/json - x-accepts: application/json - /analytics/engines/quant/v3/calculations/{id}/status: + x-accepts: application/pdf + /analytics/engines/pub/v3/calculations/{id}/status: get: description: "This is the endpoint to check on the progress of a previously\ \ requested calculation.\r\nIf the calculation has finished computing, the\ - \ location header will point to the result url.\r\nOtherwise, the calculation\ - \ is still running and the X-FactSet-Api-PickUp-Progress header will contain\ - \ a progress percentage." + \ location header will point to the result url." operationId: getCalculationStatusById parameters: - description: from url, provided from the location header in the Create and - Run Quant Engine calculation endpoint + Run Pub calculation endpoint explode: false in: path name: id required: true schema: description: from url, provided from the location header in the Create and - Run Quant Engine calculation endpoint + Run Pub calculation endpoint type: string style: simple responses: @@ -25185,8 +24974,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response returned if the calculation is not yet completed, - should contain X-FactSet-Api-PickUp-Progress header. + description: Expected response returned if the calculation is not yet completed. headers: X-FactSet-Api-PickUp-Progress: description: FactSet's progress header. @@ -25416,9 +25204,9 @@ paths: available after successful authentication. type: string style: simple - summary: Get Quant Engine calculation status by id + summary: Get Pub calculation status by id tags: - - QuantCalculations + - PubCalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" @@ -25426,33 +25214,33 @@ paths: - status-code: "202" response-type: CalculationStatusRoot x-accepts: application/json - /analytics/engines/quant/v3/calculations/{id}/units/{unitId}/result: + /analytics/engines/pub/v3/calculations/{id}/units/{unitId}/result: get: description: "This is the endpoint to get the result of a previously requested\ \ calculation.\r\nIf the calculation has finished computing, the body of the\ - \ response will contain the requested document in JSON." + \ response will contain the requested document in the specified format." operationId: getCalculationUnitResultById parameters: - - description: from url, provided from the location header in the Get Quant - Engine calculation status by id endpoint + - description: from url, provided from the location header in the Get Pub calculation + status by id endpoint explode: false in: path name: id required: true schema: - description: from url, provided from the location header in the Get Quant - Engine calculation status by id endpoint + description: from url, provided from the location header in the Get Pub + calculation status by id endpoint type: string style: simple - - description: from url, provided from the location header in the Get Quant - Engine calculation status by id endpoint + - description: from url, provided from the location header in the Get Pub calculation + status by id endpoint explode: false in: path name: unitId required: true schema: - description: from url, provided from the location header in the Get Quant - Engine calculation status by id endpoint + description: from url, provided from the location header in the Get Pub + calculation status by id endpoint type: string style: simple responses: @@ -25466,11 +25254,11 @@ paths: schema: format: binary type: string - application/octet-stream: + application/pdf: schema: format: binary type: string - description: Expected response once calculation is completed, returns JSON + description: Expected response once calculation is completed, returns result in the format specified in the Calculation parameters. headers: Content-Encoding: @@ -25540,7 +25328,7 @@ paths: application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/octet-stream: + application/pdf: schema: $ref: '#/components/schemas/ClientErrorResponse' description: Invalid identifier provided. @@ -25587,7 +25375,7 @@ paths: application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/octet-stream: + application/pdf: schema: $ref: '#/components/schemas/ClientErrorResponse' description: Calculation was already returned, provided id was not a requested @@ -25722,84 +25510,142 @@ paths: available after successful authentication. type: string style: simple - summary: Get Quant Engine calculation result by id + summary: Get Pub calculation result by id tags: - - QuantCalculations + - PubCalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" is-file: true x-accepts: application/json - /analytics/engines/quant/v3/calculations/{id}/units/{unitId}/info: - get: - description: This is the endpoint to get the metadata information of a previously - requested calculation. - operationId: getCalculationUnitInfoById + /analytics/engines/quant/v3/calculations: + post: + description: "This endpoint runs the Quant Engine calculation specified in the\ + \ POST body parameters.\r\nIt can take one or more calculation units as input." + operationId: postAndCalculate parameters: - - description: from url, provided from the location header in the Get Quant - calculation status by id endpoint - explode: false - in: path - name: id - required: true - schema: - description: from url, provided from the location header in the Get Quant - calculation status by id endpoint - type: string - style: simple - - description: from url, provided from the location header in the Get Quant - calculation status by id endpoint + - description: Standard HTTP header. Accepts no-store, max-age, max-stale. explode: false - in: path - name: unitId - required: true + in: header + name: Cache-Control + required: false schema: - description: from url, provided from the location header in the Get Quant - calculation status by id endpoint type: string style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QuantCalculationParametersRoot' responses: - "200": + "202": content: application/json: schema: - format: binary - type: string + $ref: '#/components/schemas/CalculationStatusRoot' application/x-protobuf: schema: - format: binary + $ref: '#/components/schemas/CalculationStatusRoot' + description: Expected response, contains the poll URL in the Location header. + headers: + Location: + description: URL to poll for the resulting calculation + explode: false + schema: + description: URL to poll for the resulting calculation type: string - application/octet-stream: + style: simple + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false schema: - format: binary + description: FactSet's request key header. type: string - description: Expected response once calculation is completed. + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectRoot' + application/x-protobuf: + schema: + $ref: '#/components/schemas/ObjectRoot' + description: 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. headers: - Content-Encoding: - description: Standard HTTP header. Header value based on Accept-Encoding - Request header. + X-DataDirect-Request-Key: + description: FactSet's request key header. explode: false schema: - description: Standard HTTP header. Header value based on Accept-Encoding - Request header. + description: FactSet's request key header. type: string style: simple - Content-Type: - description: Standard HTTP header. + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. explode: false schema: - description: Standard HTTP header. + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. type: string style: simple - Transfer-Encoding: - description: Standard HTTP header. Header value will be set to Chunked - if Accept-Encoding header is specified. + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. explode: false schema: - description: Standard HTTP header. Header value will be set to Chunked - if Accept-Encoding header is specified. type: string style: simple + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + application/x-protobuf: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + description: Expected response if the calculation has one unit and is completed + with an error. + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -25842,10 +25688,7 @@ paths: application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/octet-stream: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + description: Invalid calculation parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -25889,11 +25732,7 @@ paths: application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/octet-stream: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Calculation was already returned, provided id was not a requested - calculation, or the calculation was cancelled + description: One or more calculation settings were unavailable. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -25985,9 +25824,9 @@ paths: schema: type: string style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting + "415": + description: Missing/Invalid Content-Type header. Header needs to be set + to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -26005,82 +25844,28 @@ paths: available after successful authentication. type: string style: simple - "503": - description: Request timed out. Retry the request in sometime. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. explode: false schema: - description: FactSet's request key header. type: string style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. explode: false schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. type: string style: simple - summary: Get Quant Engine calculation metadata information by id - tags: - - QuantCalculations - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - is-file: true - x-accepts: application/json - /analytics/engines/spar/v3/calculations: - post: - description: "This endpoint runs the SPAR calculation specified in the POST\ - \ body parameters.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\ - \n\r\n*\tAny settings in POST body will act as a one-time override over the\ - \ settings saved in the SPAR template." - operationId: postAndCalculate - parameters: - - description: Long running deadline in seconds when only one unit is passed - in the POST body. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. - explode: false - in: header - name: Cache-Control - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SPARCalculationParametersRoot' - description: Calculation Parameters - responses: - "202": - content: - application/json: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - application/x-protobuf: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, contains the poll URL in the Location header. - headers: - Location: - description: URL to poll for the resulting calculation + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. explode: false schema: - description: URL to poll for the resulting calculation type: string style: simple + "429": + description: Rate limit reached. Cancel older requests using Cancel Calculation + endpoint or wait for older requests to finish/expire. + headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -26115,16 +25900,16 @@ paths: schema: type: string style: simple - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - application/x-protobuf: + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, if the calculation has one unit and is completed - with an error. + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -26142,35 +25927,57 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. explode: false schema: + description: FactSet's request key header. type: string style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. explode: false schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. type: string style: simple - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/ObjectRoot' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ObjectRoot' - description: 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. + summary: Create and Run Quant Engine calculation + tags: + - QuantCalculations + x-are-multiple-success-responses-different: true + x-success-response-types: + - status-code: "202" + response-type: CalculationStatusRoot + - status-code: "201" + response-type: ObjectRoot + - status-code: "200" + response-type: CalculationStatusRoot + x-contentType: application/json + x-accepts: application/json + /analytics/engines/quant/v3/calculations/{id}: + delete: + description: This is the endpoint to cancel a previously submitted calculation. + operationId: cancelCalculationById + parameters: + - description: from url, provided from the location header in the Create and + Run Quant calculation endpoint + explode: false + in: path + name: id + required: true + schema: + description: from url, provided from the location header in the Create and + Run Quant calculation endpoint + type: string + style: simple + responses: + "204": + description: Expected response, calculation was canceled successfully. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -26208,13 +26015,16 @@ paths: style: simple "400": content: + text/plain: + schema: + $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: + text/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid calculation parameters. + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -26252,13 +26062,17 @@ paths: style: simple "404": content: + text/plain: + schema: + $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: + text/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: One or more calculation settings were unavailable. + description: There was no request for the calculation identifier provided, + or the request was already canceled for the provided identifier. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -26350,9 +26164,9 @@ paths: schema: type: string style: simple - "415": - description: Missing/Invalid Content-Type header. Header needs to be set - to application/json. + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -26370,421 +26184,81 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. explode: false schema: + description: FactSet's request key header. type: string style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. explode: false schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. type: string style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. + summary: Cancel Quant calculation by id + tags: + - QuantCalculations + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "204" + x-accepts: application/json + get: + description: This is the endpoint that returns the calculation parameters passed + for a calculation. + operationId: getCalculationParameters + parameters: + - description: from url, provided from the location header in the Create and + Run Quant Engine calculation endpoint + explode: false + in: path + name: id + required: true + schema: + description: from url, provided from the location header in the Create and + Run Quant Engine calculation endpoint + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/QuantCalculationParametersRoot' + description: Expected response, returns the Quant Engine calculation parameters. + headers: + Content-Encoding: + description: Standard HTTP header. Header value based on Accept-Encoding + Request header. explode: false schema: + description: Standard HTTP header. Header value based on Accept-Encoding + Request header. + type: string + style: simple + Content-Type: + description: Standard HTTP header. + explode: false + schema: + description: Standard HTTP header. + type: string + style: simple + Transfer-Encoding: + description: Standard HTTP header. Header value will be set to Chunked + if Accept-Encoding header is specified. + explode: false + schema: + description: Standard HTTP header. Header value will be set to Chunked + if Accept-Encoding header is specified. type: string style: simple - "429": - description: Rate limit reached. Cancel older requests using Cancel Calculation - endpoint or wait for older requests to finish/expire. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple - Retry-After: - description: Time to wait in seconds before making a new request as - the rate limit has reached. - explode: false - schema: - type: string - style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - "503": - description: Request timed out. Retry the request in sometime. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - summary: Create and Run SPAR calculation - tags: - - SPARCalculations - x-are-multiple-success-responses-different: true - x-success-response-types: - - status-code: "202" - response-type: CalculationStatusRoot - - status-code: "200" - response-type: CalculationStatusRoot - - status-code: "201" - response-type: ObjectRoot - x-contentType: application/json - x-accepts: application/json - /analytics/engines/spar/v3/calculations/{id}: - delete: - description: This is the endpoint to cancel a previously submitted calculation. - operationId: cancelCalculationById - parameters: - - description: from url, provided from the location header in the Create and - Run SPAR calculation endpoint - explode: false - in: path - name: id - required: true - schema: - description: from url, provided from the location header in the Create and - Run SPAR calculation endpoint - type: string - style: simple - responses: - "204": - description: Expected response, calculation was canceled successfully. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple - "400": - content: - text/plain: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - text/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple - "404": - content: - text/plain: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - text/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: There was no request for the calculation identifier provided, - or the request was already canceled for the provided identifier. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple - "401": - description: Missing or invalid authentication. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - "403": - description: User is forbidden with current credentials - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - "503": - description: Request timed out. Retry the request in sometime. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - summary: Cancel SPAR calculation - tags: - - SPARCalculations - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "204" - x-accepts: application/json - get: - description: This is the endpoint that returns the calculation parameters passed - for a calculation. - operationId: getCalculationParameters - parameters: - - description: from url, provided from the location header in the Create and - Run SPAR calculation endpoint - explode: false - in: path - name: id - required: true - schema: - description: from url, provided from the location header in the Create and - Run SPAR calculation endpoint - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SPARCalculationParametersRoot' - description: Expected response, returns the SPAR calculation parameters. - headers: - Content-Encoding: - description: Standard HTTP header. Header value based on Accept-Encoding - Request header. - explode: false - schema: - description: Standard HTTP header. Header value based on Accept-Encoding - Request header. - type: string - style: simple - Content-Type: - description: Standard HTTP header. - explode: false - schema: - description: Standard HTTP header. - type: string - style: simple - Transfer-Encoding: - description: Standard HTTP header. Header value will be set to Chunked - if Accept-Encoding header is specified. - explode: false - schema: - description: Standard HTTP header. Header value will be set to Chunked - if Accept-Encoding header is specified. - type: string - style: simple X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -26996,43 +26470,32 @@ paths: available after successful authentication. type: string style: simple - summary: Get SPAR calculation parameters by id + summary: Get Quant Engine calculation parameters by id tags: - - SPARCalculations + - QuantCalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: SPARCalculationParametersRoot + response-type: QuantCalculationParametersRoot x-accepts: application/json put: - description: "This endpoint updates and run the SPAR calculation specified in\ - \ the PUT body parameters. This also allows creating new SPAR calculations\ - \ with custom ids.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\ - \n\r\n*\tAny settings in PUT body will act as a one-time override over the\ - \ settings saved in the SPAR template." + description: "This endpoint updates and runs the Quant Engine calculation specified\ + \ in the PUT body parameters. This also allows creating new Quant Engine calculations\ + \ with custom ids.\r\nIt can take one or more calculation units as input." operationId: putAndCalculate parameters: - description: from url, provided from the location header in the Create and - Run SPAR calculation endpoint + Run Quant Engine calculation endpoint explode: false in: path name: id required: true schema: description: from url, provided from the location header in the Create and - Run SPAR calculation endpoint + Run Quant Engine calculation endpoint type: string style: simple - - description: Long running deadline in seconds when only one unit is passed - in the PUT body. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. + - description: Standard HTTP header. Accepts no-store, max-age, max-stale. explode: false in: header name: Cache-Control @@ -27044,7 +26507,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SPARCalculationParametersRoot' + $ref: '#/components/schemas/QuantCalculationParametersRoot' description: Calculation Parameters responses: "202": @@ -27106,7 +26569,7 @@ paths: application/x-protobuf: schema: $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, if the calculation has one unit and is completed + description: Expected response if the calculation has one unit and is completed with an error. headers: X-DataDirect-Request-Key: @@ -27499,9 +26962,9 @@ paths: available after successful authentication. type: string style: simple - summary: Create or Update SPAR calculation and run it. + summary: Create or update Quant Engine calculation and run it. tags: - - SPARCalculations + - QuantCalculations x-are-multiple-success-responses-different: true x-success-response-types: - status-code: "202" @@ -27512,22 +26975,24 @@ paths: response-type: ObjectRoot x-contentType: application/json x-accepts: application/json - /analytics/engines/spar/v3/calculations/{id}/status: + /analytics/engines/quant/v3/calculations/{id}/status: get: description: "This is the endpoint to check on the progress of a previously\ \ requested calculation.\r\nIf the calculation has finished computing, the\ - \ location header will point to the result url." + \ location header will point to the result url.\r\nOtherwise, the calculation\ + \ is still running and the X-FactSet-Api-PickUp-Progress header will contain\ + \ a progress percentage." operationId: getCalculationStatusById parameters: - description: from url, provided from the location header in the Create and - Run SPAR calculation endpoint + Run Quant Engine calculation endpoint explode: false in: path name: id required: true schema: description: from url, provided from the location header in the Create and - Run SPAR calculation endpoint + Run Quant Engine calculation endpoint type: string style: simple responses: @@ -27602,7 +27067,8 @@ paths: application/json: schema: $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response returned if the calculation is not yet completed. + description: Expected response returned if the calculation is not yet completed, + should contain X-FactSet-Api-PickUp-Progress header. headers: X-FactSet-Api-PickUp-Progress: description: FactSet's progress header. @@ -27832,9 +27298,9 @@ paths: available after successful authentication. type: string style: simple - summary: Get SPAR calculation status by id + summary: Get Quant Engine calculation status by id tags: - - SPARCalculations + - QuantCalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" @@ -27842,33 +27308,33 @@ paths: - status-code: "202" response-type: CalculationStatusRoot x-accepts: application/json - /analytics/engines/spar/v3/calculations/{id}/units/{unitId}/result: + /analytics/engines/quant/v3/calculations/{id}/units/{unitId}/result: get: description: "This is the endpoint to get the result of a previously requested\ \ calculation.\r\nIf the calculation has finished computing, the body of the\ \ response will contain the requested document in JSON." operationId: getCalculationUnitResultById parameters: - - description: from url, provided from the location header in the Get SPAR calculation - status by id endpoint + - description: from url, provided from the location header in the Get Quant + Engine calculation status by id endpoint explode: false in: path name: id required: true schema: - description: from url, provided from the location header in the Get SPAR - calculation status by id endpoint + description: from url, provided from the location header in the Get Quant + Engine calculation status by id endpoint type: string style: simple - - description: from url, provided from the location header in the Get SPAR calculation - status by id endpoint + - description: from url, provided from the location header in the Get Quant + Engine calculation status by id endpoint explode: false in: path name: unitId required: true schema: - description: from url, provided from the location header in the Get SPAR - calculation status by id endpoint + description: from url, provided from the location header in the Get Quant + Engine calculation status by id endpoint type: string style: simple responses: @@ -27876,10 +27342,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ObjectRoot' + format: binary + type: string application/x-protobuf: schema: - $ref: '#/components/schemas/ObjectRoot' + format: binary + type: string + application/octet-stream: + schema: + format: binary + type: string description: Expected response once calculation is completed, returns JSON in the format specified in the Calculation parameters. headers: @@ -27950,6 +27422,9 @@ paths: application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' + application/octet-stream: + schema: + $ref: '#/components/schemas/ClientErrorResponse' description: Invalid identifier provided. headers: X-DataDirect-Request-Key: @@ -27994,6 +27469,9 @@ paths: application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' + application/octet-stream: + schema: + $ref: '#/components/schemas/ClientErrorResponse' description: Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled headers: @@ -28126,30 +27604,40 @@ paths: available after successful authentication. type: string style: simple - summary: Get SPAR calculation result by id + summary: Get Quant Engine calculation result by id tags: - - SPARCalculations + - QuantCalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: ObjectRoot + is-file: true x-accepts: application/json - /analytics/engines/axp/v3/strategies/{path}: + /analytics/engines/quant/v3/calculations/{id}/units/{unitId}/info: get: - description: This endpoint looks up all Axioma Equity strategy documents and - sub-directories in a given directory. - operationId: getAxiomaEquityStrategyDocuments + description: This is the endpoint to get the metadata information of a previously + requested calculation. + operationId: getCalculationUnitInfoById parameters: - - description: The directory to get the strategy documents and sub-directories - in + - description: from url, provided from the location header in the Get Quant + calculation status by id endpoint explode: false in: path - name: path + name: id required: true schema: - default: "" - description: The directory to get the strategy documents and sub-directories - in + description: from url, provided from the location header in the Get Quant + calculation status by id endpoint + type: string + style: simple + - description: from url, provided from the location header in the Get Quant + calculation status by id endpoint + explode: false + in: path + name: unitId + required: true + schema: + description: from url, provided from the location header in the Get Quant + calculation status by id endpoint type: string style: simple responses: @@ -28157,10 +27645,43 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Axioma Equity strategy - documents and directories + format: binary + type: string + application/x-protobuf: + schema: + format: binary + type: string + application/octet-stream: + schema: + format: binary + type: string + description: Expected response once calculation is completed. headers: + Content-Encoding: + description: Standard HTTP header. Header value based on Accept-Encoding + Request header. + explode: false + schema: + description: Standard HTTP header. Header value based on Accept-Encoding + Request header. + type: string + style: simple + Content-Type: + description: Standard HTTP header. + explode: false + schema: + description: Standard HTTP header. + type: string + style: simple + Transfer-Encoding: + description: Standard HTTP header. Header value will be set to Chunked + if Accept-Encoding header is specified. + explode: false + schema: + description: Standard HTTP header. Header value will be set to Chunked + if Accept-Encoding header is specified. + type: string + style: simple X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -28200,7 +27721,13 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter or value provided + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + application/octet-stream: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -28241,7 +27768,14 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Path not found + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + application/octet-stream: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Calculation was already returned, provided id was not a requested + calculation, or the calculation was cancelled headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -28278,7 +27812,7 @@ paths: type: string style: simple "401": - description: Missing or invalid authentication + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -28333,70 +27867,6 @@ paths: schema: type: string style: simple - "406": - description: Unsupported Accept header. Header needs to be set to application/json - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple - "429": - description: Rate limit reached. Wait till the time specified in Retry-After - header value to make further requests. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - Retry-After: - description: Time to wait in seconds before making a new request as - the rate limit has reached. - explode: false - schema: - type: string - style: simple "500": description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting @@ -28418,7 +27888,7 @@ paths: type: string style: simple "503": - description: Request timed out. Retry the request in some time + description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -28436,40 +27906,153 @@ paths: available after successful authentication. type: string style: simple - summary: Get Axioma Equity strategy documents and sub-directories in a directory + summary: Get Quant Engine calculation metadata information by id tags: - - StrategyDocuments + - QuantCalculations x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: DocumentDirectoriesRoot + is-file: true x-accepts: application/json - /analytics/engines/afi/v3/strategies/{path}: - get: - description: This endpoint looks up all Axioma FI strategy documents and sub-directories - in a given directory. - operationId: getAxiomaFIStrategyDocuments + /analytics/engines/spar/v3/calculations: + post: + description: "This endpoint runs the SPAR calculation specified in the POST\ + \ body parameters.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\ + \n\r\n*\tAny settings in POST body will act as a one-time override over the\ + \ settings saved in the SPAR template." + operationId: postAndCalculate parameters: - - description: The directory to get the strategy documents and sub-directories - in + - description: Long running deadline in seconds when only one unit is passed + in the POST body. explode: false - in: path - name: path - required: true + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + type: integer + style: simple + - description: Standard HTTP header. Accepts max-stale. + explode: false + in: header + name: Cache-Control + required: false schema: - default: "" - description: The directory to get the strategy documents and sub-directories - in type: string style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SPARCalculationParametersRoot' + description: Calculation Parameters responses: - "200": + "202": content: application/json: schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Axioma FI strategy documents - and directories + $ref: '#/components/schemas/CalculationStatusRoot' + application/x-protobuf: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + description: Expected response, contains the poll URL in the Location header. + headers: + Location: + description: URL to poll for the resulting calculation + explode: false + schema: + description: URL to poll for the resulting calculation + type: string + style: simple + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + application/x-protobuf: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + description: Expected response, if the calculation has one unit and is completed + with an error. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectRoot' + application/x-protobuf: + schema: + $ref: '#/components/schemas/ObjectRoot' + description: 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. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -28510,7 +28093,10 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter or value provided + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid calculation parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -28551,7 +28137,10 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Path not found + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: One or more calculation settings were unavailable. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -28588,7 +28177,7 @@ paths: type: string style: simple "401": - description: Missing or invalid authentication + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -28643,8 +28232,9 @@ paths: schema: type: string style: simple - "406": - description: Unsupported Accept header. Header needs to be set to application/json + "415": + description: Missing/Invalid Content-Type header. Header needs to be set + to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -28681,8 +28271,8 @@ paths: type: string style: simple "429": - description: Rate limit reached. Wait till the time specified in Retry-After - header value to make further requests. + description: Rate limit reached. Cancel older requests using Cancel Calculation + endpoint or wait for older requests to finish/expire. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -28700,6 +28290,24 @@ paths: available after successful authentication. type: string style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple Retry-After: description: Time to wait in seconds before making a new request as the rate limit has reached. @@ -28709,7 +28317,7 @@ paths: style: simple "500": description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting + in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -28728,7 +28336,7 @@ paths: type: string style: simple "503": - description: Request timed out. Retry the request in some time + description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -28746,40 +28354,38 @@ paths: available after successful authentication. type: string style: simple - summary: Get Axioma FI strategy documents and sub-directories in a directory + summary: Create and Run SPAR calculation tags: - - StrategyDocuments - x-are-multiple-success-responses-different: false + - SPARCalculations + x-are-multiple-success-responses-different: true x-success-response-types: + - status-code: "202" + response-type: CalculationStatusRoot - status-code: "200" - response-type: DocumentDirectoriesRoot + response-type: CalculationStatusRoot + - status-code: "201" + response-type: ObjectRoot + x-contentType: application/json x-accepts: application/json - /analytics/engines/bpm/v3/strategies/{path}: - get: - description: This endpoint looks up all Barra strategy documents and sub-directories - in a given directory. - operationId: getBarraStrategyDocuments + /analytics/engines/spar/v3/calculations/{id}: + delete: + description: This is the endpoint to cancel a previously submitted calculation. + operationId: cancelCalculationById parameters: - - description: The directory to get the strategy documents and sub-directories - in + - description: from url, provided from the location header in the Create and + Run SPAR calculation endpoint explode: false in: path - name: path + name: id required: true schema: - default: "" - description: The directory to get the strategy documents and sub-directories - in + description: from url, provided from the location header in the Create and + Run SPAR calculation endpoint type: string style: simple responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Barra strategy documents - and directories + "204": + description: Expected response, calculation was canceled successfully. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -28817,10 +28423,16 @@ paths: style: simple "400": content: + text/plain: + schema: + $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter or value provided + text/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -28858,10 +28470,17 @@ paths: style: simple "404": content: + text/plain: + schema: + $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Path not found + text/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: There was no request for the calculation identifier provided, + or the request was already canceled for the provided identifier. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -28898,7 +28517,7 @@ paths: type: string style: simple "401": - description: Missing or invalid authentication + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -28953,73 +28572,9 @@ paths: schema: type: string style: simple - "406": - description: Unsupported Accept header. Header needs to be set to application/json - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple - "429": - description: Rate limit reached. Wait till the time specified in Retry-After - header value to make further requests. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - Retry-After: - description: Time to wait in seconds before making a new request as - the rate limit has reached. - explode: false - schema: - type: string - style: simple "500": description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting + in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -29038,7 +28593,7 @@ paths: type: string style: simple "503": - description: Request timed out. Retry the request in some time + description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -29056,30 +28611,27 @@ paths: available after successful authentication. type: string style: simple - summary: Get Barra strategy documents and sub-directories in a directory + summary: Cancel SPAR calculation tags: - - StrategyDocuments + - SPARCalculations x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "200" - response-type: DocumentDirectoriesRoot + - status-code: "204" x-accepts: application/json - /analytics/engines/npo/v3/strategies/{path}: get: - description: This endpoint looks up all Northfield strategy documents and sub-directories - in a given directory. - operationId: getNorthfieldStrategyDocuments + description: This is the endpoint that returns the calculation parameters passed + for a calculation. + operationId: getCalculationParameters parameters: - - description: The directory to get the strategy documents and sub-directories - in + - description: from url, provided from the location header in the Create and + Run SPAR calculation endpoint explode: false in: path - name: path + name: id required: true schema: - default: "" - description: The directory to get the strategy documents and sub-directories - in + description: from url, provided from the location header in the Create and + Run SPAR calculation endpoint type: string style: simple responses: @@ -29087,10 +28639,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of Northfield strategy documents - and directories + $ref: '#/components/schemas/SPARCalculationParametersRoot' + description: Expected response, returns the SPAR calculation parameters. headers: + Content-Encoding: + description: Standard HTTP header. Header value based on Accept-Encoding + Request header. + explode: false + schema: + description: Standard HTTP header. Header value based on Accept-Encoding + Request header. + type: string + style: simple + Content-Type: + description: Standard HTTP header. + explode: false + schema: + description: Standard HTTP header. + type: string + style: simple + Transfer-Encoding: + description: Standard HTTP header. Header value will be set to Chunked + if Accept-Encoding header is specified. + explode: false + schema: + description: Standard HTTP header. Header value will be set to Chunked + if Accept-Encoding header is specified. + type: string + style: simple X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -29130,7 +28706,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter or value provided + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -29171,7 +28747,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Path not found + description: Calculation id not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -29208,7 +28784,7 @@ paths: type: string style: simple "401": - description: Missing or invalid authentication + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -29263,8 +28839,9 @@ paths: schema: type: string style: simple - "406": - description: Unsupported Accept header. Header needs to be set to application/json + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -29282,28 +28859,93 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. explode: false schema: + description: FactSet's request key header. type: string style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. explode: false schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. type: string style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. + summary: Get SPAR calculation parameters by id + tags: + - SPARCalculations + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: SPARCalculationParametersRoot + x-accepts: application/json + put: + description: "This endpoint updates and run the SPAR calculation specified in\ + \ the PUT body parameters. This also allows creating new SPAR calculations\ + \ with custom ids.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\ + \n\r\n*\tAny settings in PUT body will act as a one-time override over the\ + \ settings saved in the SPAR template." + operationId: putAndCalculate + parameters: + - description: from url, provided from the location header in the Create and + Run SPAR calculation endpoint + explode: false + in: path + name: id + required: true + schema: + description: from url, provided from the location header in the Create and + Run SPAR calculation endpoint + type: string + style: simple + - description: Long running deadline in seconds when only one unit is passed + in the PUT body. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + type: integer + style: simple + - description: Standard HTTP header. Accepts max-stale. + explode: false + in: header + name: Cache-Control + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SPARCalculationParametersRoot' + description: Calculation Parameters + responses: + "202": + content: + application/json: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + application/x-protobuf: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + description: Expected response, contains the poll URL in the Location header. + headers: + Location: + description: URL to poll for the resulting calculation explode: false schema: + description: URL to poll for the resulting calculation type: string style: simple - "429": - description: Rate limit reached. Wait till the time specified in Retry-After - header value to make further requests. - headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -29320,16 +28962,34 @@ paths: available after successful authentication. type: string style: simple - Retry-After: - description: Time to wait in seconds before making a new request as - the rate limit has reached. + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. explode: false schema: type: string style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + application/x-protobuf: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + description: Expected response, if the calculation has one unit and is completed + with an error. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -29347,8 +29007,35 @@ paths: available after successful authentication. type: string style: simple - "503": - description: Request timed out. Retry the request in some time + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectRoot' + application/x-protobuf: + schema: + $ref: '#/components/schemas/ObjectRoot' + description: 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. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -29366,40 +29053,33 @@ paths: available after successful authentication. type: string style: simple - summary: Get Northfield strategy documents and sub-directories in a directory - tags: - - StrategyDocuments - x-are-multiple-success-responses-different: false - x-success-response-types: - - status-code: "200" - response-type: DocumentDirectoriesRoot - x-accepts: application/json - /analytics/engines/fpo/v3/strategies/{path}: - get: - description: This endpoint looks up all FactSet Portfolio Optimizer strategy - documents and sub-directories in a given directory. - operationId: getFPOStrategyDocuments - parameters: - - description: The directory to get the strategy documents and sub-directories - in - explode: false - in: path - name: path - required: true - schema: - default: "" - description: The directory to get the strategy documents and sub-directories - in - type: string - style: simple - responses: - "200": + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "400": content: application/json: schema: - $ref: '#/components/schemas/DocumentDirectoriesRoot' - description: Expected response, returns a list of FactSet Portfolio Optimizer - strategy documents and directories + $ref: '#/components/schemas/ClientErrorResponse' + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid Calculation Parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -29435,12 +29115,15 @@ paths: schema: type: string style: simple - "400": + "404": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid query parameter or value provided + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: One or more calculation settings were unavailable. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -29476,12 +29159,15 @@ paths: schema: type: string style: simple - "404": + "409": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Path not found + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Duplicate calculation exists with same parameters. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -29518,7 +29204,7 @@ paths: type: string style: simple "401": - description: Missing or invalid authentication + description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -29573,8 +29259,9 @@ paths: schema: type: string style: simple - "406": - description: Unsupported Accept header. Header needs to be set to application/json + "415": + description: Missing/Invalid Content-Type header. Header needs to be set + to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -29611,8 +29298,8 @@ paths: type: string style: simple "429": - description: Rate limit reached. Wait till the time specified in Retry-After - header value to make further requests. + description: Rate limit reached. Cancel older requests using Cancel Calculation + endpoint or wait for older requests to finish/expire. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -29630,6 +29317,24 @@ paths: available after successful authentication. type: string style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple Retry-After: description: Time to wait in seconds before making a new request as the rate limit has reached. @@ -29639,7 +29344,7 @@ paths: style: simple "500": description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting + in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -29658,7 +29363,7 @@ paths: type: string style: simple "503": - description: Request timed out. Retry the request in some time + description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -29676,109 +29381,70 @@ paths: available after successful authentication. type: string style: simple - summary: Get FactSet Portfolio Optimizer strategy documents and sub-directories - in a directory + summary: Create or Update SPAR calculation and run it. tags: - - StrategyDocuments - x-are-multiple-success-responses-different: false + - SPARCalculations + x-are-multiple-success-responses-different: true x-success-response-types: + - status-code: "202" + response-type: CalculationStatusRoot - status-code: "200" - response-type: DocumentDirectoriesRoot + response-type: CalculationStatusRoot + - status-code: "201" + response-type: ObjectRoot + x-contentType: application/json x-accepts: application/json - /analytics/engines/vault/v3/calculations: - post: - description: "This endpoint runs the Vault calculation specified in the POST\ - \ body parameters.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\ - \n\r\n* Start and and end date must be within the configuration's min and\ - \ max date range" - operationId: postAndCalculate + /analytics/engines/spar/v3/calculations/{id}/status: + get: + description: "This is the endpoint to check on the progress of a previously\ + \ requested calculation.\r\nIf the calculation has finished computing, the\ + \ location header will point to the result url." + operationId: getCalculationStatusById parameters: - - description: Long running deadline in seconds when only one unit is passed - in the POST body. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. + - description: from url, provided from the location header in the Create and + Run SPAR calculation endpoint explode: false - in: header - name: Cache-Control - required: false + in: path + name: id + required: true schema: + description: from url, provided from the location header in the Create and + Run SPAR calculation endpoint type: string style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VaultCalculationParametersRoot' - description: Calculation Parameters responses: - "202": + "200": content: application/json: schema: $ref: '#/components/schemas/CalculationStatusRoot' - application/x-protobuf: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, contains the poll URL in the Location header. + description: Expected response once calculation is completed. headers: - Location: - description: URL to poll for the resulting calculation - explode: false - schema: - description: URL to poll for the resulting calculation - type: string - style: simple - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. + Content-Encoding: + description: Standard HTTP header. Header value based on Accept-Encoding + Request header. explode: false schema: + description: Standard HTTP header. Header value based on Accept-Encoding + Request header. type: string style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. + Content-Type: + description: Standard HTTP header. explode: false schema: + description: Standard HTTP header. type: string style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. + Transfer-Encoding: + description: Standard HTTP header. Header value will be set to Chunked + if Accept-Encoding header is specified. explode: false schema: + description: Standard HTTP header. Header value will be set to Chunked + if Accept-Encoding header is specified. type: string style: simple - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - application/x-protobuf: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, if the calculation has one unit and is completed - with an error. - headers: X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -29813,18 +29479,29 @@ paths: schema: type: string style: simple - "201": + "202": content: application/json: schema: - $ref: '#/components/schemas/ObjectRoot' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ObjectRoot' - description: 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. + $ref: '#/components/schemas/CalculationStatusRoot' + description: Expected response returned if the calculation is not yet completed. headers: + X-FactSet-Api-PickUp-Progress: + description: FactSet's progress header. + explode: false + schema: + description: FactSet's progress header. + type: string + style: simple + Cache-Control: + description: Standard HTTP header. Header will specify max-age in seconds. + Polling can be adjusted based on the max-age value. + explode: false + schema: + description: Standard HTTP header. Header will specify max-age in + seconds. Polling can be adjusted based on the max-age value. + type: integer + style: simple X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -29864,10 +29541,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid calculation parameters. + description: Invalid identifier provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -29908,10 +29582,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: One or more calculation settings were unavailable. + description: Calculation was already returned, provided id was not a requested + calculation, or the calculation was cancelled headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -30003,92 +29675,9 @@ paths: schema: type: string style: simple - "415": - description: Missing/Invalid Content-Type header. Header needs to be set - to application/json. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple - "429": - description: Rate limit reached. Cancel older requests using Cancel Calculation - endpoint or wait for older requests to finish/expire. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple - Retry-After: - description: Time to wait in seconds before making a new request as - the rate limit has reached. - explode: false - schema: - type: string - style: simple "500": description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting. + in troubleshooting headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -30125,39 +29714,82 @@ paths: available after successful authentication. type: string style: simple - summary: Create and Run Vault calculation + summary: Get SPAR calculation status by id tags: - - VaultCalculations - x-are-multiple-success-responses-different: true + - SPARCalculations + x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "202" - response-type: CalculationStatusRoot - status-code: "200" response-type: CalculationStatusRoot - - status-code: "201" - response-type: ObjectRoot - x-contentType: application/json + - status-code: "202" + response-type: CalculationStatusRoot x-accepts: application/json - /analytics/engines/vault/v3/calculations/{id}: - delete: - description: This is the endpoint to cancel a previously submitted calculation. - operationId: cancelCalculationById + /analytics/engines/spar/v3/calculations/{id}/units/{unitId}/result: + get: + description: "This is the endpoint to get the result of a previously requested\ + \ calculation.\r\nIf the calculation has finished computing, the body of the\ + \ response will contain the requested document in JSON." + operationId: getCalculationUnitResultById parameters: - - description: from url, provided from the location header in the Create and - Run Vault calculation endpoint + - description: from url, provided from the location header in the Get SPAR calculation + status by id endpoint explode: false in: path name: id required: true schema: - description: from url, provided from the location header in the Create and - Run Vault calculation endpoint + description: from url, provided from the location header in the Get SPAR + calculation status by id endpoint + type: string + style: simple + - description: from url, provided from the location header in the Get SPAR calculation + status by id endpoint + explode: false + in: path + name: unitId + required: true + schema: + description: from url, provided from the location header in the Get SPAR + calculation status by id endpoint type: string style: simple responses: - "204": - description: Expected response, calculation was canceled successfully. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectRoot' + application/x-protobuf: + schema: + $ref: '#/components/schemas/ObjectRoot' + description: Expected response once calculation is completed, returns JSON + in the format specified in the Calculation parameters. headers: + Content-Encoding: + description: Standard HTTP header. Header value based on Accept-Encoding + Request header. + explode: false + schema: + description: Standard HTTP header. Header value based on Accept-Encoding + Request header. + type: string + style: simple + Content-Type: + description: Standard HTTP header. + explode: false + schema: + description: Standard HTTP header. + type: string + style: simple + Transfer-Encoding: + description: Standard HTTP header. Header value will be set to Chunked + if Accept-Encoding header is specified. + explode: false + schema: + description: Standard HTTP header. Header value will be set to Chunked + if Accept-Encoding header is specified. + type: string + style: simple X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -30194,13 +29826,10 @@ paths: style: simple "400": content: - text/plain: - schema: - $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - text/json: + application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' description: Invalid identifier provided. @@ -30241,17 +29870,14 @@ paths: style: simple "404": content: - text/plain: - schema: - $ref: '#/components/schemas/ClientErrorResponse' application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - text/json: + application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: There was no request for the calculation identifier provided, - or the request was already canceled for the provided identifier. + description: Calculation was already returned, provided id was not a requested + calculation, or the calculation was cancelled headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -30345,7 +29971,7 @@ paths: style: simple "500": description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting. + in troubleshooting headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -30382,27 +30008,30 @@ paths: available after successful authentication. type: string style: simple - summary: Cancel Vault calculation by id + summary: Get SPAR calculation result by id tags: - - VaultCalculations + - SPARCalculations x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "204" + - status-code: "200" + response-type: ObjectRoot x-accepts: application/json + /analytics/engines/axp/v3/strategies/{path}: get: - description: This is the endpoint that returns the calculation parameters passed - for a calculation. - operationId: getCalculationParameters + description: This endpoint looks up all Axioma Equity strategy documents and + sub-directories in a given directory. + operationId: getAxiomaEquityStrategyDocuments parameters: - - description: from url, provided from the location header in the Create and - Run Vault calculation endpoint + - description: The directory to get the strategy documents and sub-directories + in explode: false in: path - name: id + name: path required: true schema: - description: from url, provided from the location header in the Create and - Run Vault calculation endpoint + default: "" + description: The directory to get the strategy documents and sub-directories + in type: string style: simple responses: @@ -30410,34 +30039,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/VaultCalculationParametersRoot' - description: Expected response, returns the Vault calculation parameters. + $ref: '#/components/schemas/DocumentDirectoriesRoot' + description: Expected response, returns a list of Axioma Equity strategy + documents and directories headers: - Content-Encoding: - description: Standard HTTP header. Header value based on Accept-Encoding - Request header. - explode: false - schema: - description: Standard HTTP header. Header value based on Accept-Encoding - Request header. - type: string - style: simple - Content-Type: - description: Standard HTTP header. - explode: false - schema: - description: Standard HTTP header. - type: string - style: simple - Transfer-Encoding: - description: Standard HTTP header. Header value will be set to Chunked - if Accept-Encoding header is specified. - explode: false - schema: - description: Standard HTTP header. Header value will be set to Chunked - if Accept-Encoding header is specified. - type: string - style: simple X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -30477,7 +30082,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + description: Invalid query parameter or value provided headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -30518,7 +30123,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Calculation id not found + description: Path not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -30555,7 +30160,7 @@ paths: type: string style: simple "401": - description: Missing or invalid authentication. + description: Missing or invalid authentication headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -30610,6 +30215,70 @@ paths: schema: type: string style: simple + "406": + description: Unsupported Accept header. Header needs to be set to application/json + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false + schema: + type: string + style: simple "500": description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting @@ -30631,7 +30300,7 @@ paths: type: string style: simple "503": - description: Request timed out. Retry the request in sometime. + description: Request timed out. Retry the request in some time headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -30649,164 +30318,40 @@ paths: available after successful authentication. type: string style: simple - summary: Get Vault calculation parameters by id + summary: Get Axioma Equity strategy documents and sub-directories in a directory tags: - - VaultCalculations + - StrategyDocuments x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: VaultCalculationParametersRoot + response-type: DocumentDirectoriesRoot x-accepts: application/json - put: - description: "This endpoint updates and run the Vault calculation specified\ - \ in the PUT body parameters. This also allows creating new Vault calculations\ - \ with custom ids.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\ - \n\r\n* Start and and end date must be within the configuration's min and\ - \ max date range" - operationId: putAndCalculate + /analytics/engines/afi/v3/strategies/{path}: + get: + description: This endpoint looks up all Axioma FI strategy documents and sub-directories + in a given directory. + operationId: getAxiomaFIStrategyDocuments parameters: - - description: from url, provided from the location header in the Create and - Run Vault calculation endpoint + - description: The directory to get the strategy documents and sub-directories + in explode: false in: path - name: id + name: path required: true schema: - description: from url, provided from the location header in the Create and - Run Vault calculation endpoint - type: string - style: simple - - description: Long running deadline in seconds when only one unit is passed - in the PUT body. - explode: false - in: header - name: X-FactSet-Api-Long-Running-Deadline - required: false - schema: - type: integer - style: simple - - description: Standard HTTP header. Accepts max-stale. - explode: false - in: header - name: Cache-Control - required: false - schema: + default: "" + description: The directory to get the strategy documents and sub-directories + in type: string style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VaultCalculationParametersRoot' - description: Calculation Parameters responses: - "202": - content: - application/json: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - application/x-protobuf: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, contains the poll URL in the Location header. - headers: - Location: - description: URL to poll for the resulting calculation - explode: false - schema: - description: URL to poll for the resulting calculation - type: string - style: simple - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple "200": content: application/json: schema: - $ref: '#/components/schemas/CalculationStatusRoot' - application/x-protobuf: - schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response, if the calculation has one unit and is completed - with an error. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/ObjectRoot' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ObjectRoot' - description: 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. + $ref: '#/components/schemas/DocumentDirectoriesRoot' + description: Expected response, returns a list of Axioma FI strategy documents + and directories headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -30847,10 +30392,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid Calculation Parameters. + description: Invalid query parameter or value provided headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -30891,54 +30433,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: One or more calculation settings were unavailable. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. - explode: false - schema: - description: FactSet's request key header. - type: string - style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - explode: false - schema: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. - type: string - style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple - "409": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Duplicate calculation exists with same parameters. + description: Path not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -30975,7 +30470,7 @@ paths: type: string style: simple "401": - description: Missing or invalid authentication. + description: Missing or invalid authentication headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -31030,9 +30525,8 @@ paths: schema: type: string style: simple - "415": - description: Missing/Invalid Content-Type header. Header needs to be set - to application/json. + "406": + description: Unsupported Accept header. Header needs to be set to application/json headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -31069,8 +30563,8 @@ paths: type: string style: simple "429": - description: Rate limit reached. Cancel older requests using Cancel Calculation - endpoint or wait for older requests to finish/expire. + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -31088,24 +30582,6 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. - explode: false - schema: - type: string - style: simple Retry-After: description: Time to wait in seconds before making a new request as the rate limit has reached. @@ -31115,7 +30591,7 @@ paths: style: simple "500": description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting. + in troubleshooting headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -31134,7 +30610,7 @@ paths: type: string style: simple "503": - description: Request timed out. Retry the request in sometime. + description: Request timed out. Retry the request in some time headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -31152,35 +30628,30 @@ paths: available after successful authentication. type: string style: simple - summary: Create or Update Vault calculation and run it. + summary: Get Axioma FI strategy documents and sub-directories in a directory tags: - - VaultCalculations - x-are-multiple-success-responses-different: true + - StrategyDocuments + x-are-multiple-success-responses-different: false x-success-response-types: - - status-code: "202" - response-type: CalculationStatusRoot - status-code: "200" - response-type: CalculationStatusRoot - - status-code: "201" - response-type: ObjectRoot - x-contentType: application/json + response-type: DocumentDirectoriesRoot x-accepts: application/json - /analytics/engines/vault/v3/calculations/{id}/status: + /analytics/engines/bpm/v3/strategies/{path}: get: - description: "This is the endpoint to check on the progress of a previously\ - \ requested calculation.\r\nIf the calculation has finished computing, the\ - \ location header will point to the result url." - operationId: getCalculationStatusById + description: This endpoint looks up all Barra strategy documents and sub-directories + in a given directory. + operationId: getBarraStrategyDocuments parameters: - - description: from url, provided from the location header in the Create and - Run Vault calculation endpoint + - description: The directory to get the strategy documents and sub-directories + in explode: false in: path - name: id + name: path required: true schema: - description: from url, provided from the location header in the Create and - Run Vault calculation endpoint + default: "" + description: The directory to get the strategy documents and sub-directories + in type: string style: simple responses: @@ -31188,34 +30659,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response once calculation is completed. + $ref: '#/components/schemas/DocumentDirectoriesRoot' + description: Expected response, returns a list of Barra strategy documents + and directories headers: - Content-Encoding: - description: Standard HTTP header. Header value based on Accept-Encoding - Request header. - explode: false - schema: - description: Standard HTTP header. Header value based on Accept-Encoding - Request header. - type: string - style: simple - Content-Type: - description: Standard HTTP header. - explode: false - schema: - description: Standard HTTP header. - type: string - style: simple - Transfer-Encoding: - description: Standard HTTP header. Header value will be set to Chunked - if Accept-Encoding header is specified. - explode: false - schema: - description: Standard HTTP header. Header value will be set to Chunked - if Accept-Encoding header is specified. - type: string - style: simple X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -31250,29 +30697,13 @@ paths: schema: type: string style: simple - "202": + "400": content: application/json: schema: - $ref: '#/components/schemas/CalculationStatusRoot' - description: Expected response returned if the calculation is not yet completed. + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid query parameter or value provided headers: - X-FactSet-Api-PickUp-Progress: - description: FactSet's progress header. - explode: false - schema: - description: FactSet's progress header. - type: string - style: simple - Cache-Control: - description: Standard HTTP header. Header will specify max-age in seconds. - Polling can be adjusted based on the max-age value. - explode: false - schema: - description: Standard HTTP header. Header will specify max-age in - seconds. Polling can be adjusted based on the max-age value. - type: integer - style: simple X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -31307,12 +30738,12 @@ paths: schema: type: string style: simple - "400": + "404": content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + description: Path not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -31348,13 +30779,27 @@ paths: schema: type: string style: simple - "404": - content: - application/json: + "401": + description: Missing or invalid authentication + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Calculation was already returned, provided id was not a requested - calculation, or the calculation was cancelled + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -31390,8 +30835,8 @@ paths: schema: type: string style: simple - "401": - description: Missing or invalid authentication. + "406": + description: Unsupported Accept header. Header needs to be set to application/json headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -31409,8 +30854,27 @@ paths: available after successful authentication. type: string style: simple - "403": - description: User is forbidden with current credentials + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -31428,20 +30892,9 @@ paths: available after successful authentication. type: string style: simple - X-FactSet-Api-RateLimit-Limit: - description: Number of allowed requests for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Remaining: - description: Number of requests left for the time window. - explode: false - schema: - type: string - style: simple - X-FactSet-Api-RateLimit-Reset: - description: Number of seconds remaining till rate limit resets. + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. explode: false schema: type: string @@ -31467,7 +30920,7 @@ paths: type: string style: simple "503": - description: Request timed out. Retry the request in sometime. + description: Request timed out. Retry the request in some time headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -31485,43 +30938,30 @@ paths: available after successful authentication. type: string style: simple - summary: Get Vault calculation status by id + summary: Get Barra strategy documents and sub-directories in a directory tags: - - VaultCalculations + - StrategyDocuments x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: CalculationStatusRoot - - status-code: "202" - response-type: CalculationStatusRoot + response-type: DocumentDirectoriesRoot x-accepts: application/json - /analytics/engines/vault/v3/calculations/{id}/units/{unitId}/result: + /analytics/engines/npo/v3/strategies/{path}: get: - description: "This is the endpoint to get the result of a previously requested\ - \ calculation.\r\nIf the calculation has finished computing, the body of the\ - \ response will contain the requested document in JSON." - operationId: getCalculationUnitResultById + description: This endpoint looks up all Northfield strategy documents and sub-directories + in a given directory. + operationId: getNorthfieldStrategyDocuments parameters: - - description: from url, provided from the location header in the Get Vault - calculation status by id endpoint - explode: false - in: path - name: id - required: true - schema: - description: from url, provided from the location header in the Get Vault - calculation status by id endpoint - type: string - style: simple - - description: from url, provided from the location header in the Get Vault - calculation status by id endpoint + - description: The directory to get the strategy documents and sub-directories + in explode: false in: path - name: unitId + name: path required: true schema: - description: from url, provided from the location header in the Get Vault - calculation status by id endpoint + default: "" + description: The directory to get the strategy documents and sub-directories + in type: string style: simple responses: @@ -31529,38 +30969,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ObjectRoot' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ObjectRoot' - description: Expected response once calculation is completed, returns JSON - in the format specified in the Calculation parameters. + $ref: '#/components/schemas/DocumentDirectoriesRoot' + description: Expected response, returns a list of Northfield strategy documents + and directories headers: - Content-Encoding: - description: Standard HTTP header. Header value based on Accept-Encoding - Request header. - explode: false - schema: - description: Standard HTTP header. Header value based on Accept-Encoding - Request header. - type: string - style: simple - Content-Type: - description: Standard HTTP header. - explode: false - schema: - description: Standard HTTP header. - type: string - style: simple - Transfer-Encoding: - description: Standard HTTP header. Header value will be set to Chunked - if Accept-Encoding header is specified. - explode: false - schema: - description: Standard HTTP header. Header value will be set to Chunked - if Accept-Encoding header is specified. - type: string - style: simple X-DataDirect-Request-Key: description: FactSet's request key header. explode: false @@ -31600,10 +31012,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Invalid identifier provided. + description: Invalid query parameter or value provided headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -31644,11 +31053,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' - application/x-protobuf: - schema: - $ref: '#/components/schemas/ClientErrorResponse' - description: Calculation was already returned, provided id was not a requested - calculation, or the calculation was cancelled + description: Path not found headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -31685,7 +31090,7 @@ paths: type: string style: simple "401": - description: Missing or invalid authentication. + description: Missing or invalid authentication headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -31740,9 +31145,8 @@ paths: schema: type: string style: simple - "500": - description: Server error. Log the X-DataDirect-Request-Key header to assist - in troubleshooting + "406": + description: Unsupported Accept header. Header needs to be set to application/json headers: X-DataDirect-Request-Key: description: FactSet's request key header. @@ -31760,46 +31164,7452 @@ paths: available after successful authentication. type: string style: simple - "503": - description: Request timed out. Retry the request in sometime. - headers: - X-DataDirect-Request-Key: - description: FactSet's request key header. + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. explode: false schema: - description: FactSet's request key header. type: string style: simple - X-FactSet-Api-Request-Key: - description: Key to uniquely identify an Analytics API request. Only - available after successful authentication. + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. explode: false schema: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. type: string style: simple - summary: Get Vault calculation result by id + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in some time + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Get Northfield strategy documents and sub-directories in a directory tags: - - VaultCalculations + - StrategyDocuments x-are-multiple-success-responses-different: false x-success-response-types: - status-code: "200" - response-type: ObjectRoot + response-type: DocumentDirectoriesRoot x-accepts: application/json -components: - schemas: - AccountDirectories: + /analytics/engines/fpo/v3/strategies/{path}: + get: + description: This endpoint looks up all FactSet Portfolio Optimizer strategy + documents and sub-directories in a given directory. + operationId: getFPOStrategyDocuments + parameters: + - description: The directory to get the strategy documents and sub-directories + in + explode: false + in: path + name: path + required: true + schema: + default: "" + description: The directory to get the strategy documents and sub-directories + in + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DocumentDirectoriesRoot' + description: Expected response, returns a list of FactSet Portfolio Optimizer + strategy documents and directories + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid query parameter or value provided + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Path not found + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "401": + description: Missing or invalid authentication + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "406": + description: Unsupported Accept header. Header needs to be set to application/json + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in some time + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Get FactSet Portfolio Optimizer strategy documents and sub-directories + in a directory + tags: + - StrategyDocuments + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: DocumentDirectoriesRoot + x-accepts: application/json + /analytics/engines/pa/v3/templated-components: + get: + description: This endpoint returns the list of templated PA components in path. + operationId: getTemplatedPAComponentsInPath + parameters: + - description: Get templated PA components in path + explode: true + in: query + name: directory + required: true + schema: + description: Get templated PA components in path + type: string + style: form + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/TemplatedPAComponentSummaryRoot' + description: Expected response, returns a list templated PA components. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid data provided. Please check the request parameters + before attempting again. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "406": + description: Unsupported Accept header. Header needs to be set to application/json. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Get templated PA components in path + tags: + - TemplatedPAComponents + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: TemplatedPAComponentSummaryRoot + x-accepts: application/json + post: + description: "This endpoint creates new component based off of linked PA template\ + \ or unlinked PA template.\r\n\r\nRemarks:\r\n\r\n* Any settings in the\ + \ POST body will act as a one-time override over the settings saved in the\ + \ PA template.\r\n\r\n* Multi-horizon frequencies are not supported through\ + \ this endpoint.\r\n\r\n* Componentdetail supports securities, groups, and\ + \ totals as well but if we don't pass anything that defaults to securities." + operationId: createTemplatedPAComponents + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TemplatedPAComponentParametersRoot' + description: Request Parameters + required: true + responses: + "201": + content: + text/plain: + schema: + $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot' + application/json: + schema: + $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot' + text/json: + schema: + $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot' + description: Expected response, templated PA component created successfully. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "400": + content: + text/plain: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid data provided. Please check the request parameters + before attempting again. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "404": + description: Template not found. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "406": + description: Unsupported Accept header. Header needs to be set to application/json. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Create templated PA component + tags: + - TemplatedPAComponents + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "201" + response-type: TemplatedPAComponentPostSummaryRoot + x-contentType: application/json + x-accepts: application/json + /analytics/engines/pa/v3/templated-components/{id}: + delete: + description: This endpoint deletes an existing templated PA component + operationId: deleteTemplatedPAComponents + parameters: + - description: Unique identifier for a templated PA component + explode: false + in: path + name: id + required: true + schema: + description: Unique identifier for a templated PA component + type: string + style: simple + responses: + "204": + description: Expected response, deleted the templated PA component successfully. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "400": + content: + text/plain: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid data provided. Please check the request parameters + before attempting again. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "404": + content: + text/plain: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Component not found. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "406": + description: Unsupported Accept header. Header needs to be set to application/json. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Delete templated PA component + tags: + - TemplatedPAComponents + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "204" + x-accepts: application/json + get: + description: This endpoint fetches the templated PA component settings. + operationId: getTemplatedPAComponentById + parameters: + - description: Unique identifier for a templated PA component + explode: false + in: path + name: id + required: true + schema: + description: Unique identifier for a templated PA component + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/TemplatedPAComponentRoot' + description: Expected response, templated PA component details. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid data provided. Please check the request parameters + before attempting again. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Templated PA component not found. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "406": + description: Unsupported Accept header. Header needs to be set to application/json. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Get templated PA component by id + tags: + - TemplatedPAComponents + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: TemplatedPAComponentRoot + x-accepts: application/json + put: + description: "This endpoint allows the user to change the request body from\ + \ an existing templated PA component.\r\n\r\nRemarks:\r\n\r\n* Any settings\ + \ in the POST body will act as a one-time override over the settings saved\ + \ in the PA template.\r\n\r\n* Multi-horizon frequencies are not supported\ + \ through this endpoint.\r\n\r\n* Componentdetail supports securities, groups,\ + \ and totals as well but if we don't pass anything that defaults to securities." + operationId: updateTemplatedPAComponents + parameters: + - description: Unique identifier for a templated PA component + explode: false + in: path + name: id + required: true + schema: + description: Unique identifier for a templated PA component + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TemplatedPAComponentUpdateParametersRoot' + description: Request Parameters + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot' + description: Expected response, updated successfully. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid data provided. Please check the request parameters + before attempting again. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Component or template not found. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "406": + description: Unsupported Accept header. Header needs to be set to application/json. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Update templated PA component + tags: + - TemplatedPAComponents + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: TemplatedPAComponentPostSummaryRoot + x-contentType: application/json + x-accepts: application/json + /analytics/engines/pa/v3/unlinked-templates: + get: + description: This endpoint returns the list of unlinked PA templates. + operationId: getUnlinkedPATemplates + parameters: + - description: Get unlinked PA templates in path. + explode: true + in: query + name: directory + required: false + schema: + description: Get unlinked PA templates in path. + type: string + style: form + - description: Get unlinked PA templates by category. + explode: true + in: query + name: category + required: false + schema: + description: Get unlinked PA templates by category. + type: string + style: form + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UnlinkedPATemplateSummaryRoot' + description: Expected response, returns a list of unlinked PA templates. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid data provided. Please check the request parameters + before attempting again. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "406": + description: Unsupported Accept header. Header needs to be set to application/json. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Get unlinked PA templates + tags: + - UnlinkedPATemplates + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: UnlinkedPATemplateSummaryRoot + x-accepts: application/json + post: + description: "This endpoint creates a template which is not linked to any specific\ + \ PA3 tile. \r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be\ + \ passed in POST requests and Optional fields are not necessary. \r\n If\ + \ no mandatory fields are passed, then we can use the template as a component\ + \ and skip the component creation.\r\n \r\n* Mandatory, optional and\ + \ locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\"\ + , \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot\ + \ override the Locked fields when creating the Component.\r\n\r\n* Mandatory\ + \ and locked strings are mutually exclusive.\r\n\r\n* Any settings in the\ + \ POST body will act as a one-time override over the settings saved in the\ + \ PA template.\r\n\r\n* Multi-horizon frequencies are not supported through\ + \ this endpoint.\r\n\r\n* Componentdetail supports securities, groups, and\ + \ totals as well but if we don't pass anything that defaults to securities." + operationId: createUnlinkedPATemplates + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnlinkedPATemplateParametersRoot' + description: Request Parameters + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UnlinkedPATemplatePostSummaryRoot' + description: Expected response, created a unlinked PA template. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid data provided. Please check the request parameters + before attempting again. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "406": + description: Unsupported Accept header. Header needs to be set to application/json. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Create unlinked PA template + tags: + - UnlinkedPATemplates + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "201" + response-type: UnlinkedPATemplatePostSummaryRoot + x-contentType: application/json + x-accepts: application/json + /analytics/engines/pa/v3/unlinked-templates/{id}: + delete: + description: This endpoint deletes an existing unliked PA template. + operationId: deleteUnlinkedPATemplates + parameters: + - description: Unique identifier for an unlinked PA template + explode: false + in: path + name: id + required: true + schema: + description: Unique identifier for an unlinked PA template + type: string + style: simple + responses: + "204": + description: Expected response, deleted the unlinked PA template successfully. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid data provided. Please check the request parameters + before attempting again. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Template not found. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "406": + description: Unsupported Accept header. Header needs to be set to application/json. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Delete unlinked PA template + tags: + - UnlinkedPATemplates + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "204" + x-accepts: application/json + get: + description: This endpoint fetches the template settings. + operationId: getUnlinkedPATemplatesById + parameters: + - description: Unique identifier for an unlinked PA template + explode: false + in: path + name: id + required: true + schema: + description: Unique identifier for an unlinked PA template + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UnlinkedPATemplateRoot' + description: Expected response, get details of the unlinked PA template. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid data provided. Please check the request parameters + before attempting again. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Template not found. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "406": + description: Unsupported Accept header. Header needs to be set to application/json. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Get unlinked PA template details by id + tags: + - UnlinkedPATemplates + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: UnlinkedPATemplateRoot + x-accepts: application/json + put: + description: "This endpoint updates an existing unlinked PA template.\r\n\r\n\ + Remarks:\r\n \r\n* Mandatory fields are required to be passed\ + \ in POST requests and Optional fields are not necessary. \r\n If no mandatory\ + \ fields are passed, then we can use the template as a component and skip\ + \ the component creation.\r\n \r\n* Mandatory, optional and locked fields\ + \ can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"dates\"\ + , \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot override\ + \ the Locked fields when creating the Component.\r\n\r\n* Mandatory and\ + \ locked strings are mutually exclusive.\r\n\r\n* Any settings in the POST\ + \ body will act as a one-time override over the settings saved in the PA template.\r\ + \n\r\n* Multi-horizon frequencies are not supported through this endpoint.\r\ + \n\r\n* Componentdetail supports securities, groups, and totals as well\ + \ but if we don't pass anything that defaults to securities." + operationId: updateUnlinkedPATemplates + parameters: + - description: Unique identifier for an unlinked PA template + explode: false + in: path + name: id + required: true + schema: + description: Unique identifier for an unlinked PA template + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnlinkedPATemplateUpdateParametersRoot' + description: Request Parameters + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UnlinkedPATemplatePostSummaryRoot' + description: Expected response, updated the unlinked PA template. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid data provided. Please check the request parameters + before attempting again. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Template not found. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "406": + description: Unsupported Accept header. Header needs to be set to application/json. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Update unlinked PA template + tags: + - UnlinkedPATemplates + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: UnlinkedPATemplatePostSummaryRoot + x-contentType: application/json + x-accepts: application/json + /analytics/engines/pa/v3/unlinked-templates/template-types: + get: + description: This endpoint fetches default unlinked PA template types. + operationId: getDefaultUnlinkedPATemplateTypes + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndTypeRoot' + description: Expected response, default unlinked PA template types + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "406": + description: Unsupported Accept header. Header needs to be set to application/json. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Get default unlinked PA template types. + tags: + - UnlinkedPATemplates + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: UnlinkedPATemplateCategoryAndTypeRoot + x-accepts: application/json + /analytics/engines/pa/v3/unlinked-templates/template-types/{id}: + get: + description: This endpoint fetches the unlinked PA template type details. + operationId: getDetailsType + parameters: + - description: Unique identifier for an unlinked PA template type + explode: false + in: path + name: id + required: true + schema: + description: Unique identifier for an unlinked PA template type + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetailsRoot' + description: Expected response, details of the unlinked PA template type + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid data provided. Please check the request parameters + before attempting again. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Unlinked PA template type not found. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "406": + description: Unsupported Accept header. Header needs to be set to application/json. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "429": + description: Rate limit reached. Wait till the time specified in Retry-After + header value to make further requests. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Get unlinked PA template type details by id. + tags: + - UnlinkedPATemplates + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: UnlinkedPATemplateCategoryAndTypeDetailsRoot + x-accepts: application/json + /analytics/engines/vault/v3/calculations: + post: + description: "This endpoint runs the Vault calculation specified in the POST\ + \ body parameters.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\ + \n\r\n* Start and and end date must be within the configuration's min and\ + \ max date range" + operationId: postAndCalculate + parameters: + - description: Long running deadline in seconds when only one unit is passed + in the POST body. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + type: integer + style: simple + - description: Standard HTTP header. Accepts max-stale. + explode: false + in: header + name: Cache-Control + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VaultCalculationParametersRoot' + description: Calculation Parameters + responses: + "202": + content: + application/json: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + application/x-protobuf: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + description: Expected response, contains the poll URL in the Location header. + headers: + Location: + description: URL to poll for the resulting calculation + explode: false + schema: + description: URL to poll for the resulting calculation + type: string + style: simple + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + application/x-protobuf: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + description: Expected response, if the calculation has one unit and is completed + with an error. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectRoot' + application/x-protobuf: + schema: + $ref: '#/components/schemas/ObjectRoot' + description: 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. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid calculation parameters. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: One or more calculation settings were unavailable. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "415": + description: Missing/Invalid Content-Type header. Header needs to be set + to application/json. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "429": + description: Rate limit reached. Cancel older requests using Cancel Calculation + endpoint or wait for older requests to finish/expire. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Create and Run Vault calculation + tags: + - VaultCalculations + x-are-multiple-success-responses-different: true + x-success-response-types: + - status-code: "202" + response-type: CalculationStatusRoot + - status-code: "200" + response-type: CalculationStatusRoot + - status-code: "201" + response-type: ObjectRoot + x-contentType: application/json + x-accepts: application/json + /analytics/engines/vault/v3/calculations/{id}: + delete: + description: This is the endpoint to cancel a previously submitted calculation. + operationId: cancelCalculationById + parameters: + - description: from url, provided from the location header in the Create and + Run Vault calculation endpoint + explode: false + in: path + name: id + required: true + schema: + description: from url, provided from the location header in the Create and + Run Vault calculation endpoint + type: string + style: simple + responses: + "204": + description: Expected response, calculation was canceled successfully. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "400": + content: + text/plain: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid identifier provided. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "404": + content: + text/plain: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: There was no request for the calculation identifier provided, + or the request was already canceled for the provided identifier. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Cancel Vault calculation by id + tags: + - VaultCalculations + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "204" + x-accepts: application/json + get: + description: This is the endpoint that returns the calculation parameters passed + for a calculation. + operationId: getCalculationParameters + parameters: + - description: from url, provided from the location header in the Create and + Run Vault calculation endpoint + explode: false + in: path + name: id + required: true + schema: + description: from url, provided from the location header in the Create and + Run Vault calculation endpoint + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/VaultCalculationParametersRoot' + description: Expected response, returns the Vault calculation parameters. + headers: + Content-Encoding: + description: Standard HTTP header. Header value based on Accept-Encoding + Request header. + explode: false + schema: + description: Standard HTTP header. Header value based on Accept-Encoding + Request header. + type: string + style: simple + Content-Type: + description: Standard HTTP header. + explode: false + schema: + description: Standard HTTP header. + type: string + style: simple + Transfer-Encoding: + description: Standard HTTP header. Header value will be set to Chunked + if Accept-Encoding header is specified. + explode: false + schema: + description: Standard HTTP header. Header value will be set to Chunked + if Accept-Encoding header is specified. + type: string + style: simple + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid identifier provided. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Calculation id not found + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Get Vault calculation parameters by id + tags: + - VaultCalculations + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: VaultCalculationParametersRoot + x-accepts: application/json + put: + description: "This endpoint updates and run the Vault calculation specified\ + \ in the PUT body parameters. This also allows creating new Vault calculations\ + \ with custom ids.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\ + \n\r\n* Start and and end date must be within the configuration's min and\ + \ max date range" + operationId: putAndCalculate + parameters: + - description: from url, provided from the location header in the Create and + Run Vault calculation endpoint + explode: false + in: path + name: id + required: true + schema: + description: from url, provided from the location header in the Create and + Run Vault calculation endpoint + type: string + style: simple + - description: Long running deadline in seconds when only one unit is passed + in the PUT body. + explode: false + in: header + name: X-FactSet-Api-Long-Running-Deadline + required: false + schema: + type: integer + style: simple + - description: Standard HTTP header. Accepts max-stale. + explode: false + in: header + name: Cache-Control + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VaultCalculationParametersRoot' + description: Calculation Parameters + responses: + "202": + content: + application/json: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + application/x-protobuf: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + description: Expected response, contains the poll URL in the Location header. + headers: + Location: + description: URL to poll for the resulting calculation + explode: false + schema: + description: URL to poll for the resulting calculation + type: string + style: simple + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + application/x-protobuf: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + description: Expected response, if the calculation has one unit and is completed + with an error. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectRoot' + application/x-protobuf: + schema: + $ref: '#/components/schemas/ObjectRoot' + description: 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. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid Calculation Parameters. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: One or more calculation settings were unavailable. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "409": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Duplicate calculation exists with same parameters. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "415": + description: Missing/Invalid Content-Type header. Header needs to be set + to application/json. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "429": + description: Rate limit reached. Cancel older requests using Cancel Calculation + endpoint or wait for older requests to finish/expire. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + Retry-After: + description: Time to wait in seconds before making a new request as + the rate limit has reached. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Create or Update Vault calculation and run it. + tags: + - VaultCalculations + x-are-multiple-success-responses-different: true + x-success-response-types: + - status-code: "202" + response-type: CalculationStatusRoot + - status-code: "200" + response-type: CalculationStatusRoot + - status-code: "201" + response-type: ObjectRoot + x-contentType: application/json + x-accepts: application/json + /analytics/engines/vault/v3/calculations/{id}/status: + get: + description: "This is the endpoint to check on the progress of a previously\ + \ requested calculation.\r\nIf the calculation has finished computing, the\ + \ location header will point to the result url." + operationId: getCalculationStatusById + parameters: + - description: from url, provided from the location header in the Create and + Run Vault calculation endpoint + explode: false + in: path + name: id + required: true + schema: + description: from url, provided from the location header in the Create and + Run Vault calculation endpoint + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + description: Expected response once calculation is completed. + headers: + Content-Encoding: + description: Standard HTTP header. Header value based on Accept-Encoding + Request header. + explode: false + schema: + description: Standard HTTP header. Header value based on Accept-Encoding + Request header. + type: string + style: simple + Content-Type: + description: Standard HTTP header. + explode: false + schema: + description: Standard HTTP header. + type: string + style: simple + Transfer-Encoding: + description: Standard HTTP header. Header value will be set to Chunked + if Accept-Encoding header is specified. + explode: false + schema: + description: Standard HTTP header. Header value will be set to Chunked + if Accept-Encoding header is specified. + type: string + style: simple + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "202": + content: + application/json: + schema: + $ref: '#/components/schemas/CalculationStatusRoot' + description: Expected response returned if the calculation is not yet completed. + headers: + X-FactSet-Api-PickUp-Progress: + description: FactSet's progress header. + explode: false + schema: + description: FactSet's progress header. + type: string + style: simple + Cache-Control: + description: Standard HTTP header. Header will specify max-age in seconds. + Polling can be adjusted based on the max-age value. + explode: false + schema: + description: Standard HTTP header. Header will specify max-age in + seconds. Polling can be adjusted based on the max-age value. + type: integer + style: simple + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid identifier provided. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Calculation was already returned, provided id was not a requested + calculation, or the calculation was cancelled + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Get Vault calculation status by id + tags: + - VaultCalculations + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: CalculationStatusRoot + - status-code: "202" + response-type: CalculationStatusRoot + x-accepts: application/json + /analytics/engines/vault/v3/calculations/{id}/units/{unitId}/result: + get: + description: "This is the endpoint to get the result of a previously requested\ + \ calculation.\r\nIf the calculation has finished computing, the body of the\ + \ response will contain the requested document in JSON." + operationId: getCalculationUnitResultById + parameters: + - description: from url, provided from the location header in the Get Vault + calculation status by id endpoint + explode: false + in: path + name: id + required: true + schema: + description: from url, provided from the location header in the Get Vault + calculation status by id endpoint + type: string + style: simple + - description: from url, provided from the location header in the Get Vault + calculation status by id endpoint + explode: false + in: path + name: unitId + required: true + schema: + description: from url, provided from the location header in the Get Vault + calculation status by id endpoint + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectRoot' + application/x-protobuf: + schema: + $ref: '#/components/schemas/ObjectRoot' + description: Expected response once calculation is completed, returns JSON + in the format specified in the Calculation parameters. + headers: + Content-Encoding: + description: Standard HTTP header. Header value based on Accept-Encoding + Request header. + explode: false + schema: + description: Standard HTTP header. Header value based on Accept-Encoding + Request header. + type: string + style: simple + Content-Type: + description: Standard HTTP header. + explode: false + schema: + description: Standard HTTP header. + type: string + style: simple + Transfer-Encoding: + description: Standard HTTP header. Header value will be set to Chunked + if Accept-Encoding header is specified. + explode: false + schema: + description: Standard HTTP header. Header value will be set to Chunked + if Accept-Encoding header is specified. + type: string + style: simple + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Invalid identifier provided. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + application/x-protobuf: + schema: + $ref: '#/components/schemas/ClientErrorResponse' + description: Calculation was already returned, provided id was not a requested + calculation, or the calculation was cancelled + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "401": + description: Missing or invalid authentication. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "403": + description: User is forbidden with current credentials + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + X-FactSet-Api-RateLimit-Limit: + description: Number of allowed requests for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Remaining: + description: Number of requests left for the time window. + explode: false + schema: + type: string + style: simple + X-FactSet-Api-RateLimit-Reset: + description: Number of seconds remaining till rate limit resets. + explode: false + schema: + type: string + style: simple + "500": + description: Server error. Log the X-DataDirect-Request-Key header to assist + in troubleshooting + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + "503": + description: Request timed out. Retry the request in sometime. + headers: + X-DataDirect-Request-Key: + description: FactSet's request key header. + explode: false + schema: + description: FactSet's request key header. + type: string + style: simple + X-FactSet-Api-Request-Key: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + explode: false + schema: + description: Key to uniquely identify an Analytics API request. Only + available after successful authentication. + type: string + style: simple + summary: Get Vault calculation result by id + tags: + - VaultCalculations + x-are-multiple-success-responses-different: false + x-success-response-types: + - status-code: "200" + response-type: ObjectRoot + x-accepts: application/json +components: + schemas: + ReturnType: + additionalProperties: false + example: + name: name + id: id + properties: + name: + type: string + id: + type: string + type: object + SPARAccounts: + additionalProperties: false + example: + returnsType: + - name: name + id: id + - name: name + id: id + properties: + returnsType: + description: List of SPAR returnsType + items: + $ref: '#/components/schemas/ReturnType' + type: array + type: object + SPARAccountsRoot: + additionalProperties: false + example: + data: + returnsType: + - name: name + id: id + - name: name + id: id + meta: "" + properties: + data: + $ref: '#/components/schemas/SPARAccounts' + meta: {} + required: + - data + type: object + ErrorSource: + additionalProperties: false + example: + pointer: pointer + parameter: parameter + properties: + pointer: + type: string + parameter: + type: string + type: object + Error: + additionalProperties: false + example: + id: id + detail: detail + source: + pointer: pointer + parameter: parameter + properties: + id: + type: string + detail: + type: string + source: + $ref: '#/components/schemas/ErrorSource' + type: object + ClientErrorResponse: + additionalProperties: false + properties: + errors: + items: + $ref: '#/components/schemas/Error' + type: array + type: object + AccountDirectories: + additionalProperties: false + example: + directories: + - directories + - directories + accounts: + - accounts + - accounts + properties: + accounts: + description: List of account and composite files. + items: + type: string + type: array + directories: + description: List of directories. + items: + type: string + type: array + type: object + AccountDirectoriesRoot: + additionalProperties: false + example: + data: + directories: + - directories + - directories + accounts: + - accounts + - accounts + meta: "" + properties: + data: + $ref: '#/components/schemas/AccountDirectories' + meta: {} + required: + - data + type: object + AFIOptimizerStrategyOverrides: + additionalProperties: false + example: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + properties: + objective: + description: Objective + type: string + tax: + description: Tax + type: string + constraints: + additionalProperties: + enum: + - Disable + - Enable + type: string + description: List of constraints + type: object + alpha: + description: Alpha + type: string + transactionCost: + description: Transaction cost + type: string + type: object + AFIOptimizerStrategy: + additionalProperties: false + example: + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + id: id + properties: + overrides: + $ref: '#/components/schemas/AFIOptimizerStrategyOverrides' + id: + description: OptimizerStrategy document path + type: string + required: + - id + type: object + OptimizerAccountOverrides: + additionalProperties: false + example: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + properties: + portfolio: + description: Portfolio + type: string + benchmark: + description: Benchmark + type: string + riskModelId: + description: Risk model + type: string + currency: + description: Currency + type: string + type: object + OptimizerAccount: + additionalProperties: false + example: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + properties: + id: + description: Account path + type: string + overrides: + $ref: '#/components/schemas/OptimizerAccountOverrides' + type: object + Optimization: + additionalProperties: false + example: + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + properties: + riskModelDate: + description: Risk model date + type: string + backtestDate: + description: Backtest date + type: string + cashflow: + description: Cash flow + type: string + type: object + OptimizerTradesList: + additionalProperties: false + example: + includeCash: true + identifierType: Asset + properties: + identifierType: + description: Identifier type + enum: + - Asset + - Cusip + - Isin + - RiskModel + - SedolChk + - Sedol + - SymbologyCusip + - Ticker + - TickerRegion + - User + type: string + includeCash: + description: Include cash + type: boolean + type: object + OptimizerOptimalHoldings: + additionalProperties: false + example: + includeCash: true + excludeZero: true + identifierType: Asset + properties: + identifierType: + description: Identifier type + enum: + - Asset + - Cusip + - Isin + - RiskModel + - SedolChk + - Sedol + - SymbologyCusip + - Ticker + - TickerRegion + - User + type: string + includeCash: + description: Include cash + type: boolean + excludeZero: + description: Exclude zero + type: boolean + type: object + OptimalPortfolio: + additionalProperties: false + example: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + properties: + acctName: + description: Account path + type: string + excludeZero: + description: Exclude zero + type: boolean + archiveDate: + description: Archive date + type: string + ifAcctExists: + description: Archive action if account exists + enum: + - abort + - overwrite + - appendDate + type: string + ifOfdbDateExists: + description: Action if ofdb date exists + enum: + - abort + - replaceDate + - appendSecurities + type: string + type: object + OptimizerStats: + additionalProperties: false + type: object + OptimizerOutputTypes: + additionalProperties: false + example: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + properties: + trades: + $ref: '#/components/schemas/OptimizerTradesList' + optimal: + $ref: '#/components/schemas/OptimizerOptimalHoldings' + account: + $ref: '#/components/schemas/OptimalPortfolio' + stats: + additionalProperties: false + type: object + type: object + AFIOptimizationParameters: + additionalProperties: false + example: + optimization: + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + id: id + account: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + properties: + strategy: + $ref: '#/components/schemas/AFIOptimizerStrategy' + account: + $ref: '#/components/schemas/OptimizerAccount' + optimization: + $ref: '#/components/schemas/Optimization' + outputTypes: + $ref: '#/components/schemas/OptimizerOutputTypes' + required: + - outputTypes + - strategy + type: object + OptimizerCalculationMeta: + additionalProperties: false + type: object + AFIOptimizationParametersRoot: + additionalProperties: false + example: + data: + optimization: + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + id: id + account: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + meta: '{}' + properties: + data: + $ref: '#/components/schemas/AFIOptimizationParameters' + meta: + additionalProperties: false + type: object + type: object + CalculationInfo: + additionalProperties: false + properties: + calculationId: + description: Calculation identifier + type: string + type: object + CalculationInfoRoot: + additionalProperties: false + properties: + data: + $ref: '#/components/schemas/CalculationInfo' + meta: {} + required: + - data + type: object + ObjectRoot: + additionalProperties: false + example: + data: "" + meta: "" + properties: + data: {} + meta: {} + required: + - data + type: object + AxiomaEquityOptimizerStrategyOverrides: + additionalProperties: false + example: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + properties: + objective: + description: Objective + type: string + tax: + description: Tax + type: string + constraints: + additionalProperties: + enum: + - Disable + - Enable + type: string + description: List of constraints + type: object + alpha: + description: Alpha + type: string + transactionCost: + description: Transaction cost + type: string + type: object + AxiomaEquityOptimizerStrategy: + additionalProperties: false + example: + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + id: id + properties: + overrides: + $ref: '#/components/schemas/AxiomaEquityOptimizerStrategyOverrides' + id: + description: OptimizerStrategy document path + type: string + required: + - id + type: object + AxiomaEquityOptimizationParameters: + additionalProperties: false + example: + optimization: + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + id: id + account: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + properties: + strategy: + $ref: '#/components/schemas/AxiomaEquityOptimizerStrategy' + account: + $ref: '#/components/schemas/OptimizerAccount' + optimization: + $ref: '#/components/schemas/Optimization' + outputTypes: + $ref: '#/components/schemas/OptimizerOutputTypes' + required: + - outputTypes + - strategy + type: object + AxiomaEquityOptimizationParametersRoot: + additionalProperties: false + example: + data: + optimization: + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: alpha + tax: tax + transactionCost: transactionCost + constraints: + key: Disable + objective: objective + id: id + account: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + meta: '{}' + properties: + data: + $ref: '#/components/schemas/AxiomaEquityOptimizationParameters' + meta: + additionalProperties: false + type: object + type: object + SPARIdentifier: + additionalProperties: false + description: The account/benchmark parameter for SPAR calculation. + example: + prefix: prefix + returntype: returntype + id: id + properties: + id: + description: User's FactSet account OR benchmark id. + type: string + returntype: + description: Benchmark return type. + type: string + prefix: + description: Benchmark prefix. + type: string + required: + - id + type: object + SPARBenchmark: + additionalProperties: false + example: + identifiers: + - prefix: prefix + returntype: returntype + id: id + - prefix: prefix + returntype: returntype + id: id + name: name + id: id + properties: + id: + description: Benchmark identifier + type: string + name: + description: Benchmark Name + type: string + identifiers: + description: List of SPAR identifiers + items: + $ref: '#/components/schemas/SPARIdentifier' + type: array + type: object + SPARBenchmarkRoot: + additionalProperties: false + example: + data: + identifiers: + - prefix: prefix + returntype: returntype + id: id + - prefix: prefix + returntype: returntype + id: id + name: name + id: id + meta: "" + properties: + data: + $ref: '#/components/schemas/SPARBenchmark' + meta: {} + required: + - data + type: object + ConstraintAction: + additionalProperties: false + example: + item2: Disable + item1: item1 + properties: + item1: + type: string + item2: + enum: + - Disable + - Enable + type: string + type: object + BPMOptimizerStrategyAlphaOverride: + additionalProperties: false + example: + returnMultiplier: returnMultiplier + formula: formula + returnType: Excess + properties: + formula: + type: string + returnType: + enum: + - Excess + - Total + - Active + - Residual + - Exceptional + type: string + returnMultiplier: + type: string + type: object + BPMOptimizerStrategyOverrides: + additionalProperties: false + example: + alpha: + returnMultiplier: returnMultiplier + formula: formula + returnType: Excess + tax: tax + transactionCost: transactionCost + constraints: + - item2: Disable + item1: item1 + - item2: Disable + item1: item1 + properties: + constraints: + description: List of constraints + items: + $ref: '#/components/schemas/ConstraintAction' + type: array + alpha: + $ref: '#/components/schemas/BPMOptimizerStrategyAlphaOverride' + tax: + description: "Tax\r\nCan be set to \"\" for local" + type: string + transactionCost: + description: "Transaction cost\r\nCan be set to \"\" for local" + type: string + type: object + BPMOptimizerStrategy: + additionalProperties: false + example: + overrides: + alpha: + returnMultiplier: returnMultiplier + formula: formula + returnType: Excess + tax: tax + transactionCost: transactionCost + constraints: + - item2: Disable + item1: item1 + - item2: Disable + item1: item1 + id: id + properties: + overrides: + $ref: '#/components/schemas/BPMOptimizerStrategyOverrides' + id: + description: OptimizerStrategy document path + type: string + required: + - id + type: object + BPMOptimization: + additionalProperties: false + example: + market: market + investAllCash: true + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + properties: + market: + description: Optimization market + type: string + investAllCash: + description: Optimization invest all cash + type: boolean + riskModelDate: + description: Risk model date + type: string + backtestDate: + description: Backtest date + type: string + cashflow: + description: Cash flow + type: string + type: object + BPMOptimizationParameters: + additionalProperties: false + example: + optimization: + market: market + investAllCash: true + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: + returnMultiplier: returnMultiplier + formula: formula + returnType: Excess + tax: tax + transactionCost: transactionCost + constraints: + - item2: Disable + item1: item1 + - item2: Disable + item1: item1 + id: id + account: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + properties: + strategy: + $ref: '#/components/schemas/BPMOptimizerStrategy' + optimization: + $ref: '#/components/schemas/BPMOptimization' + account: + $ref: '#/components/schemas/OptimizerAccount' + outputTypes: + $ref: '#/components/schemas/OptimizerOutputTypes' + required: + - outputTypes + - strategy + type: object + BPMOptimizationParametersRoot: + additionalProperties: false + example: + data: + optimization: + market: market + investAllCash: true + cashflow: cashflow + riskModelDate: riskModelDate + backtestDate: backtestDate + outputTypes: + optimal: + includeCash: true + excludeZero: true + identifierType: Asset + stats: '{}' + trades: + includeCash: true + identifierType: Asset + account: + ifOfdbDateExists: abort + excludeZero: true + ifAcctExists: abort + archiveDate: archiveDate + acctName: acctName + strategy: + overrides: + alpha: + returnMultiplier: returnMultiplier + formula: formula + returnType: Excess + tax: tax + transactionCost: transactionCost + constraints: + - item2: Disable + item1: item1 + - item2: Disable + item1: item1 + id: id + account: + id: id + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark + meta: '{}' + properties: + data: + $ref: '#/components/schemas/BPMOptimizationParameters' + meta: + additionalProperties: false + type: object + type: object + ColumnSummary: + additionalProperties: false + description: Column settings (name, directory, category) + example: + name: name + category: category + directory: directory + properties: + name: + description: Column Name + type: string + directory: + description: Column Directory + type: string + category: + description: Column Category + type: string + type: object + ColumnSummaryRoot: + additionalProperties: false + example: + data: + key: + name: name + category: category + directory: directory + meta: "" + properties: + data: + additionalProperties: + $ref: '#/components/schemas/ColumnSummary' + type: object + meta: {} + required: + - data + type: object + Column: + additionalProperties: false + example: + defaultstatisticsids: + - defaultstatisticsids + - defaultstatisticsids + name: name + category: category + directory: directory + properties: + defaultstatisticsids: + description: Column statistic Id + items: + type: string + type: array + name: + description: Column Name + type: string + directory: + description: Column Directory + type: string + category: + description: Column Category + type: string + type: object + ColumnRoot: + additionalProperties: false + example: + data: + defaultstatisticsids: + - defaultstatisticsids + - defaultstatisticsids + name: name + category: category + directory: directory + meta: "" + properties: + data: + $ref: '#/components/schemas/Column' + meta: {} + required: + - data + type: object + ColumnStatistic: + additionalProperties: false + example: + name: name + properties: + name: + description: Column Statistic Name + type: string + type: object + ColumnStatisticRoot: + additionalProperties: false + example: + data: + key: + name: name + meta: "" + properties: + data: + additionalProperties: + $ref: '#/components/schemas/ColumnStatistic' + type: object + meta: {} + required: + - data + type: object + ComponentSummary: + additionalProperties: false + example: + name: name + category: category + properties: + name: + description: Component name. + type: string + category: + description: Component category. + type: string + type: object + ComponentSummaryRoot: + additionalProperties: false + example: + data: + key: + name: name + category: category + meta: "" + properties: + data: + additionalProperties: + $ref: '#/components/schemas/ComponentSummary' + type: object + meta: {} + required: + - data + type: object + PAIdentifier: + additionalProperties: false + example: + id: id + holdingsmode: holdingsmode + properties: + id: + description: User's FactSet account path OR benchmark. + type: string + holdingsmode: + description: Holdings Mode can be B&H, TBR, OMS or EXT. + type: string + required: + - id + type: object + PADateParameters: + additionalProperties: false + description: The date parameters for PA calculation. + example: + enddate: enddate + startdate: startdate + frequency: frequency + properties: + startdate: + description: Calculation's start date. + type: string + enddate: + description: Calculation's end date. + type: string + frequency: + description: Calculation's frequency. + type: string + required: + - enddate + - frequency + type: object + PAComponent: + additionalProperties: false + example: + currencyisocode: currencyisocode + path: path + name: name + dates: + enddate: enddate + startdate: startdate + frequency: frequency + id: id + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + category: category + snapshot: true + properties: + id: + description: Component identifier. + type: string + accounts: + description: List of accounts saved in the PA document. + items: + $ref: '#/components/schemas/PAIdentifier' + type: array + benchmarks: + description: List of benchmarks saved in the PA document. + items: + $ref: '#/components/schemas/PAIdentifier' + type: array + currencyisocode: + type: string + dates: + $ref: '#/components/schemas/PADateParameters' + snapshot: + description: Is the component type snapshot or subperiod. + type: boolean + path: + description: The path to the document + type: string + name: + description: Component name. + type: string + category: + description: Component category. + type: string + type: object + PAComponentRoot: + additionalProperties: false + example: + data: + currencyisocode: currencyisocode + path: path + name: name + dates: + enddate: enddate + startdate: startdate + frequency: frequency + id: id + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + category: category + snapshot: true + meta: "" + properties: + data: + $ref: '#/components/schemas/PAComponent' + meta: {} + required: + - data + type: object + VaultIdentifier: + additionalProperties: false + description: The account/benchmark parameter for Vault calculation. + example: + id: id + properties: + id: + description: User's FactSet account path OR benchmark. + type: string + required: + - id + type: object + VaultDateParameters: + additionalProperties: false + description: The date parameters for Vault calculation + example: + enddate: enddate + startdate: startdate + frequency: frequency + properties: + startdate: + description: Calculation's start date. + type: string + enddate: + description: Calculation's end date. + type: string + frequency: + description: Calculation's frequency. + type: string + required: + - enddate + - frequency + type: object + VaultComponent: + additionalProperties: false + example: + currencyisocode: currencyisocode + path: path + name: name + dates: + enddate: enddate + startdate: startdate + frequency: frequency + id: id + category: category + account: + id: id + benchmark: + id: id + snapshot: true + properties: + id: + description: Vault component identifier + type: string + account: + $ref: '#/components/schemas/VaultIdentifier' + benchmark: + $ref: '#/components/schemas/VaultIdentifier' + currencyisocode: + description: Currency iso code saved in the document + type: string + dates: + $ref: '#/components/schemas/VaultDateParameters' + snapshot: + description: Snapshot + type: boolean + path: + description: The path to the document + type: string + name: + description: Component name. + type: string + category: + description: Component category. + type: string + type: object + VaultComponentRoot: + additionalProperties: false + example: + data: + currencyisocode: currencyisocode + path: path + name: name + dates: + enddate: enddate + startdate: startdate + frequency: frequency + id: id + category: category + account: + id: id + benchmark: + id: id + snapshot: true + meta: "" + properties: + data: + $ref: '#/components/schemas/VaultComponent' + meta: {} + required: + - data + type: object + VaultConfigurationSummary: + additionalProperties: false + example: + name: name + properties: + name: + description: Configuration name. + type: string + type: object + VaultConfigurationSummaryRoot: + additionalProperties: false + example: + data: + key: + name: name + meta: "" + properties: + data: + additionalProperties: + $ref: '#/components/schemas/VaultConfigurationSummary' + type: object + meta: {} + required: + - data + type: object + ConfigurationAccount: + additionalProperties: false + example: + maxEndDate: maxEndDate + minStartDate: minStartDate + lockingDate: lockingDate + name: name + benchmarkCode: benchmarkCode + benchmarkName: benchmarkName + properties: + benchmarkCode: + description: Benchmark code. + type: string + benchmarkName: + description: Benchmark name. + type: string + maxEndDate: + description: Maximum end date. + type: string + minStartDate: + description: Minimum start date. + type: string + lockingDate: + description: Locking date. + type: string + name: + description: Account name. + type: string + type: object + VaultConfiguration: + additionalProperties: false + example: + name: name + accounts: + key: + maxEndDate: maxEndDate + minStartDate: minStartDate + lockingDate: lockingDate + name: name + benchmarkCode: benchmarkCode + benchmarkName: benchmarkName + properties: + name: + description: Configuration name. + type: string + accounts: + additionalProperties: + $ref: '#/components/schemas/ConfigurationAccount' + type: object + type: object + VaultConfigurationRoot: + additionalProperties: false + example: + data: + name: name + accounts: + key: + maxEndDate: maxEndDate + minStartDate: minStartDate + lockingDate: lockingDate + name: name + benchmarkCode: benchmarkCode + benchmarkName: benchmarkName + meta: "" + properties: + data: + $ref: '#/components/schemas/VaultConfiguration' + meta: {} + required: + - data + type: object + Currency: + additionalProperties: false + example: + name: name + properties: + name: + description: Name of currency. + type: string + type: object + CurrencyRoot: + additionalProperties: false + example: + data: + key: + name: name + meta: "" + properties: + data: + additionalProperties: + $ref: '#/components/schemas/Currency' + type: object + meta: {} + required: + - data + type: object + DateParametersSummary: + additionalProperties: false + example: + enddate: enddate + startdate: startdate + properties: + startdate: + description: Start date in YYYYMMDD format. + type: string + enddate: + description: End date in YYYYMMDD format. + type: string + type: object + DateParametersSummaryRoot: + additionalProperties: false + example: + data: + enddate: enddate + startdate: startdate + meta: "" + properties: + data: + $ref: '#/components/schemas/DateParametersSummary' + meta: {} + required: + - data + type: object + DocumentDirectories: + additionalProperties: false example: + documents: + - documents + - documents directories: - directories - directories - accounts: - - accounts - - accounts properties: - accounts: - description: List of account and composite files. + documents: + description: List of documents items: type: string type: array @@ -31809,71 +38619,606 @@ components: type: string type: array type: object - AccountDirectoriesRoot: + DocumentDirectoriesRoot: + additionalProperties: false + example: + data: + documents: + - documents + - documents + directories: + - directories + - directories + meta: "" + properties: + data: + $ref: '#/components/schemas/DocumentDirectories' + meta: {} + required: + - data + type: object + FIABIdentifier: + additionalProperties: false + example: + id: id + properties: + id: + description: User's FactSet account path. + type: string + required: + - id + type: object + FIABDateParameters: + additionalProperties: false + description: The date parameters for FIAB calculations. + example: + enddate: enddate + startdate: startdate + properties: + startdate: + description: Calculation's start date. + type: string + enddate: + description: Calculation's end date. + type: string + required: + - enddate + - startdate + type: object + FIABCalculationParameters: + additionalProperties: false + example: + fiabdocument: fiabdocument + msl: msl + dates: + enddate: enddate + startdate: startdate + fisettingsdocument: fisettingsdocument + account: + id: id + properties: + fiabdocument: + description: "FiabDocument (optional) - FIAB document to use as a template.\ + \ Should\r\nbe a path to a FIAB document. Expects a GUI-style path (Client:/foo/bar)" + type: string + account: + $ref: '#/components/schemas/FIABIdentifier' + dates: + $ref: '#/components/schemas/FIABDateParameters' + msl: + description: Master FISecurity List. Analytics results will be written to + the selected MSL. Expects a GUI-style path (Client:/foo/bar) + type: string + fisettingsdocument: + description: "FISettingsDocument (optional) - The given @FIS document will\ + \ be used to\r\nconfigure analytics assumptions and settings. Expects\ + \ a GUI-style path (Client:/foo/bar)" + type: string + required: + - account + - dates + type: object + FIABCalculationStatusSummary: + additionalProperties: false + properties: + requesttime: + description: Request time of calculation. + format: date-time + type: string + lastpolltime: + description: Last poll time of calculation. + format: date-time + type: string + type: object + EventSummary: + additionalProperties: false + example: + submissiondatetime: 2000-01-23T04:56:07.000+00:00 + message: message + type: type + properties: + message: + description: Event's message + type: string + submissiondatetime: + description: Event's submission time + format: date-time + type: string + type: + description: Event's type + type: string + type: object + FIABCalculationStatus: + additionalProperties: false + example: + completiondatetime: 2000-01-23T04:56:07.000+00:00 + batchevents: + - submissiondatetime: 2000-01-23T04:56:07.000+00:00 + message: message + type: type + - submissiondatetime: 2000-01-23T04:56:07.000+00:00 + message: message + type: type + progress: 0 + id: id + status: Pending + startdatetime: 2000-01-23T04:56:07.000+00:00 + properties: + id: + description: Calculation's identifier + type: string + status: + description: Calculation's status + enum: + - Pending + - InProgress + - Done + - Paused + - Cancelled + - Error + type: string + startdatetime: + description: Start time + format: date-time + type: string + completiondatetime: + description: Completion time + format: date-time + type: string + progress: + description: Calculation's progress + format: int32 + type: integer + batchevents: + description: List of batch events + items: + $ref: '#/components/schemas/EventSummary' + type: array + type: object + FIReferencePrepay: + additionalProperties: false + example: + prepayName: prepayName + properties: + prepayName: + description: Reference Prepay Name + type: string + type: object + FIReferenceSecurity: + additionalProperties: false + example: + calcFromMethod: calcFromMethod + prepay: + prepayName: prepayName + securityName: securityName + calcFromValue: 0.8008281904610115 + securityType: securityType + settlement: settlement + properties: + securityType: + description: Reference Security Type + type: string + securityName: + description: Reference Security Name + type: string + calcFromMethod: + description: "Reference Calculation Method.\r\nMethods : 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,\r\nYield\ + \ To Worst Call, Discount Yield, Discount Margin, Implied Volatility,\ + \ Bullet Spread, Bullet Spread To Worst Call, Pricing Matrix" + type: string + calcFromValue: + description: Reference CalcFromValue + format: double + type: number + prepay: + $ref: '#/components/schemas/FIReferencePrepay' + settlement: + description: Reference Settlement Date + type: string + type: object + FILoss: + additionalProperties: false + example: + lossName: lossName + properties: + lossName: + description: Loss Name + type: string + type: object + FIPrepay: + additionalProperties: false + example: + prepayName: prepayName + properties: + prepayName: + description: Prepay Name + type: string + type: object + FISecurity: + additionalProperties: false + example: + callMethod: No Call + symbol: symbol + matrixMultiplier: 1.4658129805029452 + discountCurve: discountCurve + calcFromValue: 5.962133916683182 + faceType: Current + referenceSecurity: + calcFromMethod: calcFromMethod + prepay: + prepayName: prepayName + securityName: securityName + calcFromValue: 0.8008281904610115 + securityType: securityType + settlement: settlement + settlement: settlement + calcFromMethod: calcFromMethod + loss: + lossName: lossName + prepay: + prepayName: prepayName + face: 5.637376656633329 + matrixSpreadAdjustment: 6.027456183070403 + properties: + settlement: + description: Settlement date + type: string + callMethod: + description: Call Method + enum: + - No Call + - Intrinsic Value + - First Call + - First Par + type: string + referenceSecurity: + $ref: '#/components/schemas/FIReferenceSecurity' + loss: + $ref: '#/components/schemas/FILoss' + prepay: + $ref: '#/components/schemas/FIPrepay' + matrixSpreadAdjustment: + description: Matrix Spread Adjustment + format: double + type: number + matrixMultiplier: + description: Matrix Multiplier + format: double + type: number + calcFromMethod: + description: "Calculation Method.\r\nMethods : 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,\r\nYield To Worst Call, Discount\ + \ Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread\ + \ To Worst Call, Pricing Matrix" + type: string + calcFromValue: + description: Calculation from value + format: double + type: number + face: + default: 1 + description: Face + format: double + type: number + faceType: + default: Current + description: Face type + enum: + - Current + - Original + type: string + symbol: + description: Symbol + type: string + discountCurve: + description: Discount curve + type: string + required: + - calcFromValue + - symbol + type: object + FIJobSettings: + additionalProperties: false + example: + callMethod: No Call + calcFromMethod: calcFromMethod + asOfDate: asOfDate + partialDurationMonths: + - 2 + - 2 + settlement: settlement + properties: + asOfDate: + description: As of date + type: string + partialDurationMonths: + description: Partial duration months + items: + format: int32 + type: integer + type: array + callMethod: + description: Call Method + enum: + - No Call + - Intrinsic Value + - First Call + - First Par + type: string + settlement: + description: Settlement Date + type: string + calcFromMethod: + description: "Calculation Method.\r\nMethods : 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,\r\nYield To Worst Call, Discount\ + \ Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread\ + \ To Worst Call, Pricing Matrix" + type: string + required: + - asOfDate + type: object + FICalculationParameters: + additionalProperties: false + example: + jobSettings: + callMethod: No Call + calcFromMethod: calcFromMethod + asOfDate: asOfDate + partialDurationMonths: + - 2 + - 2 + settlement: settlement + calculations: + - calculations + - calculations + securities: + - callMethod: No Call + symbol: symbol + matrixMultiplier: 1.4658129805029452 + discountCurve: discountCurve + calcFromValue: 5.962133916683182 + faceType: Current + referenceSecurity: + calcFromMethod: calcFromMethod + prepay: + prepayName: prepayName + securityName: securityName + calcFromValue: 0.8008281904610115 + securityType: securityType + settlement: settlement + settlement: settlement + calcFromMethod: calcFromMethod + loss: + lossName: lossName + prepay: + prepayName: prepayName + face: 5.637376656633329 + matrixSpreadAdjustment: 6.027456183070403 + - callMethod: No Call + symbol: symbol + matrixMultiplier: 1.4658129805029452 + discountCurve: discountCurve + calcFromValue: 5.962133916683182 + faceType: Current + referenceSecurity: + calcFromMethod: calcFromMethod + prepay: + prepayName: prepayName + securityName: securityName + calcFromValue: 0.8008281904610115 + securityType: securityType + settlement: settlement + settlement: settlement + calcFromMethod: calcFromMethod + loss: + lossName: lossName + prepay: + prepayName: prepayName + face: 5.637376656633329 + matrixSpreadAdjustment: 6.027456183070403 + properties: + securities: + description: List of securities + items: + $ref: '#/components/schemas/FISecurity' + type: array + calculations: + description: List of calculations + items: + type: string + type: array + jobSettings: + $ref: '#/components/schemas/FIJobSettings' + required: + - calculations + - jobSettings + - securities + type: object + CalculationMeta: + additionalProperties: false + example: + contentorganization: SimplifiedRow + format: JsonStach + stachContentOrganization: SimplifiedRow + contenttype: Json + properties: + contentorganization: + default: SimplifiedRow + deprecated: true + enum: + - None + - Row + - Column + - SimplifiedRow + type: string + stachContentOrganization: + default: SimplifiedRow + enum: + - None + - Row + - Column + - SimplifiedRow + type: string + contenttype: + default: Json + deprecated: true + enum: + - Json + - Binary + type: string + format: + default: JsonStach + enum: + - JsonStach + - Table + - Tableau + - BinaryStach + - Bison + - Binary + - Pdf + - Pptx + - Feather + type: string + type: object + FICalculationParametersRoot: + additionalProperties: false example: data: - directories: - - directories - - directories - accounts: - - accounts - - accounts - meta: '{}' + jobSettings: + callMethod: No Call + calcFromMethod: calcFromMethod + asOfDate: asOfDate + partialDurationMonths: + - 2 + - 2 + settlement: settlement + calculations: + - calculations + - calculations + securities: + - callMethod: No Call + symbol: symbol + matrixMultiplier: 1.4658129805029452 + discountCurve: discountCurve + calcFromValue: 5.962133916683182 + faceType: Current + referenceSecurity: + calcFromMethod: calcFromMethod + prepay: + prepayName: prepayName + securityName: securityName + calcFromValue: 0.8008281904610115 + securityType: securityType + settlement: settlement + settlement: settlement + calcFromMethod: calcFromMethod + loss: + lossName: lossName + prepay: + prepayName: prepayName + face: 5.637376656633329 + matrixSpreadAdjustment: 6.027456183070403 + - callMethod: No Call + symbol: symbol + matrixMultiplier: 1.4658129805029452 + discountCurve: discountCurve + calcFromValue: 5.962133916683182 + faceType: Current + referenceSecurity: + calcFromMethod: calcFromMethod + prepay: + prepayName: prepayName + securityName: securityName + calcFromValue: 0.8008281904610115 + securityType: securityType + settlement: settlement + settlement: settlement + calcFromMethod: calcFromMethod + loss: + lossName: lossName + prepay: + prepayName: prepayName + face: 5.637376656633329 + matrixSpreadAdjustment: 6.027456183070403 + meta: + contentorganization: SimplifiedRow + format: JsonStach + stachContentOrganization: SimplifiedRow + contenttype: Json properties: data: - $ref: '#/components/schemas/AccountDirectories' + $ref: '#/components/schemas/FICalculationParameters' meta: - type: object - required: - - data + $ref: '#/components/schemas/CalculationMeta' type: object - ErrorSource: + PaDoc: + additionalProperties: false example: - pointer: pointer - parameter: parameter + id: id properties: - pointer: - type: string - parameter: + id: + description: PA document path type: string + required: + - id type: object - Error: + FPOAccount: + additionalProperties: false example: + paDocument: + id: id id: id - detail: detail - source: - pointer: pointer - parameter: parameter + overrides: + portfolio: portfolio + riskModelId: riskModelId + currency: currency + benchmark: benchmark properties: + paDocument: + $ref: '#/components/schemas/PaDoc' id: + description: Account path type: string - detail: - type: string - source: - $ref: '#/components/schemas/ErrorSource' + overrides: + $ref: '#/components/schemas/OptimizerAccountOverrides' + required: + - paDocument type: object - ClientErrorResponse: + FPOObjective: + additionalProperties: false + example: + terms: + key: Disable + active: active properties: - errors: - items: - $ref: '#/components/schemas/Error' - type: array + active: + type: string + terms: + additionalProperties: + enum: + - Disable + - Enable + type: string + type: object type: object - AFIOptimizerStrategyOverrides: + FPOOptimizerStrategyOverrides: + additionalProperties: false example: alpha: alpha - tax: tax transactionCost: transactionCost constraints: key: Disable - objective: objective + objective: + terms: + key: Disable + active: active properties: objective: - description: Objective - type: string - tax: - description: Tax - type: string + $ref: '#/components/schemas/FPOObjective' constraints: additionalProperties: enum: @@ -31889,187 +39234,30 @@ components: description: Transaction cost type: string type: object - AFIOptimizerStrategy: + FPOOptimizerStrategy: + additionalProperties: false example: overrides: alpha: alpha - tax: tax transactionCost: transactionCost constraints: key: Disable - objective: objective + objective: + terms: + key: Disable + active: active id: id properties: overrides: - $ref: '#/components/schemas/AFIOptimizerStrategyOverrides' + $ref: '#/components/schemas/FPOOptimizerStrategyOverrides' id: description: OptimizerStrategy document path type: string required: - id type: object - OptimizerAccountOverrides: - example: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - properties: - portfolio: - description: Portfolio - type: string - benchmark: - description: Benchmark - type: string - riskModelId: - description: Risk model - type: string - currency: - description: Currency - type: string - type: object - OptimizerAccount: - example: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - properties: - id: - description: Account path - type: string - overrides: - $ref: '#/components/schemas/OptimizerAccountOverrides' - type: object - Optimization: - example: - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - properties: - riskModelDate: - description: Risk model date - type: string - backtestDate: - description: Backtest date - type: string - cashflow: - description: Cash flow - type: string - type: object - OptimizerTradesList: - example: - includeCash: true - identifierType: Asset - properties: - identifierType: - description: Identifier type - enum: - - Asset - - Cusip - - Isin - - RiskModel - - SedolChk - - Sedol - - SymbologyCusip - - Ticker - - TickerRegion - - User - type: string - includeCash: - description: Include cash - type: boolean - type: object - OptimizerOptimalHoldings: - example: - includeCash: true - excludeZero: true - identifierType: Asset - properties: - identifierType: - description: Identifier type - enum: - - Asset - - Cusip - - Isin - - RiskModel - - SedolChk - - Sedol - - SymbologyCusip - - Ticker - - TickerRegion - - User - type: string - includeCash: - description: Include cash - type: boolean - excludeZero: - description: Exclude zero - type: boolean - type: object - OptimalPortfolio: - example: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - properties: - acctName: - description: Account path - type: string - excludeZero: - description: Exclude zero - type: boolean - archiveDate: - description: Archive date - type: string - ifAcctExists: - description: Archive action if account exists - enum: - - abort - - overwrite - - appendDate - type: string - ifOfdbDateExists: - description: Action if ofdb date exists - enum: - - abort - - replaceDate - - appendSecurities - type: string - type: object - OptimizerStats: - type: object - OptimizerOutputTypes: - example: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - properties: - trades: - $ref: '#/components/schemas/OptimizerTradesList' - optimal: - $ref: '#/components/schemas/OptimizerOptimalHoldings' - account: - $ref: '#/components/schemas/OptimalPortfolio' - stats: - type: object - type: object - AFIOptimizationParameters: + FPOOptimizationParameters: + additionalProperties: false example: optimization: cashflow: cashflow @@ -32093,13 +39281,17 @@ components: strategy: overrides: alpha: alpha - tax: tax transactionCost: transactionCost constraints: key: Disable - objective: objective + objective: + terms: + key: Disable + active: active id: id account: + paDocument: + id: id id: id overrides: portfolio: portfolio @@ -32107,10 +39299,10 @@ components: currency: currency benchmark: benchmark properties: - strategy: - $ref: '#/components/schemas/AFIOptimizerStrategy' account: - $ref: '#/components/schemas/OptimizerAccount' + $ref: '#/components/schemas/FPOAccount' + strategy: + $ref: '#/components/schemas/FPOOptimizerStrategy' optimization: $ref: '#/components/schemas/Optimization' outputTypes: @@ -32119,9 +39311,8 @@ components: - outputTypes - strategy type: object - OptimizerCalculationMeta: - type: object - AFIOptimizationParametersRoot: + FPOOptimizationParametersRoot: + additionalProperties: false example: data: optimization: @@ -32146,13 +39337,17 @@ components: strategy: overrides: alpha: alpha - tax: tax transactionCost: transactionCost constraints: key: Disable - objective: objective + objective: + terms: + key: Disable + active: active id: id account: + paDocument: + id: id id: id overrides: portfolio: portfolio @@ -32162,283 +39357,351 @@ components: meta: '{}' properties: data: - $ref: '#/components/schemas/AFIOptimizationParameters' + $ref: '#/components/schemas/FPOOptimizationParameters' meta: + additionalProperties: false type: object type: object - CalculationInfo: + Frequency: + additionalProperties: false + example: + name: name properties: - calculationId: - description: Calculation identifier + name: + description: Frequency name. type: string type: object - CalculationInfoRoot: + FrequencyRoot: + additionalProperties: false + example: + data: + key: + name: name + meta: "" properties: data: - $ref: '#/components/schemas/CalculationInfo' - meta: + additionalProperties: + $ref: '#/components/schemas/Frequency' type: object + meta: {} required: - data type: object - ObjectRoot: + Group: + additionalProperties: false example: - data: '{}' - meta: '{}' + name: name + category: category + directory: directory + properties: + name: + description: Group Name + type: string + directory: + description: Group Directory + type: string + category: + description: Group Category + type: string + type: object + GroupRoot: + additionalProperties: false + example: + data: + key: + name: name + category: category + directory: directory + meta: "" properties: data: + additionalProperties: + $ref: '#/components/schemas/Group' type: object - meta: - type: object + meta: {} required: - data type: object - AxiomaEquityOptimizerStrategyOverrides: + TemplateContentTypes: + additionalProperties: false example: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - objective: objective + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory properties: - objective: - description: Objective - type: string - tax: - description: Tax - type: string - constraints: - additionalProperties: - enum: - - Disable - - Enable + mandatory: + description: Template mandatory fields + items: type: string - description: List of constraints - type: object - alpha: - description: Alpha - type: string - transactionCost: - description: Transaction cost - type: string + type: array + optional: + description: Template optional fields + items: + type: string + type: array + locked: + description: Template locked fields + items: + type: string + type: array type: object - AxiomaEquityOptimizerStrategy: + LinkedPATemplateParameters: + additionalProperties: false example: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - objective: objective - id: id + parentComponentId: parentComponentId + description: description + directory: directory + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory properties: - overrides: - $ref: '#/components/schemas/AxiomaEquityOptimizerStrategyOverrides' - id: - description: OptimizerStrategy document path + directory: + description: The directory to create a linked PA template type: string + parentComponentId: + description: Parent component id + type: string + description: + description: Template description + type: string + content: + $ref: '#/components/schemas/TemplateContentTypes' required: - - id - type: object - AxiomaEquityOptimizationParameters: - example: - optimization: - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - objective: objective - id: id - account: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - properties: - strategy: - $ref: '#/components/schemas/AxiomaEquityOptimizerStrategy' - account: - $ref: '#/components/schemas/OptimizerAccount' - optimization: - $ref: '#/components/schemas/Optimization' - outputTypes: - $ref: '#/components/schemas/OptimizerOutputTypes' - required: - - outputTypes - - strategy + - directory + - parentComponentId type: object - AxiomaEquityOptimizationParametersRoot: + LinkedPATemplateParametersRoot: + additionalProperties: false example: data: - optimization: - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - objective: objective - id: id - account: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - meta: '{}' + parentComponentId: parentComponentId + description: description + directory: directory + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory + meta: "" properties: data: - $ref: '#/components/schemas/AxiomaEquityOptimizationParameters' - meta: - type: object + $ref: '#/components/schemas/LinkedPATemplateParameters' + meta: {} + required: + - data type: object - SPARIdentifier: - description: The account/benchmark parameter for SPAR calculation. + LinkedPATemplatePostSummary: + additionalProperties: false example: - prefix: prefix - returntype: returntype + parentComponentId: parentComponentId + name: name + description: description id: id properties: id: - description: User's FactSet account OR benchmark id. + description: Template id. type: string - returntype: - description: Benchmark return type. + description: + description: Template description. type: string - prefix: - description: Benchmark prefix. + name: + description: Template name. + type: string + parentComponentId: + description: Template parent tile. type: string - required: - - id type: object - SPARBenchmark: + LinkedPATemplatePostSummaryRoot: + additionalProperties: false example: - identifiers: - - prefix: prefix - returntype: returntype - id: id - - prefix: prefix - returntype: returntype + data: + parentComponentId: parentComponentId + name: name + description: description id: id + meta: "" + properties: + data: + $ref: '#/components/schemas/LinkedPATemplatePostSummary' + meta: {} + required: + - data + type: object + LinkedPATemplateSummary: + additionalProperties: false + example: + parentComponentId: parentComponentId name: name - id: id + description: description properties: - id: - description: Benchmark identifier + description: + description: Template description. type: string name: - description: Benchmark Name + description: Template name. + type: string + parentComponentId: + description: Template parent tile. type: string - identifiers: - description: List of SPAR identifiers - items: - $ref: '#/components/schemas/SPARIdentifier' - type: array type: object - SPARBenchmarkRoot: + LinkedPATemplateSummaryRoot: + additionalProperties: false example: data: - identifiers: - - prefix: prefix - returntype: returntype - id: id - - prefix: prefix - returntype: returntype - id: id - name: name - id: id - meta: '{}' + key: + parentComponentId: parentComponentId + name: name + description: description + meta: "" properties: data: - $ref: '#/components/schemas/SPARBenchmark' - meta: + additionalProperties: + $ref: '#/components/schemas/LinkedPATemplateSummary' type: object + meta: {} required: - data type: object - ConstraintAction: + LinkedPATemplateUpdateParameters: + additionalProperties: false example: - item2: Disable - item1: item1 + parentComponentId: parentComponentId + description: description + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory properties: - item1: + parentComponentId: + description: Parent component id type: string - item2: - enum: - - Disable - - Enable + description: + description: Template description type: string + content: + $ref: '#/components/schemas/TemplateContentTypes' type: object - BPMOptimizerStrategyAlphaOverride: + LinkedPATemplateUpdateParametersRoot: + additionalProperties: false example: - returnMultiplier: returnMultiplier - formula: formula - returnType: Excess + data: + parentComponentId: parentComponentId + description: description + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory + meta: "" properties: - formula: + data: + $ref: '#/components/schemas/LinkedPATemplateUpdateParameters' + meta: {} + required: + - data + type: object + LinkedPATemplate: + additionalProperties: false + example: + parentComponentId: parentComponentId + name: name + description: description + id: id + directory: directory + snapshot: true + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory + properties: + directory: + description: Template directory. type: string - returnType: - enum: - - Excess - - Total - - Active - - Residual - - Exceptional + snapshot: + description: snapshot. + type: boolean + content: + $ref: '#/components/schemas/TemplateContentTypes' + id: + description: Template id. type: string - returnMultiplier: + description: + description: Template description. + type: string + name: + description: Template name. + type: string + parentComponentId: + description: Template parent tile. type: string type: object - BPMOptimizerStrategyOverrides: + LinkedPATemplateRoot: + additionalProperties: false example: - alpha: - returnMultiplier: returnMultiplier - formula: formula - returnType: Excess + data: + parentComponentId: parentComponentId + name: name + description: description + id: id + directory: directory + snapshot: true + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory + meta: "" + properties: + data: + $ref: '#/components/schemas/LinkedPATemplate' + meta: {} + required: + - data + type: object + NPOOptimizerStrategyOverrides: + additionalProperties: false + example: + alpha: alpha tax: tax transactionCost: transactionCost constraints: @@ -32446,28 +39709,33 @@ components: item1: item1 - item2: Disable item1: item1 + objective: + key: "" properties: + objective: + additionalProperties: {} + description: Objective parameters + type: object constraints: description: List of constraints items: $ref: '#/components/schemas/ConstraintAction' type: array - alpha: - $ref: '#/components/schemas/BPMOptimizerStrategyAlphaOverride' tax: description: "Tax\r\nCan be set to \"\" for local" type: string transactionCost: description: "Transaction cost\r\nCan be set to \"\" for local" type: string + alpha: + description: Alpha + type: string type: object - BPMOptimizerStrategy: + NPOOptimizerStrategy: + additionalProperties: false example: overrides: - alpha: - returnMultiplier: returnMultiplier - formula: formula - returnType: Excess + alpha: alpha tax: tax transactionCost: transactionCost constraints: @@ -32475,45 +39743,22 @@ components: item1: item1 - item2: Disable item1: item1 + objective: + key: "" id: id properties: overrides: - $ref: '#/components/schemas/BPMOptimizerStrategyOverrides' + $ref: '#/components/schemas/NPOOptimizerStrategyOverrides' id: description: OptimizerStrategy document path type: string required: - id type: object - BPMOptimization: - example: - market: market - investAllCash: true - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - properties: - market: - description: Optimization market - type: string - investAllCash: - description: Optimization invest all cash - type: boolean - riskModelDate: - description: Risk model date - type: string - backtestDate: - description: Backtest date - type: string - cashflow: - description: Cash flow - type: string - type: object - BPMOptimizationParameters: + NPOOptimizationParameters: + additionalProperties: false example: optimization: - market: market - investAllCash: true cashflow: cashflow riskModelDate: riskModelDate backtestDate: backtestDate @@ -32534,10 +39779,7 @@ components: acctName: acctName strategy: overrides: - alpha: - returnMultiplier: returnMultiplier - formula: formula - returnType: Excess + alpha: alpha tax: tax transactionCost: transactionCost constraints: @@ -32545,6 +39787,8 @@ components: item1: item1 - item2: Disable item1: item1 + objective: + key: "" id: id account: id: id @@ -32555,23 +39799,22 @@ components: benchmark: benchmark properties: strategy: - $ref: '#/components/schemas/BPMOptimizerStrategy' - optimization: - $ref: '#/components/schemas/BPMOptimization' + $ref: '#/components/schemas/NPOOptimizerStrategy' account: $ref: '#/components/schemas/OptimizerAccount' + optimization: + $ref: '#/components/schemas/Optimization' outputTypes: $ref: '#/components/schemas/OptimizerOutputTypes' required: - outputTypes - strategy type: object - BPMOptimizationParametersRoot: + NPOOptimizationParametersRoot: + additionalProperties: false example: data: optimization: - market: market - investAllCash: true cashflow: cashflow riskModelDate: riskModelDate backtestDate: backtestDate @@ -32592,10 +39835,7 @@ components: acctName: acctName strategy: overrides: - alpha: - returnMultiplier: returnMultiplier - formula: formula - returnType: Excess + alpha: alpha tax: tax transactionCost: transactionCost constraints: @@ -32603,6 +39843,8 @@ components: item1: item1 - item2: Disable item1: item1 + objective: + key: "" id: id account: id: id @@ -32614,183 +39856,59 @@ components: meta: '{}' properties: data: - $ref: '#/components/schemas/BPMOptimizationParameters' - meta: - type: object - type: object - ColumnSummary: - description: Column settings (name, directory, category) - example: - name: name - category: category - directory: directory - properties: - name: - description: Column Name - type: string - directory: - description: Column Directory - type: string - category: - description: Column Category - type: string - type: object - ColumnSummaryRoot: - example: - data: - key: - name: name - category: category - directory: directory - meta: '{}' - properties: - data: - additionalProperties: - $ref: '#/components/schemas/ColumnSummary' - type: object - meta: - type: object - required: - - data - type: object - Column: - example: - defaultstatisticsids: - - defaultstatisticsids - - defaultstatisticsids - name: name - category: category - directory: directory - properties: - defaultstatisticsids: - description: Column statistic Id - items: - type: string - type: array - name: - description: Column Name - type: string - directory: - description: Column Directory - type: string - category: - description: Column Category - type: string - type: object - ColumnRoot: - example: - data: - defaultstatisticsids: - - defaultstatisticsids - - defaultstatisticsids - name: name - category: category - directory: directory - meta: '{}' - properties: - data: - $ref: '#/components/schemas/Column' - meta: - type: object - required: - - data - type: object - ColumnStatistic: - example: - name: name - properties: - name: - description: Column Statistic Name - type: string - type: object - ColumnStatisticRoot: - example: - data: - key: - name: name - meta: '{}' - properties: - data: - additionalProperties: - $ref: '#/components/schemas/ColumnStatistic' - type: object - meta: - type: object - required: - - data - type: object - ComponentSummary: - example: - name: name - category: category - properties: - name: - description: Component name. - type: string - category: - description: Component category. - type: string - type: object - ComponentSummaryRoot: - example: - data: - key: - name: name - category: category - meta: '{}' - properties: - data: - additionalProperties: - $ref: '#/components/schemas/ComponentSummary' - type: object + $ref: '#/components/schemas/NPOOptimizationParameters' meta: + additionalProperties: false type: object - required: - - data type: object - PAIdentifier: + PACalculationGroup: + additionalProperties: false example: id: id - holdingsmode: holdingsmode properties: id: - description: User's FactSet account path OR benchmark. - type: string - holdingsmode: - description: Holdings Mode can be B&H, TBR, OMS or EXT. + description: FactSet-defined or User-defined Group identifier. type: string - required: - - id type: object - PADateParameters: - description: The date parameters for PA calculation. + PACalculationColumn: + additionalProperties: false example: - enddate: enddate - startdate: startdate - frequency: frequency + id: id + statistics: + - statistics + - statistics properties: - startdate: - description: Calculation's start date. - type: string - enddate: - description: Calculation's end date. - type: string - frequency: - description: Calculation's frequency. + id: + description: FactSet-defined or User-defined Column identifier. type: string - required: - - enddate - - frequency + statistics: + description: Column Statistic identifier + items: + type: string + type: array type: object - PAComponent: + PACalculationParameters: + additionalProperties: false example: currencyisocode: currencyisocode - name: name + componentdetail: componentdetail + componentid: componentid + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + groups: + - id: id + - id: id dates: enddate: enddate startdate: startdate frequency: frequency - id: id accounts: - id: id holdingsmode: holdingsmode @@ -32801,586 +39919,658 @@ components: holdingsmode: holdingsmode - id: id holdingsmode: holdingsmode - category: category - snapshot: true properties: - id: - description: Component identifier. + componentid: + description: The PA Engine component identifier to analyze. type: string accounts: - description: List of accounts saved in the PA document. + description: List of accounts. items: $ref: '#/components/schemas/PAIdentifier' type: array benchmarks: - description: List of benchmarks saved in the PA document. + description: List of benchmarks. items: $ref: '#/components/schemas/PAIdentifier' type: array - currencyisocode: - type: string dates: $ref: '#/components/schemas/PADateParameters' - snapshot: - description: Is the component type snapshot or subperiod. - type: boolean - name: - description: Component name. + groups: + description: List of groupings for the PA calculation. This will take precedence + over the groupings saved in the PA document. + items: + $ref: '#/components/schemas/PACalculationGroup' + type: array + currencyisocode: + description: Currency ISO code for calculation. type: string - category: - description: Component category. + columns: + description: List of columns for the PA calculation. This will take precedence + over the columns saved in the PA document. + items: + $ref: '#/components/schemas/PACalculationColumn' + type: array + componentdetail: + description: Component detail type for the PA component. It can be GROUPS + or TOTALS or SECURITIES. + type: string + required: + - componentid + type: object + PACalculationParametersRoot: + additionalProperties: false + example: + data: + key: + currencyisocode: currencyisocode + componentdetail: componentdetail + componentid: componentid + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + groups: + - id: id + - id: id + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + meta: + contentorganization: SimplifiedRow + format: JsonStach + stachContentOrganization: SimplifiedRow + contenttype: Json + properties: + data: + additionalProperties: + $ref: '#/components/schemas/PACalculationParameters' + description: List of calculation parameters. + type: object + meta: + $ref: '#/components/schemas/CalculationMeta' + type: object + CalculationUnitStatus: + additionalProperties: false + example: + result: result + progress: progress + errors: + - id: id + detail: detail + source: + pointer: pointer + parameter: parameter + - id: id + detail: detail + source: + pointer: pointer + parameter: parameter + status: Queued + points: 0 + properties: + status: + description: The status of calculation unit. + enum: + - Queued + - Executing + - Success + - Failed + - Cancelled + type: string + errors: + description: The error in a calculation unit. + items: + $ref: '#/components/schemas/Error' + type: array + result: + description: The result URL of the calculation. + type: string + progress: + description: The progress of the calculation unit. + type: string + points: + description: The points for the calculation unit. + format: int32 + type: integer + type: object + CalculationStatus: + additionalProperties: false + example: + calculationid: calculationid + units: + key: + result: result + progress: progress + errors: + - id: id + detail: detail + source: + pointer: pointer + parameter: parameter + - id: id + detail: detail + source: + pointer: pointer + parameter: parameter + status: Queued + points: 0 + status: Queued + properties: + calculationid: + description: Calculation's identifier + type: string + status: + description: Calculation's status + enum: + - Queued + - Executing + - Completed + - Cancelled + type: string + units: + additionalProperties: + $ref: '#/components/schemas/CalculationUnitStatus' + description: Number of calculation units in batch. + type: object + type: object + CalculationUnitStatusMeta: + additionalProperties: false + example: + info: info + properties: + info: + description: The Info URL of the calculation. type: string type: object - PAComponentRoot: + CalculationStatusMeta: + additionalProperties: false + example: + units: + key: + info: info + properties: + units: + additionalProperties: + $ref: '#/components/schemas/CalculationUnitStatusMeta' + description: Meta of calculation units in batch. + type: object + type: object + CalculationStatusRoot: + additionalProperties: false example: data: - currencyisocode: currencyisocode - name: name - dates: - enddate: enddate - startdate: startdate - frequency: frequency - id: id - accounts: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - benchmarks: - - id: id - holdingsmode: holdingsmode - - id: id - holdingsmode: holdingsmode - category: category - snapshot: true - meta: '{}' + calculationid: calculationid + units: + key: + result: result + progress: progress + errors: + - id: id + detail: detail + source: + pointer: pointer + parameter: parameter + - id: id + detail: detail + source: + pointer: pointer + parameter: parameter + status: Queued + points: 0 + status: Queued + meta: + units: + key: + info: info properties: data: - $ref: '#/components/schemas/PAComponent' + $ref: '#/components/schemas/CalculationStatus' meta: - type: object + $ref: '#/components/schemas/CalculationStatusMeta' required: - data type: object - VaultIdentifier: - description: The account/benchmark parameter for Vault calculation. + PubIdentifier: + additionalProperties: false example: id: id + holdingsmode: holdingsmode properties: id: description: User's FactSet account path OR benchmark. type: string + holdingsmode: + description: Holdings Mode can be B&H, TBR, OMS or EXT. + type: string required: - id type: object - VaultDateParameters: - description: The date parameters for Vault calculation + PubDateParameters: + additionalProperties: false + description: The date parameters for Publisher calculation. example: enddate: enddate startdate: startdate - frequency: frequency properties: startdate: description: Calculation's start date. type: string enddate: - description: Calculation's end date. - type: string - frequency: - description: Calculation's frequency. + description: Calculation's end date or as of date. type: string required: - enddate - - frequency type: object - VaultComponent: + PubCalculationParameters: + additionalProperties: false example: - currencyisocode: currencyisocode - name: name + document: document dates: enddate: enddate startdate: startdate - frequency: frequency - id: id - category: category account: id: id - benchmark: - id: id - snapshot: true + holdingsmode: holdingsmode properties: - id: - description: Vault component identifier + document: + description: The Publisher Engine document to analyze. type: string account: - $ref: '#/components/schemas/VaultIdentifier' - benchmark: - $ref: '#/components/schemas/VaultIdentifier' - currencyisocode: - description: Currency iso code saved in the document - type: string + $ref: '#/components/schemas/PubIdentifier' dates: - $ref: '#/components/schemas/VaultDateParameters' - snapshot: - description: Snapshot - type: boolean - name: - description: Component name. - type: string - category: - description: Component category. - type: string - type: object - VaultComponentRoot: - example: - data: - currencyisocode: currencyisocode - name: name - dates: - enddate: enddate - startdate: startdate - frequency: frequency - id: id - category: category - account: - id: id - benchmark: - id: id - snapshot: true - meta: '{}' - properties: - data: - $ref: '#/components/schemas/VaultComponent' - meta: - type: object + $ref: '#/components/schemas/PubDateParameters' required: - - data + - account + - dates + - document type: object - VaultConfigurationSummary: - example: - name: name - properties: - name: - description: Configuration name. - type: string + PubCalculationMeta: + additionalProperties: false type: object - VaultConfigurationSummaryRoot: + PubCalculationParametersRoot: + additionalProperties: false example: data: key: - name: name + document: document + dates: + enddate: enddate + startdate: startdate + account: + id: id + holdingsmode: holdingsmode meta: '{}' properties: data: additionalProperties: - $ref: '#/components/schemas/VaultConfigurationSummary' + $ref: '#/components/schemas/PubCalculationParameters' + description: List of calculation parameters. type: object meta: + additionalProperties: false type: object - required: - - data type: object - ConfigurationAccount: - example: - maxEndDate: maxEndDate - minStartDate: minStartDate - lockingDate: lockingDate - name: name - benchmarkCode: benchmarkCode - benchmarkName: benchmarkName + QuantScreeningExpressionUniverse: + additionalProperties: false + allOf: + - $ref: '#/components/schemas/QuantUniverse' properties: - benchmarkCode: - description: Benchmark code. - type: string - benchmarkName: - description: Benchmark name. - type: string - maxEndDate: - description: Maximum end date. - type: string - minStartDate: - description: Minimum start date. + universeExpr: type: string - lockingDate: - description: Locking date. + universeType: + enum: + - Equity + - Debt type: string - name: - description: Account name. + securityExpr: type: string + required: + - universeExpr + - universeType type: object - VaultConfiguration: - example: - name: name - accounts: - key: - maxEndDate: maxEndDate - minStartDate: minStartDate - lockingDate: lockingDate - name: name - benchmarkCode: benchmarkCode - benchmarkName: benchmarkName + QuantIdentifierUniverse: + additionalProperties: false + allOf: + - $ref: '#/components/schemas/QuantUniverse' properties: - name: - description: Configuration name. + universeType: + enum: + - Equity + - Debt type: string - accounts: - additionalProperties: - $ref: '#/components/schemas/ConfigurationAccount' - type: object - type: object - VaultConfigurationRoot: - example: - data: - name: name - accounts: - key: - maxEndDate: maxEndDate - minStartDate: minStartDate - lockingDate: lockingDate - name: name - benchmarkCode: benchmarkCode - benchmarkName: benchmarkName - meta: '{}' - properties: - data: - $ref: '#/components/schemas/VaultConfiguration' - meta: - type: object + identifiers: + items: + type: string + type: array required: - - data + - identifiers + - universeType type: object - Currency: - example: - name: name + QuantUniverse: + additionalProperties: false properties: - name: - description: Name of currency. + source: + enum: + - ScreeningExpressionUniverse + - UniversalScreenUniverse + - IdentifierUniverse type: string - type: object - CurrencyRoot: - example: - data: - key: - name: name - meta: '{}' - properties: - data: - additionalProperties: - $ref: '#/components/schemas/Currency' - type: object - meta: - type: object required: - - data + - source type: object - DateParametersSummary: - example: - enddate: enddate - startdate: startdate + QuantUniversalScreenUniverse: + additionalProperties: false + allOf: + - $ref: '#/components/schemas/QuantUniverse' properties: - startdate: - description: Start date in YYYYMMDD format. - type: string - enddate: - description: End date in YYYYMMDD format. + screen: type: string - type: object - DateParametersSummaryRoot: - example: - data: - enddate: enddate - startdate: startdate - meta: '{}' - properties: - data: - $ref: '#/components/schemas/DateParametersSummary' - meta: - type: object required: - - data + - screen type: object - DocumentDirectories: - example: - documents: - - documents - - documents - directories: - - directories - - directories + QuantDateList: + additionalProperties: false + allOf: + - $ref: '#/components/schemas/QuantDate' properties: - documents: - description: List of documents - items: - type: string - type: array - directories: - description: List of directories. + dates: items: type: string type: array type: object - DocumentDirectoriesRoot: - example: - data: - documents: - - documents - - documents - directories: - - directories - - directories - meta: '{}' + QuantDate: + additionalProperties: false properties: - data: - $ref: '#/components/schemas/DocumentDirectories' - meta: - type: object + source: + enum: + - FdsDate + - DateList + type: string + frequency: + type: string + calendar: + type: string required: - - data + - calendar + - frequency + - source type: object - FIABIdentifier: - example: - id: id + QuantFdsDate: + additionalProperties: false + allOf: + - $ref: '#/components/schemas/QuantDate' properties: - id: - description: User's FactSet account path. + startDate: + type: string + endDate: type: string required: - - id + - endDate + - startDate type: object - FIABDateParameters: - description: The date parameters for FIAB calculations. - example: - enddate: enddate - startdate: startdate + QuantFqlExpression: + additionalProperties: false + allOf: + - $ref: '#/components/schemas/QuantFormula' properties: - startdate: - description: Calculation's start date. + expr: type: string - enddate: - description: Calculation's end date. + name: type: string required: - - enddate - - startdate + - expr + - name type: object - FIABCalculationParameters: - example: - fiabdocument: fiabdocument - msl: msl - dates: - enddate: enddate - startdate: startdate - fisettingsdocument: fisettingsdocument - account: - id: id + QuantUniversalScreenParameter: + additionalProperties: false + allOf: + - $ref: '#/components/schemas/QuantFormula' properties: - fiabdocument: - description: "FiabDocument (optional) - FIAB document to use as a template.\ - \ Should\r\nbe a path to a FIAB document. Expects a GUI-style path (Client:/foo/bar)" + referenceName: type: string - account: - $ref: '#/components/schemas/FIABIdentifier' - dates: - $ref: '#/components/schemas/FIABDateParameters' - msl: - description: Master FISecurity List. Analytics results will be written to - the selected MSL. Expects a GUI-style path (Client:/foo/bar) + name: type: string - fisettingsdocument: - description: "FISettingsDocument (optional) - The given @FIS document will\ - \ be used to\r\nconfigure analytics assumptions and settings. Expects\ - \ a GUI-style path (Client:/foo/bar)" + required: + - name + - referenceName + type: object + QuantAllUniversalScreenParameters: + additionalProperties: false + allOf: + - $ref: '#/components/schemas/QuantFormula' + type: object + QuantFormula: + additionalProperties: false + properties: + source: + enum: + - ScreeningExpression + - FqlExpression + - UniversalScreenParameter + - AllUniversalScreenParameters type: string required: - - account - - dates + - source type: object - FIABCalculationStatusSummary: + QuantScreeningExpression: + additionalProperties: false + allOf: + - $ref: '#/components/schemas/QuantFormula' properties: - requesttime: - description: Request time of calculation. - format: date-time + expr: type: string - lastpolltime: - description: Last poll time of calculation. - format: date-time + name: type: string + required: + - expr + - name type: object - EventSummary: - example: - submissiondatetime: 2000-01-23T04:56:07.000+00:00 - message: message - type: type + QuantScreeningExpressionUniverseObsolete: + additionalProperties: false properties: - message: - description: Event's message + universeExpr: type: string - submissiondatetime: - description: Event's submission time - format: date-time + universeType: + enum: + - Equity + - Debt type: string - type: - description: Event's type + securityExpr: + type: string + source: + enum: + - ScreeningExpressionUniverse + - UniversalScreenUniverse + - IdentifierUniverse type: string + required: + - universeExpr + - universeType type: object - FIABCalculationStatus: - example: - completiondatetime: 2000-01-23T04:56:07.000+00:00 - batchevents: - - submissiondatetime: 2000-01-23T04:56:07.000+00:00 - message: message - type: type - - submissiondatetime: 2000-01-23T04:56:07.000+00:00 - message: message - type: type - progress: 0 - id: id - status: Pending - startdatetime: 2000-01-23T04:56:07.000+00:00 + QuantUniversalScreenUniverseObsolete: + additionalProperties: false properties: - id: - description: Calculation's identifier + screen: type: string - status: - description: Calculation's status + source: enum: - - Pending - - InProgress - - Done - - Paused - - Cancelled - - Error - type: string - startdatetime: - description: Start time - format: date-time + - ScreeningExpressionUniverse + - UniversalScreenUniverse + - IdentifierUniverse type: string - completiondatetime: - description: Completion time - format: date-time + required: + - screen + type: object + QuantIdentifierUniverseObsolete: + additionalProperties: false + properties: + universeType: + enum: + - Equity + - Debt type: string - progress: - description: Calculation's progress - format: int32 - type: integer - batchevents: - description: List of batch events + identifiers: items: - $ref: '#/components/schemas/EventSummary' + type: string type: array + source: + enum: + - ScreeningExpressionUniverse + - UniversalScreenUniverse + - IdentifierUniverse + type: string + required: + - identifiers + - universeType type: object - FISecurity: - example: - calcFromMethod: calcFromMethod - symbol: symbol - face: 6.027456183070403 - discountCurve: discountCurve - calcFromValue: 0.8008281904610115 - faceType: Current - settlement: settlement + QuantFdsDateObsolete: + additionalProperties: false + properties: + startDate: + type: string + endDate: + type: string + frequency: + type: string + calendar: + type: string + required: + - calendar + - endDate + - frequency + - startDate + type: object + QuantDateListObsolete: + additionalProperties: false properties: - settlement: - description: Settlement date + dates: + items: + type: string + type: array + frequency: type: string - calcFromMethod: - description: Calculation from method + calendar: type: string - calcFromValue: - description: Calculation from value - format: double - type: number - face: - default: 1 - description: Face - format: double - type: number - faceType: - default: Current - description: Face type - enum: - - Current - - Original + required: + - calendar + - frequency + type: object + QuantScreeningExpressionObsolete: + additionalProperties: false + properties: + expr: type: string - symbol: - description: Symbol + name: type: string - discountCurve: - description: Discount curve + required: + - expr + - name + type: object + QuantFqlExpressionObsolete: + additionalProperties: false + properties: + expr: + type: string + name: type: string required: - - calcFromMethod - - calcFromValue - - symbol + - expr + - name type: object - FIJobSettings: - example: - asOfDate: asOfDate - partialDurationMonths: - - 1 - - 1 + QuantUniversalScreenParameterObsolete: + additionalProperties: false properties: - asOfDate: - description: As of date + referenceName: + type: string + name: type: string - partialDurationMonths: - description: Partial duration months - items: - format: int32 - type: integer - type: array required: - - asOfDate + - name + - referenceName type: object - FICalculationParameters: + QuantAllUniversalScreenParametersObsolete: + additionalProperties: false + type: object + OneOfQuantUniverse: + discriminator: + mapping: + UniversalScreenUniverse: '#/components/schemas/QuantUniversalScreenUniverse' + ScreeningExpressionUniverse: '#/components/schemas/QuantScreeningExpressionUniverse' + IdentifierUniverse: '#/components/schemas/QuantIdentifierUniverse' + propertyName: source + oneOf: + - $ref: '#/components/schemas/QuantUniversalScreenUniverse' + - $ref: '#/components/schemas/QuantScreeningExpressionUniverse' + - $ref: '#/components/schemas/QuantIdentifierUniverse' + OneOfQuantDates: + discriminator: + mapping: + FdsDate: '#/components/schemas/QuantFdsDate' + DateList: '#/components/schemas/QuantDateList' + propertyName: source + oneOf: + - $ref: '#/components/schemas/QuantFdsDate' + - $ref: '#/components/schemas/QuantDateList' + OneOfQuantFormulasArray: + discriminator: + mapping: + ScreeningExpression: '#/components/schemas/QuantScreeningExpression' + FqlExpression: '#/components/schemas/QuantFqlExpression' + UniversalScreenParameter: '#/components/schemas/QuantUniversalScreenParameter' + AllUniversalScreenParameters: '#/components/schemas/QuantAllUniversalScreenParameters' + propertyName: source + oneOf: + - $ref: '#/components/schemas/QuantScreeningExpression' + - $ref: '#/components/schemas/QuantFqlExpression' + - $ref: '#/components/schemas/QuantUniversalScreenParameter' + - $ref: '#/components/schemas/QuantAllUniversalScreenParameters' + OneOfQuantFormulas: + items: + $ref: '#/components/schemas/OneOfQuantFormulasArray' + type: array + QuantCalculationParameters: + additionalProperties: false example: - jobSettings: - asOfDate: asOfDate - partialDurationMonths: - - 1 - - 1 - calculations: - - calculations - - calculations - securities: - - calcFromMethod: calcFromMethod - symbol: symbol - face: 6.027456183070403 - discountCurve: discountCurve - calcFromValue: 0.8008281904610115 - faceType: Current - settlement: settlement - - calcFromMethod: calcFromMethod - symbol: symbol - face: 6.027456183070403 - discountCurve: discountCurve - calcFromValue: 0.8008281904610115 - faceType: Current - settlement: settlement + formulas: + - null + - null properties: - securities: - description: List of securities - items: - $ref: '#/components/schemas/FISecurity' - type: array - calculations: - description: List of calculations + universe: + $ref: '#/components/schemas/OneOfQuantUniverse' + dates: + $ref: '#/components/schemas/OneOfQuantDates' + formulas: items: - type: string + $ref: '#/components/schemas/OneOfQuantFormulasArray' type: array - jobSettings: - $ref: '#/components/schemas/FIJobSettings' - required: - - calculations - - jobSettings - - securities type: object - CalculationMeta: + QuantCalculationMeta: + additionalProperties: false example: contentorganization: SimplifiedRow + allowArrayData: true format: JsonStach stachContentOrganization: SimplifiedRow contenttype: Json properties: + allowArrayData: + type: boolean contentorganization: default: SimplifiedRow deprecated: true @@ -33419,461 +40609,131 @@ components: - Feather type: string type: object - FICalculationParametersRoot: + QuantCalculationParametersRoot: + additionalProperties: false example: data: - jobSettings: - asOfDate: asOfDate - partialDurationMonths: - - 1 - - 1 - calculations: - - calculations - - calculations - securities: - - calcFromMethod: calcFromMethod - symbol: symbol - face: 6.027456183070403 - discountCurve: discountCurve - calcFromValue: 0.8008281904610115 - faceType: Current - settlement: settlement - - calcFromMethod: calcFromMethod - symbol: symbol - face: 6.027456183070403 - discountCurve: discountCurve - calcFromValue: 0.8008281904610115 - faceType: Current - settlement: settlement + key: + formulas: + - null + - null meta: contentorganization: SimplifiedRow + allowArrayData: true format: JsonStach stachContentOrganization: SimplifiedRow contenttype: Json properties: data: - $ref: '#/components/schemas/FICalculationParameters' - meta: - $ref: '#/components/schemas/CalculationMeta' - type: object - PaDoc: - example: - id: id - properties: - id: - description: PA document path - type: string - required: - - id - type: object - FPOAccount: - example: - paDocument: - id: id - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - properties: - paDocument: - $ref: '#/components/schemas/PaDoc' - id: - description: Account path - type: string - overrides: - $ref: '#/components/schemas/OptimizerAccountOverrides' - required: - - paDocument - type: object - OptimizerStrategyOverrides: - example: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - properties: - tax: - description: Tax - type: string - constraints: - additionalProperties: - enum: - - Disable - - Enable - type: string - description: List of constraints - type: object - alpha: - description: Alpha - type: string - transactionCost: - description: Transaction cost - type: string - type: object - OptimizerStrategy: - example: - id: id - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - properties: - id: - description: OptimizerStrategy document path - type: string - overrides: - $ref: '#/components/schemas/OptimizerStrategyOverrides' - required: - - id - type: object - FPOOptimizationParameters: - example: - optimization: - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - id: id - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - account: - paDocument: - id: id - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - properties: - account: - $ref: '#/components/schemas/FPOAccount' - strategy: - $ref: '#/components/schemas/OptimizerStrategy' - optimization: - $ref: '#/components/schemas/Optimization' - outputTypes: - $ref: '#/components/schemas/OptimizerOutputTypes' - required: - - outputTypes - - strategy - type: object - FPOOptimizationParametersRoot: - example: - data: - optimization: - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - id: id - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - key: Disable - account: - paDocument: - id: id - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - meta: '{}' - properties: - data: - $ref: '#/components/schemas/FPOOptimizationParameters' - meta: - type: object - type: object - Frequency: - example: - name: name - properties: - name: - description: Frequency name. - type: string - type: object - FrequencyRoot: - example: - data: - key: - name: name - meta: '{}' - properties: - data: - additionalProperties: - $ref: '#/components/schemas/Frequency' - type: object - meta: - type: object - required: - - data - type: object - Group: - example: - name: name - category: category - directory: directory - properties: - name: - description: Group Name - type: string - directory: - description: Group Directory - type: string - category: - description: Group Category - type: string - type: object - GroupRoot: - example: - data: - key: - name: name - category: category - directory: directory - meta: '{}' - properties: - data: - additionalProperties: - $ref: '#/components/schemas/Group' - type: object - meta: - type: object - required: - - data - type: object - NPOOptimizerStrategyOverrides: - example: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - - item2: Disable - item1: item1 - - item2: Disable - item1: item1 - objective: - key: '{}' - properties: - objective: - additionalProperties: - type: object - description: Objective parameters - type: object - constraints: - description: List of constraints - items: - $ref: '#/components/schemas/ConstraintAction' - type: array - tax: - description: "Tax\r\nCan be set to \"\" for local" - type: string - transactionCost: - description: "Transaction cost\r\nCan be set to \"\" for local" - type: string - alpha: - description: Alpha - type: string - type: object - NPOOptimizerStrategy: - example: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - - item2: Disable - item1: item1 - - item2: Disable - item1: item1 - objective: - key: '{}' - id: id - properties: - overrides: - $ref: '#/components/schemas/NPOOptimizerStrategyOverrides' - id: - description: OptimizerStrategy document path - type: string - required: - - id - type: object - NPOOptimizationParameters: - example: - optimization: - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - - item2: Disable - item1: item1 - - item2: Disable - item1: item1 - objective: - key: '{}' - id: id - account: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - properties: - strategy: - $ref: '#/components/schemas/NPOOptimizerStrategy' - account: - $ref: '#/components/schemas/OptimizerAccount' - optimization: - $ref: '#/components/schemas/Optimization' - outputTypes: - $ref: '#/components/schemas/OptimizerOutputTypes' - required: - - outputTypes - - strategy - type: object - NPOOptimizationParametersRoot: - example: - data: - optimization: - cashflow: cashflow - riskModelDate: riskModelDate - backtestDate: backtestDate - outputTypes: - optimal: - includeCash: true - excludeZero: true - identifierType: Asset - stats: '{}' - trades: - includeCash: true - identifierType: Asset - account: - ifOfdbDateExists: abort - excludeZero: true - ifAcctExists: abort - archiveDate: archiveDate - acctName: acctName - strategy: - overrides: - alpha: alpha - tax: tax - transactionCost: transactionCost - constraints: - - item2: Disable - item1: item1 - - item2: Disable - item1: item1 - objective: - key: '{}' - id: id - account: - id: id - overrides: - portfolio: portfolio - riskModelId: riskModelId - currency: currency - benchmark: benchmark - meta: '{}' - properties: - data: - $ref: '#/components/schemas/NPOOptimizationParameters' - meta: + additionalProperties: + $ref: '#/components/schemas/QuantCalculationParameters' + description: List of calculation parameters. type: object + meta: + $ref: '#/components/schemas/QuantCalculationMeta' type: object - PACalculationGroup: + SPARDateParameters: + additionalProperties: false + description: The date parameters for SPAR calculation. example: - id: id + enddate: enddate + startdate: startdate + frequency: frequency properties: - id: - description: FactSet-defined or User-defined Group identifier. + startdate: + description: Calculation's start date. type: string + enddate: + description: Calculation's end date. + type: string + frequency: + description: Calculation's frequency. + type: string + required: + - enddate + - frequency + - startdate type: object - PACalculationColumn: + SPARCalculationParameters: + additionalProperties: false example: - id: id - statistics: - - statistics - - statistics + currencyisocode: currencyisocode + componentid: componentid + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - prefix: prefix + returntype: returntype + id: id + - prefix: prefix + returntype: returntype + id: id + benchmark: + prefix: prefix + returntype: returntype + id: id properties: - id: - description: FactSet-defined or User-defined Column identifier. + componentid: + description: The SPAR Engine component identifier to analyze. type: string - statistics: - description: Column Statistic identifier + accounts: + description: List of accounts for SPAR calculation. items: - type: string + $ref: '#/components/schemas/SPARIdentifier' type: array + benchmark: + $ref: '#/components/schemas/SPARIdentifier' + dates: + $ref: '#/components/schemas/SPARDateParameters' + currencyisocode: + description: Currency ISO code for calculation. + type: string + required: + - componentid type: object - PACalculationParameters: + SPARCalculationParametersRoot: + additionalProperties: false + example: + data: + key: + currencyisocode: currencyisocode + componentid: componentid + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - prefix: prefix + returntype: returntype + id: id + - prefix: prefix + returntype: returntype + id: id + benchmark: + prefix: prefix + returntype: returntype + id: id + meta: + contentorganization: SimplifiedRow + format: JsonStach + stachContentOrganization: SimplifiedRow + contenttype: Json + properties: + data: + additionalProperties: + $ref: '#/components/schemas/SPARCalculationParameters' + description: List of calculation parameters. + type: object + meta: + $ref: '#/components/schemas/CalculationMeta' + type: object + PAComponentData: + additionalProperties: false example: currencyisocode: currencyisocode componentdetail: componentdetail - componentid: componentid columns: - id: id statistics: @@ -33901,9 +40761,6 @@ components: - id: id holdingsmode: holdingsmode properties: - componentid: - description: The PA Engine component identifier to analyze. - type: string accounts: description: List of accounts. items: @@ -33914,37 +40771,87 @@ components: items: $ref: '#/components/schemas/PAIdentifier' type: array - dates: - $ref: '#/components/schemas/PADateParameters' groups: description: List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document. items: $ref: '#/components/schemas/PACalculationGroup' type: array - currencyisocode: - description: Currency ISO code for calculation. - type: string columns: description: List of columns for the PA calculation. This will take precedence over the columns saved in the PA document. items: $ref: '#/components/schemas/PACalculationColumn' type: array + dates: + $ref: '#/components/schemas/PADateParameters' + currencyisocode: + description: Currency ISO code for calculation. + type: string componentdetail: - description: Component detail type for the PA component. It can be GROUPS - or TOTALS. + description: PA Storage type. It can be GROUPS or TOTALS or SECURITIES. + type: string + type: object + TemplatedPAComponentParameters: + additionalProperties: false + example: + parentTemplateId: parentTemplateId + description: description + componentData: + currencyisocode: currencyisocode + componentdetail: componentdetail + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + groups: + - id: id + - id: id + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + directory: directory + properties: + directory: + description: Directory to create templated components type: string + parentTemplateId: + description: Parent template id + type: string + description: + description: Component description. + type: string + componentData: + $ref: '#/components/schemas/PAComponentData' required: - - componentid + - directory + - parentTemplateId type: object - PACalculationParametersRoot: + TemplatedPAComponentParametersRoot: + additionalProperties: false example: data: - key: + parentTemplateId: parentTemplateId + description: description + componentData: currencyisocode: currencyisocode componentdetail: componentdetail - componentid: componentid columns: - id: id statistics: @@ -33971,625 +40878,924 @@ components: holdingsmode: holdingsmode - id: id holdingsmode: holdingsmode - meta: - contentorganization: SimplifiedRow - format: JsonStach - stachContentOrganization: SimplifiedRow - contenttype: Json + directory: directory + meta: "" properties: data: - additionalProperties: - $ref: '#/components/schemas/PACalculationParameters' - description: List of calculation parameters. - type: object - meta: - $ref: '#/components/schemas/CalculationMeta' + $ref: '#/components/schemas/TemplatedPAComponentParameters' + meta: {} + required: + - data type: object - CalculationUnitStatus: + TemplatedPAComponentPostSummary: + additionalProperties: false example: - result: result - progress: progress - errors: - - id: id - detail: detail - source: - pointer: pointer - parameter: parameter - - id: id - detail: detail - source: - pointer: pointer - parameter: parameter - status: Queued + parentTemplateId: parentTemplateId + name: name + description: description + id: id + type: type properties: - status: - description: The status of calculation unit. - enum: - - Queued - - Executing - - Success - - Failed - - Cancelled + id: type: string - errors: - description: The error in a calculation unit. - items: - $ref: '#/components/schemas/Error' - type: array - result: - description: The result URL of the calculation. + description: type: string - progress: - description: The progress of the calculation unit. + name: + type: string + parentTemplateId: + type: string + type: type: string type: object - CalculationStatus: + TemplatedPAComponentPostSummaryRoot: + additionalProperties: false example: - calculationid: calculationid - units: - key: - result: result - progress: progress - errors: - - id: id - detail: detail - source: - pointer: pointer - parameter: parameter - - id: id - detail: detail - source: - pointer: pointer - parameter: parameter - status: Queued - status: Queued + data: + parentTemplateId: parentTemplateId + name: name + description: description + id: id + type: type + meta: "" properties: - calculationid: - description: Calculation's identifier - type: string - status: - description: Calculation's status - enum: - - Queued - - Executing - - Completed - - Cancelled - type: string - units: - additionalProperties: - $ref: '#/components/schemas/CalculationUnitStatus' - description: Number of calculation units in batch. - type: object + data: + $ref: '#/components/schemas/TemplatedPAComponentPostSummary' + meta: {} + required: + - data type: object - CalculationUnitStatusMeta: + TemplatedPAComponentSummary: + additionalProperties: false example: - info: info + parentTemplateId: parentTemplateId + name: name + description: description + type: type properties: - info: - description: The Info URL of the calculation. + description: + type: string + name: + type: string + parentTemplateId: + type: string + type: type: string type: object - CalculationStatusMeta: + TemplatedPAComponentSummaryRoot: + additionalProperties: false example: - units: + data: key: - info: info + parentTemplateId: parentTemplateId + name: name + description: description + type: type + meta: "" properties: - units: + data: additionalProperties: - $ref: '#/components/schemas/CalculationUnitStatusMeta' - description: Meta of calculation units in batch. + $ref: '#/components/schemas/TemplatedPAComponentSummary' type: object + meta: {} + required: + - data type: object - CalculationStatusRoot: + TemplatedPAComponentUpdateParameters: + additionalProperties: false + example: + parentTemplateId: parentTemplateId + description: description + componentData: + currencyisocode: currencyisocode + componentdetail: componentdetail + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + groups: + - id: id + - id: id + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + properties: + parentTemplateId: + description: Parent template id + type: string + description: + description: Component description. + type: string + componentData: + $ref: '#/components/schemas/PAComponentData' + type: object + TemplatedPAComponentUpdateParametersRoot: + additionalProperties: false example: data: - calculationid: calculationid - units: - key: - result: result - progress: progress - errors: - - id: id - detail: detail - source: - pointer: pointer - parameter: parameter - - id: id - detail: detail - source: - pointer: pointer - parameter: parameter - status: Queued - status: Queued - meta: - units: - key: - info: info + parentTemplateId: parentTemplateId + description: description + componentData: + currencyisocode: currencyisocode + componentdetail: componentdetail + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + groups: + - id: id + - id: id + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + meta: "" properties: data: - $ref: '#/components/schemas/CalculationStatus' - meta: - $ref: '#/components/schemas/CalculationStatusMeta' + $ref: '#/components/schemas/TemplatedPAComponentUpdateParameters' + meta: {} required: - data type: object - PubIdentifier: + TemplatedPAComponent: + additionalProperties: false example: + parentTemplateId: parentTemplateId + name: name + componentData: + currencyisocode: currencyisocode + componentdetail: componentdetail + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + groups: + - id: id + - id: id + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + description: description id: id - holdingsmode: holdingsmode + type: type + directory: directory + snapshot: true properties: id: - description: User's FactSet account path OR benchmark. type: string - holdingsmode: - description: Holdings Mode can be B&H, TBR, OMS or EXT. + directory: + type: string + snapshot: + type: boolean + componentData: + $ref: '#/components/schemas/PAComponentData' + description: + type: string + name: + type: string + parentTemplateId: + type: string + type: type: string - required: - - id type: object - PubDateParameters: - description: The date parameters for Publisher calculation. + TemplatedPAComponentRoot: + additionalProperties: false example: - enddate: enddate - startdate: startdate + data: + parentTemplateId: parentTemplateId + name: name + componentData: + currencyisocode: currencyisocode + componentdetail: componentdetail + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + groups: + - id: id + - id: id + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + description: description + id: id + type: type + directory: directory + snapshot: true + meta: "" properties: - startdate: - description: Calculation's start date. - type: string - enddate: - description: Calculation's end date or as of date. - type: string + data: + $ref: '#/components/schemas/TemplatedPAComponent' + meta: {} required: - - enddate + - data type: object - PubCalculationParameters: + UnlinkedPATemplateParameters: + additionalProperties: false example: - document: document + templateTypeId: templateTypeId + currencyisocode: currencyisocode + componentdetail: componentdetail + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + description: description + groups: + - id: id + - id: id dates: enddate: enddate startdate: startdate - account: - id: id + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id holdingsmode: holdingsmode + directory: directory + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory properties: - document: - description: The Publisher Engine document to analyze. + directory: + description: The directory to create an unlinked PA template type: string - account: - $ref: '#/components/schemas/PubIdentifier' + templateTypeId: + description: Template type id + type: string + description: + description: Template description + type: string + accounts: + description: List of accounts + items: + $ref: '#/components/schemas/PAIdentifier' + type: array + benchmarks: + description: List of benchmarks + items: + $ref: '#/components/schemas/PAIdentifier' + type: array + columns: + description: List of columns for the PA calculation + items: + $ref: '#/components/schemas/PACalculationColumn' + type: array dates: - $ref: '#/components/schemas/PubDateParameters' - required: - - account - - dates - - document - type: object - PubCalculationMeta: - type: object - PubCalculationParametersRoot: - example: - data: - key: - document: document - dates: - enddate: enddate - startdate: startdate - account: - id: id - holdingsmode: holdingsmode - meta: '{}' + $ref: '#/components/schemas/PADateParameters' + groups: + description: List of groupings for the PA calculation + items: + $ref: '#/components/schemas/PACalculationGroup' + type: array + currencyisocode: + description: Currency ISO code for calculation. + type: string + componentdetail: + description: PA storage type. It can be GROUPS or TOTALS or SECURITIES. + type: string + content: + $ref: '#/components/schemas/TemplateContentTypes' + required: + - directory + - templateTypeId + type: object + UnlinkedPATemplateParametersRoot: + additionalProperties: false + example: + data: + templateTypeId: templateTypeId + currencyisocode: currencyisocode + componentdetail: componentdetail + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + description: description + groups: + - id: id + - id: id + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + directory: directory + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory + meta: "" properties: data: - additionalProperties: - $ref: '#/components/schemas/PubCalculationParameters' - description: List of calculation parameters. - type: object - meta: - type: object + $ref: '#/components/schemas/UnlinkedPATemplateParameters' + meta: {} + required: + - data type: object - QuantScreeningExpressionUniverse: + UnlinkedPATemplatePostSummary: + additionalProperties: false example: - universeExpr: universeExpr - securityExpr: securityExpr - universeType: Equity + name: name + description: description + id: id + category: category properties: - universeExpr: + id: + description: Template id. type: string - universeType: - enum: - - Equity - - Debt + description: + description: Template description. type: string - securityExpr: + name: + description: Template name. type: string - required: - - universeExpr - - universeType - type: object - QuantUniversalScreenUniverse: - example: - screen: screen - properties: - screen: + category: + description: Unlinked template category type: string - required: - - screen type: object - QuantIdentifierUniverse: + UnlinkedPATemplatePostSummaryRoot: + additionalProperties: false example: - identifiers: - - identifiers - - identifiers - universeType: Equity + data: + name: name + description: description + id: id + category: category + meta: "" properties: - universeType: - enum: - - Equity - - Debt - type: string - identifiers: - items: - type: string - type: array + data: + $ref: '#/components/schemas/UnlinkedPATemplatePostSummary' + meta: {} required: - - identifiers - - universeType + - data type: object - QuantFdsDate: + UnlinkedPATemplateSummary: + additionalProperties: false example: - calendar: calendar - endDate: endDate - startDate: startDate - frequency: frequency + name: name + description: description + category: category properties: - startDate: + description: + description: Template description. type: string - endDate: - type: string - frequency: + name: + description: Template name. type: string - calendar: + category: + description: Unlinked template category type: string + type: object + UnlinkedPATemplateSummaryRoot: + additionalProperties: false + example: + data: + key: + name: name + description: description + category: category + meta: "" + properties: + data: + additionalProperties: + $ref: '#/components/schemas/UnlinkedPATemplateSummary' + type: object + meta: {} required: - - calendar - - endDate - - frequency - - startDate + - data type: object - QuantDateList: + UnlinkedPATemplateUpdateParameters: + additionalProperties: false example: - calendar: calendar + currencyisocode: currencyisocode + componentdetail: componentdetail + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + description: description + groups: + - id: id + - id: id dates: - - dates - - dates - frequency: frequency + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory properties: + description: + description: Template description + type: string + accounts: + description: List of accounts + items: + $ref: '#/components/schemas/PAIdentifier' + type: array + benchmarks: + description: List of benchmarks + items: + $ref: '#/components/schemas/PAIdentifier' + type: array + columns: + description: List of columns for the PA calculation + items: + $ref: '#/components/schemas/PACalculationColumn' + type: array dates: + $ref: '#/components/schemas/PADateParameters' + groups: + description: List of groupings for the PA calculation items: - type: string + $ref: '#/components/schemas/PACalculationGroup' type: array - frequency: + currencyisocode: + description: Currency ISO code for calculation. type: string - calendar: + componentdetail: + description: PA storage type. It can be GROUPS or TOTALS or SECURITIES. type: string - required: - - calendar - - frequency + content: + $ref: '#/components/schemas/TemplateContentTypes' type: object - QuantScreeningExpression: + UnlinkedPATemplateUpdateParametersRoot: + additionalProperties: false example: - name: name - expr: expr + data: + currencyisocode: currencyisocode + componentdetail: componentdetail + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + description: description + groups: + - id: id + - id: id + dates: + enddate: enddate + startdate: startdate + frequency: frequency + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory + meta: "" properties: - expr: - type: string - name: - type: string + data: + $ref: '#/components/schemas/UnlinkedPATemplateUpdateParameters' + meta: {} required: - - expr - - name + - data type: object - QuantFqlExpression: + UnlinkedPATemplate: + additionalProperties: false example: + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + groups: + - id: id + - id: id + description: description + dates: + enddate: enddate + startdate: startdate + frequency: frequency + directory: directory + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory + templateTypeId: templateTypeId + currencyisocode: currencyisocode + componentdetail: componentdetail name: name - expr: expr + id: id + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + category: category + snapshot: true properties: - expr: - type: string - name: + id: + description: Template id. type: string - required: - - expr - - name - type: object - QuantUniversalScreenParameter: - example: - name: name - referenceName: referenceName - properties: - referenceName: + directory: + description: Template directory. type: string - name: + templateTypeId: + description: Template type id type: string - required: - - name - - referenceName - type: object - QuantAllUniversalScreenParameters: - type: object - QuantCalculationParameters: - example: - fdsDate: - calendar: calendar - endDate: endDate - startDate: startDate - frequency: frequency - identifierUniverse: - identifiers: - - identifiers - - identifiers - universeType: Equity - universalScreenParameter: - - name: name - referenceName: referenceName - - name: name - referenceName: referenceName - screeningExpression: - - name: name - expr: expr - - name: name - expr: expr - allUniversalScreenParameters: - - null - - null - dateList: - calendar: calendar - dates: - - dates - - dates - frequency: frequency - screeningExpressionUniverse: - universeExpr: universeExpr - securityExpr: securityExpr - universeType: Equity - universalScreenUniverse: - screen: screen - fqlExpression: - - name: name - expr: expr - - name: name - expr: expr - properties: - screeningExpressionUniverse: - $ref: '#/components/schemas/QuantScreeningExpressionUniverse' - universalScreenUniverse: - $ref: '#/components/schemas/QuantUniversalScreenUniverse' - identifierUniverse: - $ref: '#/components/schemas/QuantIdentifierUniverse' - fdsDate: - $ref: '#/components/schemas/QuantFdsDate' - dateList: - $ref: '#/components/schemas/QuantDateList' - screeningExpression: + snapshot: + description: snapshot. + type: boolean + accounts: + description: List of accounts items: - $ref: '#/components/schemas/QuantScreeningExpression' + $ref: '#/components/schemas/PAIdentifier' type: array - fqlExpression: + benchmarks: + description: List of benchmarks items: - $ref: '#/components/schemas/QuantFqlExpression' + $ref: '#/components/schemas/PAIdentifier' type: array - universalScreenParameter: + columns: + description: List of columns for the PA calculation items: - $ref: '#/components/schemas/QuantUniversalScreenParameter' + $ref: '#/components/schemas/PACalculationColumn' type: array - allUniversalScreenParameters: + dates: + $ref: '#/components/schemas/PADateParameters' + groups: + description: List of groupings for the PA calculation items: - $ref: '#/components/schemas/QuantAllUniversalScreenParameters' + $ref: '#/components/schemas/PACalculationGroup' type: array + currencyisocode: + description: Currency ISO code for calculation. + type: string + componentdetail: + description: PA storage type. It can be GROUPS or TOTALS or SECURITIES. + type: string + content: + $ref: '#/components/schemas/TemplateContentTypes' + description: + description: Template description. + type: string + name: + description: Template name. + type: string + category: + description: Unlinked template category + type: string type: object - QuantCalculationMeta: + UnlinkedPATemplateRoot: + additionalProperties: false example: - contentorganization: SimplifiedRow - allowArrayData: true - format: JsonStach - stachContentOrganization: SimplifiedRow - contenttype: Json + data: + columns: + - id: id + statistics: + - statistics + - statistics + - id: id + statistics: + - statistics + - statistics + groups: + - id: id + - id: id + description: description + dates: + enddate: enddate + startdate: startdate + frequency: frequency + directory: directory + content: + optional: + - optional + - optional + locked: + - locked + - locked + mandatory: + - mandatory + - mandatory + templateTypeId: templateTypeId + currencyisocode: currencyisocode + componentdetail: componentdetail + name: name + id: id + accounts: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + benchmarks: + - id: id + holdingsmode: holdingsmode + - id: id + holdingsmode: holdingsmode + category: category + snapshot: true + meta: "" properties: - allowArrayData: - type: boolean - contentorganization: - default: SimplifiedRow - deprecated: true - enum: - - None - - Row - - Column - - SimplifiedRow - type: string - stachContentOrganization: - default: SimplifiedRow - enum: - - None - - Row - - Column - - SimplifiedRow - type: string - contenttype: - default: Json - deprecated: true - enum: - - Json - - Binary + data: + $ref: '#/components/schemas/UnlinkedPATemplate' + meta: {} + required: + - data + type: object + UnlinkedPATemplateCategoryAndType: + additionalProperties: false + example: + name: name + category: category + properties: + category: + description: Unlinked template category type: string - format: - default: JsonStach - enum: - - JsonStach - - Table - - Tableau - - BinaryStach - - Bison - - Binary - - Pdf - - Pptx - - Feather + name: + description: Unlinked template type type: string type: object - QuantCalculationParametersRoot: + UnlinkedPATemplateCategoryAndTypeRoot: + additionalProperties: false example: data: key: - fdsDate: - calendar: calendar - endDate: endDate - startDate: startDate - frequency: frequency - identifierUniverse: - identifiers: - - identifiers - - identifiers - universeType: Equity - universalScreenParameter: - - name: name - referenceName: referenceName - - name: name - referenceName: referenceName - screeningExpression: - - name: name - expr: expr - - name: name - expr: expr - allUniversalScreenParameters: - - null - - null - dateList: - calendar: calendar - dates: - - dates - - dates - frequency: frequency - screeningExpressionUniverse: - universeExpr: universeExpr - securityExpr: securityExpr - universeType: Equity - universalScreenUniverse: - screen: screen - fqlExpression: - - name: name - expr: expr - - name: name - expr: expr - meta: - contentorganization: SimplifiedRow - allowArrayData: true - format: JsonStach - stachContentOrganization: SimplifiedRow - contenttype: Json + name: name + category: category + meta: "" properties: data: additionalProperties: - $ref: '#/components/schemas/QuantCalculationParameters' - description: List of calculation parameters. + $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndType' type: object - meta: - $ref: '#/components/schemas/QuantCalculationMeta' + meta: {} + required: + - data type: object - SPARDateParameters: - description: The date parameters for SPAR calculation. + UnlinkedPATemplateColumnDetails: + additionalProperties: false example: - enddate: enddate - startdate: startdate - frequency: frequency + name: name + id: id + statistics: + - statistics + - statistics properties: - startdate: - description: Calculation's start date. + name: + description: Unlinked template column name type: string - enddate: - description: Calculation's end date. + id: + description: FactSet-defined or User-defined Column identifier. type: string - frequency: - description: Calculation's frequency. + statistics: + description: Column Statistic identifier + items: + type: string + type: array + type: object + UnlinkedPATemplateGroupDetails: + additionalProperties: false + example: + name: name + id: id + properties: + name: + description: Unlinked template group name + type: string + id: + description: FactSet-defined or User-defined Group identifier. type: string - required: - - enddate - - frequency - - startdate type: object - SPARCalculationParameters: + UnlinkedPATemplateCategoryAndTypeDetails: + additionalProperties: false example: - currencyisocode: currencyisocode - componentid: componentid - dates: - enddate: enddate - startdate: startdate - frequency: frequency - accounts: - - prefix: prefix - returntype: returntype + columns: + - name: name id: id - - prefix: prefix - returntype: returntype + statistics: + - statistics + - statistics + - name: name id: id - benchmark: - prefix: prefix - returntype: returntype + statistics: + - statistics + - statistics + name: name + groups: + - name: name + id: id + - name: name id: id + id: id + category: category + snapshot: true properties: - componentid: - description: The SPAR Engine component identifier to analyze. + id: + description: Type Id type: string - accounts: - description: List of accounts for SPAR calculation. + columns: + description: List of default columns items: - $ref: '#/components/schemas/SPARIdentifier' + $ref: '#/components/schemas/UnlinkedPATemplateColumnDetails' type: array - benchmark: - $ref: '#/components/schemas/SPARIdentifier' - dates: - $ref: '#/components/schemas/SPARDateParameters' - currencyisocode: - description: Currency ISO code for calculation. + groups: + description: List of default groupings + items: + $ref: '#/components/schemas/UnlinkedPATemplateGroupDetails' + type: array + snapshot: + description: Snapshot + type: boolean + category: + description: Unlinked template category + type: string + name: + description: Unlinked template type type: string - required: - - componentid type: object - SPARCalculationParametersRoot: + UnlinkedPATemplateCategoryAndTypeDetailsRoot: + additionalProperties: false example: data: - key: - currencyisocode: currencyisocode - componentid: componentid - dates: - enddate: enddate - startdate: startdate - frequency: frequency - accounts: - - prefix: prefix - returntype: returntype - id: id - - prefix: prefix - returntype: returntype - id: id - benchmark: - prefix: prefix - returntype: returntype - id: id - meta: - contentorganization: SimplifiedRow - format: JsonStach - stachContentOrganization: SimplifiedRow - contenttype: Json + columns: + - name: name + id: id + statistics: + - statistics + - statistics + - name: name + id: id + statistics: + - statistics + - statistics + name: name + groups: + - name: name + id: id + - name: name + id: id + id: id + category: category + snapshot: true + meta: "" properties: data: - additionalProperties: - $ref: '#/components/schemas/SPARCalculationParameters' - description: List of calculation parameters. - type: object - meta: - $ref: '#/components/schemas/CalculationMeta' + $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetails' + meta: {} + required: + - data type: object VaultCalculationParameters: + additionalProperties: false example: componentdetail: componentdetail componentid: componentid @@ -34613,7 +41819,7 @@ components: type: string componentdetail: description: Component detail type for the Vault component. It can be GROUPS - or TOTALS. + or TOTALS or SECURITIES. type: string required: - account @@ -34621,6 +41827,7 @@ components: - configid type: object VaultCalculationParametersRoot: + additionalProperties: false example: data: key: diff --git a/auto-generated-sdk/build.gradle b/auto-generated-sdk/build.gradle index aa9f5b00..70a54b12 100644 --- a/auto-generated-sdk/build.gradle +++ b/auto-generated-sdk/build.gradle @@ -1,25 +1,25 @@ apply plugin: 'idea' apply plugin: 'eclipse' +apply plugin: 'com.diffplug.spotless' group = 'com.factset.analyticsapi' -version = '5.1.0' +version = '5.2.0' buildscript { repositories { - maven { url "https://repo1.maven.org/maven2" } - jcenter() + mavenCentral() } dependencies { classpath 'com.android.tools.build:gradle:2.3.+' classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5' + classpath 'com.diffplug.spotless:spotless-plugin-gradle:5.17.1' } } repositories { - jcenter() + mavenCentral() } - if(hasProperty('target') && target == 'android') { apply plugin: 'com.android.library' @@ -49,7 +49,7 @@ if(hasProperty('target') && target == 'android') { } dependencies { - provided 'javax.annotation:jsr250-api:1.0' + provided "jakarta.annotation:jakarta.annotation-api:$jakarta_annotation_version" } } @@ -77,13 +77,17 @@ if(hasProperty('target') && target == 'android') { } else { apply plugin: 'java' - apply plugin: 'maven' + apply plugin: 'maven-publish' sourceCompatibility = JavaVersion.VERSION_1_7 targetCompatibility = JavaVersion.VERSION_1_7 - install { - repositories.mavenInstaller { - pom.artifactId = 'engines-sdk' + publishing { + publications { + maven(MavenPublication) { + artifactId = 'engines-sdk' + + from components.java + } } } @@ -94,12 +98,13 @@ if(hasProperty('target') && target == 'android') { } ext { - swagger_annotations_version = "1.5.22" - jackson_version = "2.10.5" - jackson_databind_version = "2.10.5.1" - jackson_databind_nullable_version = "0.2.1" - jersey_version = "2.27" - junit_version = "4.13.1" + swagger_annotations_version = "1.6.3" + jackson_version = "2.13.0" + jackson_databind_version = "2.13.0" + jackson_databind_nullable_version = "0.2.2" + jakarta_annotation_version = "1.3.5" + jersey_version = "2.35" + junit_version = "4.13.2" threetenbp_version = "2.9.10" } @@ -117,10 +122,34 @@ dependencies { implementation "org.openapitools:jackson-databind-nullable:$jackson_databind_nullable_version" implementation "com.github.joschi.jackson:jackson-datatype-threetenbp:$threetenbp_version" implementation "com.brsanthu:migbase64:2.2" - implementation 'javax.annotation:javax.annotation-api:1.3.2' + implementation "jakarta.annotation:jakarta.annotation-api:$jakarta_annotation_version" testImplementation "junit:junit:$junit_version" } javadoc { options.tags = [ "http.response.details:a:Http Response Details" ] } + +// Use spotless plugin to automatically format code, remove unused import, etc +// To apply changes directly to the file, run `gradlew spotlessApply` +// Ref: https://github.com/diffplug/spotless/tree/main/plugin-gradle +spotless { + // comment out below to run spotless as part of the `check` task + enforceCheck false + + format 'misc', { + // define the files (e.g. '*.gradle', '*.md') to apply `misc` to + target '.gitignore' + // define the steps to apply to those files + trimTrailingWhitespace() + indentWithSpaces() // Takes an integer argument if you don't like 4 + endWithNewline() + } + java { + // don't need to set target, it is inferred from java + // apply a specific flavor of google-java-format + googleJavaFormat('1.8').aosp().reflowLongStrings() + removeUnusedImports() + importOrder() + } +} diff --git a/auto-generated-sdk/build.sbt b/auto-generated-sdk/build.sbt index 27554468..4f834837 100644 --- a/auto-generated-sdk/build.sbt +++ b/auto-generated-sdk/build.sbt @@ -2,26 +2,28 @@ lazy val root = (project in file(".")). settings( organization := "com.factset.analyticsapi", name := "engines-sdk", - version := "5.1.0", + version := "5.2.0", scalaVersion := "2.11.4", scalacOptions ++= Seq("-feature"), - javacOptions in compile ++= Seq("-Xlint:deprecation"), - publishArtifact in (Compile, packageDoc) := false, + Compile / javacOptions ++= Seq("-Xlint:deprecation"), + Compile / packageDoc / publishArtifact := false, resolvers += Resolver.mavenLocal, libraryDependencies ++= Seq( - "io.swagger" % "swagger-annotations" % "1.5.22", - "org.glassfish.jersey.core" % "jersey-client" % "2.27", - "org.glassfish.jersey.inject" % "jersey-hk2" % "2.27", - "org.glassfish.jersey.media" % "jersey-media-multipart" % "2.27", - "org.glassfish.jersey.media" % "jersey-media-json-jackson" % "2.27", - "org.glassfish.jersey.connectors" % "jersey-apache-connector" % "2.27", - "com.fasterxml.jackson.core" % "jackson-core" % "2.10.5" % "compile", - "com.fasterxml.jackson.core" % "jackson-annotations" % "2.10.5.1" % "compile", - "com.fasterxml.jackson.core" % "jackson-databind" % "2.10.5.1" % "compile", - "com.github.joschi.jackson" % "jackson-datatype-threetenbp" % "2.9.10" % "compile", + "com.google.code.findbugs" % "jsr305" % "3.0.0", + "io.swagger" % "swagger-annotations" % "1.6.3", + "org.glassfish.jersey.core" % "jersey-client" % "2.35", + "org.glassfish.jersey.inject" % "jersey-hk2" % "2.35", + "org.glassfish.jersey.media" % "jersey-media-multipart" % "2.35", + "org.glassfish.jersey.media" % "jersey-media-json-jackson" % "2.35", + "org.glassfish.jersey.connectors" % "jersey-apache-connector" % "2.35", + "com.fasterxml.jackson.core" % "jackson-core" % "2.13.0" % "compile", + "com.fasterxml.jackson.core" % "jackson-annotations" % "2.13.0" % "compile", + "com.fasterxml.jackson.core" % "jackson-databind" % "2.13.0" % "compile", + "com.github.joschi.jackson" % "jackson-datatype-threetenbp" % "2.12.5" % "compile", + "org.openapitools" % "jackson-databind-nullable" % "0.2.2" % "compile", "com.brsanthu" % "migbase64" % "2.2", - "javax.annotation" % "javax.annotation-api" % "1.3.2" % "compile", - "junit" % "junit" % "4.13.1" % "test", + "jakarta.annotation" % "jakarta.annotation-api" % "1.3.5" % "compile", + "junit" % "junit" % "4.13.2" % "test", "com.novocode" % "junit-interface" % "0.10" % "test" ) ) diff --git a/auto-generated-sdk/docs/AccountsApi.md b/auto-generated-sdk/docs/AccountsApi.md index 09afef4e..ce135a91 100644 --- a/auto-generated-sdk/docs/AccountsApi.md +++ b/auto-generated-sdk/docs/AccountsApi.md @@ -6,6 +6,7 @@ All URIs are relative to *https://api.factset.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**getAccounts**](AccountsApi.md#getAccounts) | **GET** /analytics/lookups/v3/accounts/{path} | Get accounts and sub-directories in a directory +[**getSPARReturnsType**](AccountsApi.md#getSPARReturnsType) | **GET** /analytics/engines/spar/v3/accounts/{accountPath}/returns-type | Get SPAR account returns type details @@ -91,3 +92,86 @@ Name | Type | Description | Notes | **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 some time | * 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.
| + +## getSPARReturnsType + +> SPARAccountsRoot getSPARReturnsType(accountPath) + +Get SPAR account returns type details + +This endpoint returns the returns type of account associated with SPAR + +### Example + +```java +// Import classes: +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.auth.*; +import factset.analyticsapi.engines.model.*; +import factset.analyticsapi.engines.api.AccountsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.factset.com"); + + // Configure HTTP basic authorization: Basic + HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); + Basic.setUsername("YOUR USERNAME"); + Basic.setPassword("YOUR PASSWORD"); + + // Configure HTTP bearer authorization: Bearer + HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer"); + Bearer.setBearerToken("BEARER TOKEN"); + + AccountsApi apiInstance = new AccountsApi(defaultClient); + String accountPath = "accountPath_example"; // String | URL encoded account path + try { + SPARAccountsRoot result = apiInstance.getSPARReturnsType(accountPath); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling AccountsApi#getSPARReturnsType"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getClientErrorResponse()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accountPath** | **String**| URL encoded account path | + +### Return type + +[**SPARAccountsRoot**](SPARAccountsRoot.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 list of return types for the account. | * 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 account. | * 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** | Account 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.
| + diff --git a/auto-generated-sdk/docs/CalculationUnitStatus.md b/auto-generated-sdk/docs/CalculationUnitStatus.md index 1e2fd60f..adfd1dcc 100644 --- a/auto-generated-sdk/docs/CalculationUnitStatus.md +++ b/auto-generated-sdk/docs/CalculationUnitStatus.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes **errors** | [**java.util.List<Error>**](Error.md) | The error in a calculation unit. | [optional] **result** | **String** | The result URL of the calculation. | [optional] **progress** | **String** | The progress of the calculation unit. | [optional] +**points** | **Integer** | The points for the calculation unit. | [optional] diff --git a/auto-generated-sdk/docs/FIJobSettings.md b/auto-generated-sdk/docs/FIJobSettings.md index 3da7b8c9..b0c4abd1 100644 --- a/auto-generated-sdk/docs/FIJobSettings.md +++ b/auto-generated-sdk/docs/FIJobSettings.md @@ -9,6 +9,20 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **asOfDate** | **String** | As of date | **partialDurationMonths** | **java.util.List<Integer>** | Partial duration months | [optional] +**callMethod** | [**CallMethodEnum**](#CallMethodEnum) | Call Method | [optional] +**settlement** | **String** | Settlement Date | [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] + + + +## Enum: CallMethodEnum + +Name | Value +---- | ----- +NO_CALL | "No Call" +INTRINSIC_VALUE | "Intrinsic Value" +FIRST_CALL | "First Call" +FIRST_PAR | "First Par" ## Implemented Interfaces diff --git a/auto-generated-sdk/docs/FILoss.md b/auto-generated-sdk/docs/FILoss.md new file mode 100644 index 00000000..0e56468d --- /dev/null +++ b/auto-generated-sdk/docs/FILoss.md @@ -0,0 +1,17 @@ + + +# FILoss + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**lossName** | **String** | Loss Name | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/FIPrepay.md b/auto-generated-sdk/docs/FIPrepay.md new file mode 100644 index 00000000..1dff5097 --- /dev/null +++ b/auto-generated-sdk/docs/FIPrepay.md @@ -0,0 +1,17 @@ + + +# FIPrepay + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**prepayName** | **String** | Prepay Name | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/FIReferencePrepay.md b/auto-generated-sdk/docs/FIReferencePrepay.md new file mode 100644 index 00000000..065ccfa0 --- /dev/null +++ b/auto-generated-sdk/docs/FIReferencePrepay.md @@ -0,0 +1,17 @@ + + +# FIReferencePrepay + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**prepayName** | **String** | Reference Prepay Name | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/FIReferenceSecurity.md b/auto-generated-sdk/docs/FIReferenceSecurity.md new file mode 100644 index 00000000..dbcff72b --- /dev/null +++ b/auto-generated-sdk/docs/FIReferenceSecurity.md @@ -0,0 +1,22 @@ + + +# FIReferenceSecurity + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**securityType** | **String** | Reference Security Type | [optional] +**securityName** | **String** | Reference Security Name | [optional] +**calcFromMethod** | **String** | Reference 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** | Reference CalcFromValue | [optional] +**prepay** | [**FIReferencePrepay**](FIReferencePrepay.md) | | [optional] +**settlement** | **String** | Reference Settlement Date | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/FISecurity.md b/auto-generated-sdk/docs/FISecurity.md index 07142aa9..48f60569 100644 --- a/auto-generated-sdk/docs/FISecurity.md +++ b/auto-generated-sdk/docs/FISecurity.md @@ -8,7 +8,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **settlement** | **String** | Settlement date | [optional] -**calcFromMethod** | **String** | Calculation from method | +**callMethod** | [**CallMethodEnum**](#CallMethodEnum) | Call Method | [optional] +**referenceSecurity** | [**FIReferenceSecurity**](FIReferenceSecurity.md) | | [optional] +**loss** | [**FILoss**](FILoss.md) | | [optional] +**prepay** | [**FIPrepay**](FIPrepay.md) | | [optional] +**matrixSpreadAdjustment** | **Double** | Matrix Spread Adjustment | [optional] +**matrixMultiplier** | **Double** | Matrix Multiplier | [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] **faceType** | [**FaceTypeEnum**](#FaceTypeEnum) | Face type | [optional] @@ -17,6 +23,17 @@ Name | Type | Description | Notes +## Enum: CallMethodEnum + +Name | Value +---- | ----- +NO_CALL | "No Call" +INTRINSIC_VALUE | "Intrinsic Value" +FIRST_CALL | "First Call" +FIRST_PAR | "First Par" + + + ## Enum: FaceTypeEnum Name | Value diff --git a/auto-generated-sdk/docs/FPOObjective.md b/auto-generated-sdk/docs/FPOObjective.md new file mode 100644 index 00000000..24143e54 --- /dev/null +++ b/auto-generated-sdk/docs/FPOObjective.md @@ -0,0 +1,27 @@ + + +# FPOObjective + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**active** | **String** | | [optional] +**terms** | [**java.util.Map<String, InnerEnum>**](#java.util.Map<String, InnerEnum>) | | [optional] + + + +## Enum: java.util.Map<String, InnerEnum> + +Name | Value +---- | ----- +DISABLE | "Disable" +ENABLE | "Enable" + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/FPOOptimizationParameters.md b/auto-generated-sdk/docs/FPOOptimizationParameters.md index 4f9f0c46..27f06e93 100644 --- a/auto-generated-sdk/docs/FPOOptimizationParameters.md +++ b/auto-generated-sdk/docs/FPOOptimizationParameters.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **account** | [**FPOAccount**](FPOAccount.md) | | [optional] -**strategy** | [**OptimizerStrategy**](OptimizerStrategy.md) | | +**strategy** | [**FPOOptimizerStrategy**](FPOOptimizerStrategy.md) | | **optimization** | [**Optimization**](Optimization.md) | | [optional] **outputTypes** | [**OptimizerOutputTypes**](OptimizerOutputTypes.md) | | diff --git a/auto-generated-sdk/docs/OptimizerStrategy.md b/auto-generated-sdk/docs/FPOOptimizerStrategy.md similarity index 63% rename from auto-generated-sdk/docs/OptimizerStrategy.md rename to auto-generated-sdk/docs/FPOOptimizerStrategy.md index 4fdf237a..1ad0218d 100644 --- a/auto-generated-sdk/docs/OptimizerStrategy.md +++ b/auto-generated-sdk/docs/FPOOptimizerStrategy.md @@ -1,14 +1,14 @@ -# OptimizerStrategy +# FPOOptimizerStrategy ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**overrides** | [**FPOOptimizerStrategyOverrides**](FPOOptimizerStrategyOverrides.md) | | [optional] **id** | **String** | OptimizerStrategy document path | -**overrides** | [**OptimizerStrategyOverrides**](OptimizerStrategyOverrides.md) | | [optional] ## Implemented Interfaces diff --git a/auto-generated-sdk/docs/OptimizerStrategyOverrides.md b/auto-generated-sdk/docs/FPOOptimizerStrategyOverrides.md similarity index 84% rename from auto-generated-sdk/docs/OptimizerStrategyOverrides.md rename to auto-generated-sdk/docs/FPOOptimizerStrategyOverrides.md index de23f298..74b1557a 100644 --- a/auto-generated-sdk/docs/OptimizerStrategyOverrides.md +++ b/auto-generated-sdk/docs/FPOOptimizerStrategyOverrides.md @@ -1,13 +1,13 @@ -# OptimizerStrategyOverrides +# FPOOptimizerStrategyOverrides ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**tax** | **String** | Tax | [optional] +**objective** | [**FPOObjective**](FPOObjective.md) | | [optional] **constraints** | [**java.util.Map<String, InnerEnum>**](#java.util.Map<String, InnerEnum>) | List of constraints | [optional] **alpha** | **String** | Alpha | [optional] **transactionCost** | **String** | Transaction cost | [optional] diff --git a/auto-generated-sdk/docs/LinkedPATemplate.md b/auto-generated-sdk/docs/LinkedPATemplate.md new file mode 100644 index 00000000..fe80a3c2 --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplate.md @@ -0,0 +1,23 @@ + + +# LinkedPATemplate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**directory** | **String** | Template directory. | [optional] +**snapshot** | **Boolean** | snapshot. | [optional] +**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] +**id** | **String** | Template id. | [optional] +**description** | **String** | Template description. | [optional] +**name** | **String** | Template name. | [optional] +**parentComponentId** | **String** | Template parent tile. | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/LinkedPATemplateParameters.md b/auto-generated-sdk/docs/LinkedPATemplateParameters.md new file mode 100644 index 00000000..c4049aa8 --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplateParameters.md @@ -0,0 +1,20 @@ + + +# LinkedPATemplateParameters + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**directory** | **String** | The directory to create a linked PA template | +**parentComponentId** | **String** | Parent component id | +**description** | **String** | Template description | [optional] +**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/LinkedPATemplateParametersRoot.md b/auto-generated-sdk/docs/LinkedPATemplateParametersRoot.md new file mode 100644 index 00000000..498eb6db --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplateParametersRoot.md @@ -0,0 +1,18 @@ + + +# LinkedPATemplateParametersRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**LinkedPATemplateParameters**](LinkedPATemplateParameters.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/LinkedPATemplatePostSummary.md b/auto-generated-sdk/docs/LinkedPATemplatePostSummary.md new file mode 100644 index 00000000..516b8a6f --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplatePostSummary.md @@ -0,0 +1,20 @@ + + +# LinkedPATemplatePostSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | Template id. | [optional] +**description** | **String** | Template description. | [optional] +**name** | **String** | Template name. | [optional] +**parentComponentId** | **String** | Template parent tile. | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/LinkedPATemplatePostSummaryRoot.md b/auto-generated-sdk/docs/LinkedPATemplatePostSummaryRoot.md new file mode 100644 index 00000000..ab14f6c4 --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplatePostSummaryRoot.md @@ -0,0 +1,18 @@ + + +# LinkedPATemplatePostSummaryRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**LinkedPATemplatePostSummary**](LinkedPATemplatePostSummary.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/LinkedPATemplateRoot.md b/auto-generated-sdk/docs/LinkedPATemplateRoot.md new file mode 100644 index 00000000..f9cac34a --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplateRoot.md @@ -0,0 +1,18 @@ + + +# LinkedPATemplateRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**LinkedPATemplate**](LinkedPATemplate.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/LinkedPATemplateSummary.md b/auto-generated-sdk/docs/LinkedPATemplateSummary.md new file mode 100644 index 00000000..8e95e61f --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplateSummary.md @@ -0,0 +1,19 @@ + + +# LinkedPATemplateSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **String** | Template description. | [optional] +**name** | **String** | Template name. | [optional] +**parentComponentId** | **String** | Template parent tile. | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/LinkedPATemplateSummaryRoot.md b/auto-generated-sdk/docs/LinkedPATemplateSummaryRoot.md new file mode 100644 index 00000000..a75c2ba8 --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplateSummaryRoot.md @@ -0,0 +1,18 @@ + + +# LinkedPATemplateSummaryRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**Map<String, LinkedPATemplateSummary>**](LinkedPATemplateSummary.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/LinkedPATemplateUpdateParameters.md b/auto-generated-sdk/docs/LinkedPATemplateUpdateParameters.md new file mode 100644 index 00000000..61862c91 --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplateUpdateParameters.md @@ -0,0 +1,19 @@ + + +# LinkedPATemplateUpdateParameters + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**parentComponentId** | **String** | Parent component id | [optional] +**description** | **String** | Template description | [optional] +**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/LinkedPATemplateUpdateParametersRoot.md b/auto-generated-sdk/docs/LinkedPATemplateUpdateParametersRoot.md new file mode 100644 index 00000000..b0fdc1fb --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplateUpdateParametersRoot.md @@ -0,0 +1,18 @@ + + +# LinkedPATemplateUpdateParametersRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**LinkedPATemplateUpdateParameters**](LinkedPATemplateUpdateParameters.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/LinkedPaTemplatesApi.md b/auto-generated-sdk/docs/LinkedPaTemplatesApi.md new file mode 100644 index 00000000..197a59d0 --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPaTemplatesApi.md @@ -0,0 +1,460 @@ + +# LinkedPaTemplatesApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createLinkedPATemplates**](LinkedPaTemplatesApi.md#createLinkedPATemplates) | **POST** /analytics/engines/pa/v3/linked-templates | Create a linked PA template +[**deleteLinkedPATemplates**](LinkedPaTemplatesApi.md#deleteLinkedPATemplates) | **DELETE** /analytics/engines/pa/v3/linked-templates/{id} | Delete a linked PA template. +[**getLinkedPATemplates**](LinkedPaTemplatesApi.md#getLinkedPATemplates) | **GET** /analytics/engines/pa/v3/linked-templates | Get linked PA templates +[**getLinkedPATemplatesById**](LinkedPaTemplatesApi.md#getLinkedPATemplatesById) | **GET** /analytics/engines/pa/v3/linked-templates/{id} | Get linked PA template by id +[**updateLinkedPATemplates**](LinkedPaTemplatesApi.md#updateLinkedPATemplates) | **PUT** /analytics/engines/pa/v3/linked-templates/{id} | Update a linked PA template + + + +## createLinkedPATemplates + +> LinkedPATemplatePostSummaryRoot createLinkedPATemplates(linkedPATemplateParametersRoot) + +Create a linked PA template + +This endpoint creates a template from an **existing portfolio analysis tile**, allowing the user to replicate and fetch reports settings. + +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", "dates", "currencyisocode" and "componentdetail". + +* We cannot override the Locked fields when creating the Component. + +* Mandatory and locked strings are mutually exclusive. + +* Multi-horizon frequencies are not supported through this endpoint. + +### Example + +```java +// Import classes: +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.auth.*; +import factset.analyticsapi.engines.model.*; +import factset.analyticsapi.engines.api.LinkedPaTemplatesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.factset.com"); + + // Configure HTTP basic authorization: Basic + HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); + Basic.setUsername("YOUR USERNAME"); + Basic.setPassword("YOUR PASSWORD"); + + // Configure HTTP bearer authorization: Bearer + HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer"); + Bearer.setBearerToken("BEARER TOKEN"); + + LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient); + LinkedPATemplateParametersRoot linkedPATemplateParametersRoot = new LinkedPATemplateParametersRoot(); // LinkedPATemplateParametersRoot | Request Parameters + try { + LinkedPATemplatePostSummaryRoot result = apiInstance.createLinkedPATemplates(linkedPATemplateParametersRoot); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LinkedPaTemplatesApi#createLinkedPATemplates"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getClientErrorResponse()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **linkedPATemplateParametersRoot** | [**LinkedPATemplateParametersRoot**](LinkedPATemplateParametersRoot.md)| Request Parameters | + +### Return type + +[**LinkedPATemplatePostSummaryRoot**](LinkedPATemplatePostSummaryRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **201** | Expected response, created a template linked to a PA3 tile. | * 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 data provided. Please check the request parameters before attempting again. | * 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** | 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.
| +| **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.
| + + +## deleteLinkedPATemplates + +> deleteLinkedPATemplates(id) + +Delete a linked PA template. + +This endpoint deletes an existing linked PA template. + +### Example + +```java +// Import classes: +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.auth.*; +import factset.analyticsapi.engines.model.*; +import factset.analyticsapi.engines.api.LinkedPaTemplatesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.factset.com"); + + // Configure HTTP basic authorization: Basic + HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); + Basic.setUsername("YOUR USERNAME"); + Basic.setPassword("YOUR PASSWORD"); + + // Configure HTTP bearer authorization: Bearer + HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer"); + Bearer.setBearerToken("BEARER TOKEN"); + + LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient); + String id = "id_example"; // String | Unique identifier for a linked PA template + try { + apiInstance.deleteLinkedPATemplates(id); + } catch (ApiException e) { + System.err.println("Exception when calling LinkedPaTemplatesApi#deleteLinkedPATemplates"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getClientErrorResponse()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| Unique identifier for a linked PA template | + +### Return type + +null (empty response body) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/plain, application/json, text/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Expected response, deleted the linked PA template successfully. | * 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 data provided. Please check the request parameters before attempting again. | * 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** | Template 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.
| + + +## getLinkedPATemplates + +> LinkedPATemplateSummaryRoot getLinkedPATemplates(directory, documentDirectory, documentName) + +Get linked PA templates + +This endpoint returns the list of linked PA templates in given path. + +### Example + +```java +// Import classes: +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.auth.*; +import factset.analyticsapi.engines.model.*; +import factset.analyticsapi.engines.api.LinkedPaTemplatesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.factset.com"); + + // Configure HTTP basic authorization: Basic + HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); + Basic.setUsername("YOUR USERNAME"); + Basic.setPassword("YOUR PASSWORD"); + + // Configure HTTP bearer authorization: Bearer + HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer"); + Bearer.setBearerToken("BEARER TOKEN"); + + LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient); + String directory = "directory_example"; // String | Get linked PA templates in path. + String documentDirectory = "documentDirectory_example"; // String | Get linked PA templates for documents in document path + String documentName = "documentName_example"; // String | Get linked PA templates for documents by document name + try { + LinkedPATemplateSummaryRoot result = apiInstance.getLinkedPATemplates(directory, documentDirectory, documentName); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LinkedPaTemplatesApi#getLinkedPATemplates"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getClientErrorResponse()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **directory** | **String**| Get linked PA templates in path. | [optional] + **documentDirectory** | **String**| Get linked PA templates for documents in document path | [optional] + **documentName** | **String**| Get linked PA templates for documents by document name | [optional] + +### Return type + +[**LinkedPATemplateSummaryRoot**](LinkedPATemplateSummaryRoot.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 a list of templates linked to PA3 tile. | * 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 data provided. Please check the request parameters before attempting again. | * 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** | Document 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.
| + + +## getLinkedPATemplatesById + +> LinkedPATemplateRoot getLinkedPATemplatesById(id) + +Get linked PA template by id + +This endpoint fetches the linked PA template settings. + +### Example + +```java +// Import classes: +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.auth.*; +import factset.analyticsapi.engines.model.*; +import factset.analyticsapi.engines.api.LinkedPaTemplatesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.factset.com"); + + // Configure HTTP basic authorization: Basic + HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); + Basic.setUsername("YOUR USERNAME"); + Basic.setPassword("YOUR PASSWORD"); + + // Configure HTTP bearer authorization: Bearer + HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer"); + Bearer.setBearerToken("BEARER TOKEN"); + + LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient); + String id = "id_example"; // String | Unique identifier for a linked PA template + try { + LinkedPATemplateRoot result = apiInstance.getLinkedPATemplatesById(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LinkedPaTemplatesApi#getLinkedPATemplatesById"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getClientErrorResponse()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| Unique identifier for a linked PA template | + +### Return type + +[**LinkedPATemplateRoot**](LinkedPATemplateRoot.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, linked PA template details. | * 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 data provided. Please check the request parameters before attempting again. | * 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** | Template 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.
| + + +## updateLinkedPATemplates + +> LinkedPATemplatePostSummaryRoot updateLinkedPATemplates(id, linkedPATemplateUpdateParametersRoot) + +Update a linked PA template + +This endpoint allows the user to change the request body and description from an existing 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", "dates", "currencyisocode" and "componentdetail". + +* We cannot override the Locked fields when creating the Component. + +* Mandatory and locked strings are mutually exclusive. + +* Multi-horizon frequencies are not supported through this endpoint. + +### Example + +```java +// Import classes: +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.auth.*; +import factset.analyticsapi.engines.model.*; +import factset.analyticsapi.engines.api.LinkedPaTemplatesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.factset.com"); + + // Configure HTTP basic authorization: Basic + HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); + Basic.setUsername("YOUR USERNAME"); + Basic.setPassword("YOUR PASSWORD"); + + // Configure HTTP bearer authorization: Bearer + HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer"); + Bearer.setBearerToken("BEARER TOKEN"); + + LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient); + String id = "id_example"; // String | Unique identifier for a linked PA template + LinkedPATemplateUpdateParametersRoot linkedPATemplateUpdateParametersRoot = new LinkedPATemplateUpdateParametersRoot(); // LinkedPATemplateUpdateParametersRoot | Request Parameters + try { + LinkedPATemplatePostSummaryRoot result = apiInstance.updateLinkedPATemplates(id, linkedPATemplateUpdateParametersRoot); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling LinkedPaTemplatesApi#updateLinkedPATemplates"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getClientErrorResponse()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| Unique identifier for a linked PA template | + **linkedPATemplateUpdateParametersRoot** | [**LinkedPATemplateUpdateParametersRoot**](LinkedPATemplateUpdateParametersRoot.md)| Request Parameters | + +### Return type + +[**LinkedPATemplatePostSummaryRoot**](LinkedPATemplatePostSummaryRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Expected response, updated a template linked to a PA3 tile. | * 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 data provided. Please check the request parameters before attempting again. | * 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** | Template or 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.
| + diff --git a/auto-generated-sdk/docs/OneOfQuantDates.md b/auto-generated-sdk/docs/OneOfQuantDates.md new file mode 100644 index 00000000..1212d824 --- /dev/null +++ b/auto-generated-sdk/docs/OneOfQuantDates.md @@ -0,0 +1,37 @@ + + +# OneOfQuantDates + +## oneOf schemas +* [QuantDateList](QuantDateList.md) +* [QuantFdsDate](QuantFdsDate.md) + +## Example +```java +// Import classes: +import factset.analyticsapi.engines.models.OneOfQuantDates; +import factset.analyticsapi.engines.models.QuantDateList; +import factset.analyticsapi.engines.models.QuantFdsDate; + +public class Example { + public static void main(String[] args) { + OneOfQuantDates exampleOneOfQuantDates = new OneOfQuantDates(); + + // create a new QuantDateList + QuantDateList exampleQuantDateList = new QuantDateList(); + // set OneOfQuantDates to QuantDateList + exampleOneOfQuantDates.setActualInstance(exampleQuantDateList); + // to get back the QuantDateList set earlier + QuantDateList testQuantDateList = (QuantDateList) exampleOneOfQuantDates.getActualInstance(); + + // create a new QuantFdsDate + QuantFdsDate exampleQuantFdsDate = new QuantFdsDate(); + // set OneOfQuantDates to QuantFdsDate + exampleOneOfQuantDates.setActualInstance(exampleQuantFdsDate); + // to get back the QuantFdsDate set earlier + QuantFdsDate testQuantFdsDate = (QuantFdsDate) exampleOneOfQuantDates.getActualInstance(); + } +} +``` + + diff --git a/auto-generated-sdk/docs/OneOfQuantFormulasArray.md b/auto-generated-sdk/docs/OneOfQuantFormulasArray.md new file mode 100644 index 00000000..c6b44011 --- /dev/null +++ b/auto-generated-sdk/docs/OneOfQuantFormulasArray.md @@ -0,0 +1,55 @@ + + +# OneOfQuantFormulasArray + +## oneOf schemas +* [QuantAllUniversalScreenParameters](QuantAllUniversalScreenParameters.md) +* [QuantFqlExpression](QuantFqlExpression.md) +* [QuantScreeningExpression](QuantScreeningExpression.md) +* [QuantUniversalScreenParameter](QuantUniversalScreenParameter.md) + +## Example +```java +// Import classes: +import factset.analyticsapi.engines.models.OneOfQuantFormulasArray; +import factset.analyticsapi.engines.models.QuantAllUniversalScreenParameters; +import factset.analyticsapi.engines.models.QuantFqlExpression; +import factset.analyticsapi.engines.models.QuantScreeningExpression; +import factset.analyticsapi.engines.models.QuantUniversalScreenParameter; + +public class Example { + public static void main(String[] args) { + OneOfQuantFormulasArray exampleOneOfQuantFormulasArray = new OneOfQuantFormulasArray(); + + // create a new QuantAllUniversalScreenParameters + QuantAllUniversalScreenParameters exampleQuantAllUniversalScreenParameters = new QuantAllUniversalScreenParameters(); + // set OneOfQuantFormulasArray to QuantAllUniversalScreenParameters + exampleOneOfQuantFormulasArray.setActualInstance(exampleQuantAllUniversalScreenParameters); + // to get back the QuantAllUniversalScreenParameters set earlier + QuantAllUniversalScreenParameters testQuantAllUniversalScreenParameters = (QuantAllUniversalScreenParameters) exampleOneOfQuantFormulasArray.getActualInstance(); + + // create a new QuantFqlExpression + QuantFqlExpression exampleQuantFqlExpression = new QuantFqlExpression(); + // set OneOfQuantFormulasArray to QuantFqlExpression + exampleOneOfQuantFormulasArray.setActualInstance(exampleQuantFqlExpression); + // to get back the QuantFqlExpression set earlier + QuantFqlExpression testQuantFqlExpression = (QuantFqlExpression) exampleOneOfQuantFormulasArray.getActualInstance(); + + // create a new QuantScreeningExpression + QuantScreeningExpression exampleQuantScreeningExpression = new QuantScreeningExpression(); + // set OneOfQuantFormulasArray to QuantScreeningExpression + exampleOneOfQuantFormulasArray.setActualInstance(exampleQuantScreeningExpression); + // to get back the QuantScreeningExpression set earlier + QuantScreeningExpression testQuantScreeningExpression = (QuantScreeningExpression) exampleOneOfQuantFormulasArray.getActualInstance(); + + // create a new QuantUniversalScreenParameter + QuantUniversalScreenParameter exampleQuantUniversalScreenParameter = new QuantUniversalScreenParameter(); + // set OneOfQuantFormulasArray to QuantUniversalScreenParameter + exampleOneOfQuantFormulasArray.setActualInstance(exampleQuantUniversalScreenParameter); + // to get back the QuantUniversalScreenParameter set earlier + QuantUniversalScreenParameter testQuantUniversalScreenParameter = (QuantUniversalScreenParameter) exampleOneOfQuantFormulasArray.getActualInstance(); + } +} +``` + + diff --git a/auto-generated-sdk/docs/OneOfQuantUniverse.md b/auto-generated-sdk/docs/OneOfQuantUniverse.md new file mode 100644 index 00000000..cc94b1f0 --- /dev/null +++ b/auto-generated-sdk/docs/OneOfQuantUniverse.md @@ -0,0 +1,46 @@ + + +# OneOfQuantUniverse + +## oneOf schemas +* [QuantIdentifierUniverse](QuantIdentifierUniverse.md) +* [QuantScreeningExpressionUniverse](QuantScreeningExpressionUniverse.md) +* [QuantUniversalScreenUniverse](QuantUniversalScreenUniverse.md) + +## Example +```java +// Import classes: +import factset.analyticsapi.engines.models.OneOfQuantUniverse; +import factset.analyticsapi.engines.models.QuantIdentifierUniverse; +import factset.analyticsapi.engines.models.QuantScreeningExpressionUniverse; +import factset.analyticsapi.engines.models.QuantUniversalScreenUniverse; + +public class Example { + public static void main(String[] args) { + OneOfQuantUniverse exampleOneOfQuantUniverse = new OneOfQuantUniverse(); + + // create a new QuantIdentifierUniverse + QuantIdentifierUniverse exampleQuantIdentifierUniverse = new QuantIdentifierUniverse(); + // set OneOfQuantUniverse to QuantIdentifierUniverse + exampleOneOfQuantUniverse.setActualInstance(exampleQuantIdentifierUniverse); + // to get back the QuantIdentifierUniverse set earlier + QuantIdentifierUniverse testQuantIdentifierUniverse = (QuantIdentifierUniverse) exampleOneOfQuantUniverse.getActualInstance(); + + // create a new QuantScreeningExpressionUniverse + QuantScreeningExpressionUniverse exampleQuantScreeningExpressionUniverse = new QuantScreeningExpressionUniverse(); + // set OneOfQuantUniverse to QuantScreeningExpressionUniverse + exampleOneOfQuantUniverse.setActualInstance(exampleQuantScreeningExpressionUniverse); + // to get back the QuantScreeningExpressionUniverse set earlier + QuantScreeningExpressionUniverse testQuantScreeningExpressionUniverse = (QuantScreeningExpressionUniverse) exampleOneOfQuantUniverse.getActualInstance(); + + // create a new QuantUniversalScreenUniverse + QuantUniversalScreenUniverse exampleQuantUniversalScreenUniverse = new QuantUniversalScreenUniverse(); + // set OneOfQuantUniverse to QuantUniversalScreenUniverse + exampleOneOfQuantUniverse.setActualInstance(exampleQuantUniversalScreenUniverse); + // to get back the QuantUniversalScreenUniverse set earlier + QuantUniversalScreenUniverse testQuantUniversalScreenUniverse = (QuantUniversalScreenUniverse) exampleOneOfQuantUniverse.getActualInstance(); + } +} +``` + + diff --git a/auto-generated-sdk/docs/PACalculationParameters.md b/auto-generated-sdk/docs/PACalculationParameters.md index 5e382f96..e9159379 100644 --- a/auto-generated-sdk/docs/PACalculationParameters.md +++ b/auto-generated-sdk/docs/PACalculationParameters.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes **groups** | [**java.util.List<PACalculationGroup>**](PACalculationGroup.md) | List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document. | [optional] **currencyisocode** | **String** | Currency ISO code for calculation. | [optional] **columns** | [**java.util.List<PACalculationColumn>**](PACalculationColumn.md) | List of columns for the PA calculation. This will take precedence over the columns saved in the PA document. | [optional] -**componentdetail** | **String** | Component detail type for the PA component. It can be GROUPS or TOTALS. | [optional] +**componentdetail** | **String** | Component detail type for the PA component. It can be GROUPS or TOTALS or SECURITIES. | [optional] ## Implemented Interfaces diff --git a/auto-generated-sdk/docs/PAComponent.md b/auto-generated-sdk/docs/PAComponent.md index e50eb16d..df989d29 100644 --- a/auto-generated-sdk/docs/PAComponent.md +++ b/auto-generated-sdk/docs/PAComponent.md @@ -13,6 +13,7 @@ Name | Type | Description | Notes **currencyisocode** | **String** | | [optional] **dates** | [**PADateParameters**](PADateParameters.md) | | [optional] **snapshot** | **Boolean** | Is the component type snapshot or subperiod. | [optional] +**path** | **String** | The path to the document | [optional] **name** | **String** | Component name. | [optional] **category** | **String** | Component category. | [optional] diff --git a/auto-generated-sdk/docs/PAComponentData.md b/auto-generated-sdk/docs/PAComponentData.md new file mode 100644 index 00000000..b075f9b8 --- /dev/null +++ b/auto-generated-sdk/docs/PAComponentData.md @@ -0,0 +1,23 @@ + + +# PAComponentData + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accounts** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of accounts. | [optional] +**benchmarks** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of benchmarks. | [optional] +**groups** | [**java.util.List<PACalculationGroup>**](PACalculationGroup.md) | List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document. | [optional] +**columns** | [**java.util.List<PACalculationColumn>**](PACalculationColumn.md) | List of columns for the PA calculation. This will take precedence over the columns saved in the PA document. | [optional] +**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] +**currencyisocode** | **String** | Currency ISO code for calculation. | [optional] +**componentdetail** | **String** | PA Storage type. It can be GROUPS or TOTALS or SECURITIES. | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/QuantAllUniversalScreenParameters.md b/auto-generated-sdk/docs/QuantAllUniversalScreenParameters.md new file mode 100644 index 00000000..62ef0fd1 --- /dev/null +++ b/auto-generated-sdk/docs/QuantAllUniversalScreenParameters.md @@ -0,0 +1,28 @@ + + +# QuantAllUniversalScreenParameters + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | [**SourceEnum**](#SourceEnum) | | + + + +## Enum: SourceEnum + +Name | Value +---- | ----- +SCREENINGEXPRESSION | "ScreeningExpression" +FQLEXPRESSION | "FqlExpression" +UNIVERSALSCREENPARAMETER | "UniversalScreenParameter" +ALLUNIVERSALSCREENPARAMETERS | "AllUniversalScreenParameters" + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/QuantCalculationParameters.md b/auto-generated-sdk/docs/QuantCalculationParameters.md index 66b10ddc..9c778910 100644 --- a/auto-generated-sdk/docs/QuantCalculationParameters.md +++ b/auto-generated-sdk/docs/QuantCalculationParameters.md @@ -7,15 +7,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**screeningExpressionUniverse** | [**QuantScreeningExpressionUniverse**](QuantScreeningExpressionUniverse.md) | | [optional] -**universalScreenUniverse** | [**QuantUniversalScreenUniverse**](QuantUniversalScreenUniverse.md) | | [optional] -**identifierUniverse** | [**QuantIdentifierUniverse**](QuantIdentifierUniverse.md) | | [optional] -**fdsDate** | [**QuantFdsDate**](QuantFdsDate.md) | | [optional] -**dateList** | [**QuantDateList**](QuantDateList.md) | | [optional] -**screeningExpression** | [**java.util.List<QuantScreeningExpression>**](QuantScreeningExpression.md) | | [optional] -**fqlExpression** | [**java.util.List<QuantFqlExpression>**](QuantFqlExpression.md) | | [optional] -**universalScreenParameter** | [**java.util.List<QuantUniversalScreenParameter>**](QuantUniversalScreenParameter.md) | | [optional] -**allUniversalScreenParameters** | **java.util.List<Object>** | | [optional] +**universe** | [**OneOfQuantUniverse**](OneOfQuantUniverse.md) | | [optional] +**dates** | [**OneOfQuantDates**](OneOfQuantDates.md) | | [optional] +**formulas** | [**java.util.List<OneOfQuantFormulasArray>**](OneOfQuantFormulasArray.md) | | [optional] ## Implemented Interfaces diff --git a/auto-generated-sdk/docs/QuantDate.md b/auto-generated-sdk/docs/QuantDate.md new file mode 100644 index 00000000..7e260b23 --- /dev/null +++ b/auto-generated-sdk/docs/QuantDate.md @@ -0,0 +1,28 @@ + + +# QuantDate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | [**SourceEnum**](#SourceEnum) | | +**frequency** | **String** | | +**calendar** | **String** | | + + + +## Enum: SourceEnum + +Name | Value +---- | ----- +FDSDATE | "FdsDate" +DATELIST | "DateList" + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/QuantDateList.md b/auto-generated-sdk/docs/QuantDateList.md index 2e8472a1..eba4a4a8 100644 --- a/auto-generated-sdk/docs/QuantDateList.md +++ b/auto-generated-sdk/docs/QuantDateList.md @@ -8,10 +8,20 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **dates** | **java.util.List<String>** | | [optional] +**source** | [**SourceEnum**](#SourceEnum) | | **frequency** | **String** | | **calendar** | **String** | | + +## Enum: SourceEnum + +Name | Value +---- | ----- +FDSDATE | "FdsDate" +DATELIST | "DateList" + + ## Implemented Interfaces * Serializable diff --git a/auto-generated-sdk/docs/QuantDateListObsolete.md b/auto-generated-sdk/docs/QuantDateListObsolete.md new file mode 100644 index 00000000..9948a230 --- /dev/null +++ b/auto-generated-sdk/docs/QuantDateListObsolete.md @@ -0,0 +1,19 @@ + + +# QuantDateListObsolete + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dates** | **java.util.List<String>** | | [optional] +**frequency** | **String** | | +**calendar** | **String** | | + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/QuantFdsDate.md b/auto-generated-sdk/docs/QuantFdsDate.md index 7f84abd4..eb8ad41e 100644 --- a/auto-generated-sdk/docs/QuantFdsDate.md +++ b/auto-generated-sdk/docs/QuantFdsDate.md @@ -9,10 +9,20 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **startDate** | **String** | | **endDate** | **String** | | +**source** | [**SourceEnum**](#SourceEnum) | | **frequency** | **String** | | **calendar** | **String** | | + +## Enum: SourceEnum + +Name | Value +---- | ----- +FDSDATE | "FdsDate" +DATELIST | "DateList" + + ## Implemented Interfaces * Serializable diff --git a/auto-generated-sdk/docs/QuantFdsDateObsolete.md b/auto-generated-sdk/docs/QuantFdsDateObsolete.md new file mode 100644 index 00000000..1643c96d --- /dev/null +++ b/auto-generated-sdk/docs/QuantFdsDateObsolete.md @@ -0,0 +1,20 @@ + + +# QuantFdsDateObsolete + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**startDate** | **String** | | +**endDate** | **String** | | +**frequency** | **String** | | +**calendar** | **String** | | + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/QuantFormula.md b/auto-generated-sdk/docs/QuantFormula.md new file mode 100644 index 00000000..867b939e --- /dev/null +++ b/auto-generated-sdk/docs/QuantFormula.md @@ -0,0 +1,28 @@ + + +# QuantFormula + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | [**SourceEnum**](#SourceEnum) | | + + + +## Enum: SourceEnum + +Name | Value +---- | ----- +SCREENINGEXPRESSION | "ScreeningExpression" +FQLEXPRESSION | "FqlExpression" +UNIVERSALSCREENPARAMETER | "UniversalScreenParameter" +ALLUNIVERSALSCREENPARAMETERS | "AllUniversalScreenParameters" + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/QuantFqlExpression.md b/auto-generated-sdk/docs/QuantFqlExpression.md index da14fb4c..2a5abb7e 100644 --- a/auto-generated-sdk/docs/QuantFqlExpression.md +++ b/auto-generated-sdk/docs/QuantFqlExpression.md @@ -9,6 +9,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **expr** | **String** | | **name** | **String** | | +**source** | [**SourceEnum**](#SourceEnum) | | + + + +## Enum: SourceEnum + +Name | Value +---- | ----- +SCREENINGEXPRESSION | "ScreeningExpression" +FQLEXPRESSION | "FqlExpression" +UNIVERSALSCREENPARAMETER | "UniversalScreenParameter" +ALLUNIVERSALSCREENPARAMETERS | "AllUniversalScreenParameters" ## Implemented Interfaces diff --git a/auto-generated-sdk/docs/QuantFqlExpressionObsolete.md b/auto-generated-sdk/docs/QuantFqlExpressionObsolete.md new file mode 100644 index 00000000..bfb0c41a --- /dev/null +++ b/auto-generated-sdk/docs/QuantFqlExpressionObsolete.md @@ -0,0 +1,18 @@ + + +# QuantFqlExpressionObsolete + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**expr** | **String** | | +**name** | **String** | | + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/QuantIdentifierUniverse.md b/auto-generated-sdk/docs/QuantIdentifierUniverse.md index 2cebe1a3..92c20a32 100644 --- a/auto-generated-sdk/docs/QuantIdentifierUniverse.md +++ b/auto-generated-sdk/docs/QuantIdentifierUniverse.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **universeType** | [**UniverseTypeEnum**](#UniverseTypeEnum) | | **identifiers** | **java.util.List<String>** | | +**source** | [**SourceEnum**](#SourceEnum) | | @@ -20,6 +21,16 @@ EQUITY | "Equity" DEBT | "Debt" + +## Enum: SourceEnum + +Name | Value +---- | ----- +SCREENINGEXPRESSIONUNIVERSE | "ScreeningExpressionUniverse" +UNIVERSALSCREENUNIVERSE | "UniversalScreenUniverse" +IDENTIFIERUNIVERSE | "IdentifierUniverse" + + ## Implemented Interfaces * Serializable diff --git a/auto-generated-sdk/docs/QuantIdentifierUniverseObsolete.md b/auto-generated-sdk/docs/QuantIdentifierUniverseObsolete.md new file mode 100644 index 00000000..383c9dd1 --- /dev/null +++ b/auto-generated-sdk/docs/QuantIdentifierUniverseObsolete.md @@ -0,0 +1,38 @@ + + +# QuantIdentifierUniverseObsolete + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**universeType** | [**UniverseTypeEnum**](#UniverseTypeEnum) | | +**identifiers** | **java.util.List<String>** | | +**source** | [**SourceEnum**](#SourceEnum) | | [optional] + + + +## Enum: UniverseTypeEnum + +Name | Value +---- | ----- +EQUITY | "Equity" +DEBT | "Debt" + + + +## Enum: SourceEnum + +Name | Value +---- | ----- +SCREENINGEXPRESSIONUNIVERSE | "ScreeningExpressionUniverse" +UNIVERSALSCREENUNIVERSE | "UniversalScreenUniverse" +IDENTIFIERUNIVERSE | "IdentifierUniverse" + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/QuantScreeningExpression.md b/auto-generated-sdk/docs/QuantScreeningExpression.md index 842f44af..512a0112 100644 --- a/auto-generated-sdk/docs/QuantScreeningExpression.md +++ b/auto-generated-sdk/docs/QuantScreeningExpression.md @@ -9,6 +9,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **expr** | **String** | | **name** | **String** | | +**source** | [**SourceEnum**](#SourceEnum) | | + + + +## Enum: SourceEnum + +Name | Value +---- | ----- +SCREENINGEXPRESSION | "ScreeningExpression" +FQLEXPRESSION | "FqlExpression" +UNIVERSALSCREENPARAMETER | "UniversalScreenParameter" +ALLUNIVERSALSCREENPARAMETERS | "AllUniversalScreenParameters" ## Implemented Interfaces diff --git a/auto-generated-sdk/docs/QuantScreeningExpressionObsolete.md b/auto-generated-sdk/docs/QuantScreeningExpressionObsolete.md new file mode 100644 index 00000000..320e00c6 --- /dev/null +++ b/auto-generated-sdk/docs/QuantScreeningExpressionObsolete.md @@ -0,0 +1,18 @@ + + +# QuantScreeningExpressionObsolete + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**expr** | **String** | | +**name** | **String** | | + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/QuantScreeningExpressionUniverse.md b/auto-generated-sdk/docs/QuantScreeningExpressionUniverse.md index 3229db9f..058748ce 100644 --- a/auto-generated-sdk/docs/QuantScreeningExpressionUniverse.md +++ b/auto-generated-sdk/docs/QuantScreeningExpressionUniverse.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **universeExpr** | **String** | | **universeType** | [**UniverseTypeEnum**](#UniverseTypeEnum) | | **securityExpr** | **String** | | [optional] +**source** | [**SourceEnum**](#SourceEnum) | | @@ -21,6 +22,16 @@ EQUITY | "Equity" DEBT | "Debt" + +## Enum: SourceEnum + +Name | Value +---- | ----- +SCREENINGEXPRESSIONUNIVERSE | "ScreeningExpressionUniverse" +UNIVERSALSCREENUNIVERSE | "UniversalScreenUniverse" +IDENTIFIERUNIVERSE | "IdentifierUniverse" + + ## Implemented Interfaces * Serializable diff --git a/auto-generated-sdk/docs/QuantScreeningExpressionUniverseObsolete.md b/auto-generated-sdk/docs/QuantScreeningExpressionUniverseObsolete.md new file mode 100644 index 00000000..d63e2df6 --- /dev/null +++ b/auto-generated-sdk/docs/QuantScreeningExpressionUniverseObsolete.md @@ -0,0 +1,39 @@ + + +# QuantScreeningExpressionUniverseObsolete + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**universeExpr** | **String** | | +**universeType** | [**UniverseTypeEnum**](#UniverseTypeEnum) | | +**securityExpr** | **String** | | [optional] +**source** | [**SourceEnum**](#SourceEnum) | | [optional] + + + +## Enum: UniverseTypeEnum + +Name | Value +---- | ----- +EQUITY | "Equity" +DEBT | "Debt" + + + +## Enum: SourceEnum + +Name | Value +---- | ----- +SCREENINGEXPRESSIONUNIVERSE | "ScreeningExpressionUniverse" +UNIVERSALSCREENUNIVERSE | "UniversalScreenUniverse" +IDENTIFIERUNIVERSE | "IdentifierUniverse" + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/QuantUniversalScreenParameter.md b/auto-generated-sdk/docs/QuantUniversalScreenParameter.md index f26f8ebb..aa961708 100644 --- a/auto-generated-sdk/docs/QuantUniversalScreenParameter.md +++ b/auto-generated-sdk/docs/QuantUniversalScreenParameter.md @@ -9,6 +9,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **referenceName** | **String** | | **name** | **String** | | +**source** | [**SourceEnum**](#SourceEnum) | | + + + +## Enum: SourceEnum + +Name | Value +---- | ----- +SCREENINGEXPRESSION | "ScreeningExpression" +FQLEXPRESSION | "FqlExpression" +UNIVERSALSCREENPARAMETER | "UniversalScreenParameter" +ALLUNIVERSALSCREENPARAMETERS | "AllUniversalScreenParameters" ## Implemented Interfaces diff --git a/auto-generated-sdk/docs/QuantUniversalScreenParameterObsolete.md b/auto-generated-sdk/docs/QuantUniversalScreenParameterObsolete.md new file mode 100644 index 00000000..8a817724 --- /dev/null +++ b/auto-generated-sdk/docs/QuantUniversalScreenParameterObsolete.md @@ -0,0 +1,18 @@ + + +# QuantUniversalScreenParameterObsolete + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**referenceName** | **String** | | +**name** | **String** | | + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/QuantUniversalScreenUniverse.md b/auto-generated-sdk/docs/QuantUniversalScreenUniverse.md index c903211b..604ac07a 100644 --- a/auto-generated-sdk/docs/QuantUniversalScreenUniverse.md +++ b/auto-generated-sdk/docs/QuantUniversalScreenUniverse.md @@ -8,6 +8,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **screen** | **String** | | +**source** | [**SourceEnum**](#SourceEnum) | | + + + +## Enum: SourceEnum + +Name | Value +---- | ----- +SCREENINGEXPRESSIONUNIVERSE | "ScreeningExpressionUniverse" +UNIVERSALSCREENUNIVERSE | "UniversalScreenUniverse" +IDENTIFIERUNIVERSE | "IdentifierUniverse" ## Implemented Interfaces diff --git a/auto-generated-sdk/docs/QuantUniversalScreenUniverseObsolete.md b/auto-generated-sdk/docs/QuantUniversalScreenUniverseObsolete.md new file mode 100644 index 00000000..0b9214c3 --- /dev/null +++ b/auto-generated-sdk/docs/QuantUniversalScreenUniverseObsolete.md @@ -0,0 +1,28 @@ + + +# QuantUniversalScreenUniverseObsolete + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**screen** | **String** | | +**source** | [**SourceEnum**](#SourceEnum) | | [optional] + + + +## Enum: SourceEnum + +Name | Value +---- | ----- +SCREENINGEXPRESSIONUNIVERSE | "ScreeningExpressionUniverse" +UNIVERSALSCREENUNIVERSE | "UniversalScreenUniverse" +IDENTIFIERUNIVERSE | "IdentifierUniverse" + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/QuantUniverse.md b/auto-generated-sdk/docs/QuantUniverse.md new file mode 100644 index 00000000..76b1f8bd --- /dev/null +++ b/auto-generated-sdk/docs/QuantUniverse.md @@ -0,0 +1,27 @@ + + +# QuantUniverse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | [**SourceEnum**](#SourceEnum) | | + + + +## Enum: SourceEnum + +Name | Value +---- | ----- +SCREENINGEXPRESSIONUNIVERSE | "ScreeningExpressionUniverse" +UNIVERSALSCREENUNIVERSE | "UniversalScreenUniverse" +IDENTIFIERUNIVERSE | "IdentifierUniverse" + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/ReturnType.md b/auto-generated-sdk/docs/ReturnType.md new file mode 100644 index 00000000..0951e50d --- /dev/null +++ b/auto-generated-sdk/docs/ReturnType.md @@ -0,0 +1,18 @@ + + +# ReturnType + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | | [optional] +**id** | **String** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/SPARAccounts.md b/auto-generated-sdk/docs/SPARAccounts.md new file mode 100644 index 00000000..597adf65 --- /dev/null +++ b/auto-generated-sdk/docs/SPARAccounts.md @@ -0,0 +1,17 @@ + + +# SPARAccounts + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**returnsType** | [**java.util.List<ReturnType>**](ReturnType.md) | List of SPAR returnsType | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/SPARAccountsRoot.md b/auto-generated-sdk/docs/SPARAccountsRoot.md new file mode 100644 index 00000000..d33075ac --- /dev/null +++ b/auto-generated-sdk/docs/SPARAccountsRoot.md @@ -0,0 +1,18 @@ + + +# SPARAccountsRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**SPARAccounts**](SPARAccounts.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplateContentTypes.md b/auto-generated-sdk/docs/TemplateContentTypes.md new file mode 100644 index 00000000..bd7fffe3 --- /dev/null +++ b/auto-generated-sdk/docs/TemplateContentTypes.md @@ -0,0 +1,19 @@ + + +# TemplateContentTypes + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mandatory** | **java.util.List<String>** | Template mandatory fields | [optional] +**optional** | **java.util.List<String>** | Template optional fields | [optional] +**locked** | **java.util.List<String>** | Template locked fields | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponent.md b/auto-generated-sdk/docs/TemplatedPAComponent.md new file mode 100644 index 00000000..9807c2d7 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponent.md @@ -0,0 +1,24 @@ + + +# TemplatedPAComponent + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | [optional] +**directory** | **String** | | [optional] +**snapshot** | **Boolean** | | [optional] +**componentData** | [**PAComponentData**](PAComponentData.md) | | [optional] +**description** | **String** | | [optional] +**name** | **String** | | [optional] +**parentTemplateId** | **String** | | [optional] +**type** | **String** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentParameters.md b/auto-generated-sdk/docs/TemplatedPAComponentParameters.md new file mode 100644 index 00000000..d8ee233a --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentParameters.md @@ -0,0 +1,20 @@ + + +# TemplatedPAComponentParameters + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**directory** | **String** | Directory to create templated components | +**parentTemplateId** | **String** | Parent template id | +**description** | **String** | Component description. | [optional] +**componentData** | [**PAComponentData**](PAComponentData.md) | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentParametersRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentParametersRoot.md new file mode 100644 index 00000000..3962efcc --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentParametersRoot.md @@ -0,0 +1,18 @@ + + +# TemplatedPAComponentParametersRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**TemplatedPAComponentParameters**](TemplatedPAComponentParameters.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentPostSummary.md b/auto-generated-sdk/docs/TemplatedPAComponentPostSummary.md new file mode 100644 index 00000000..b7b275c4 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentPostSummary.md @@ -0,0 +1,21 @@ + + +# TemplatedPAComponentPostSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | [optional] +**description** | **String** | | [optional] +**name** | **String** | | [optional] +**parentTemplateId** | **String** | | [optional] +**type** | **String** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentPostSummaryRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentPostSummaryRoot.md new file mode 100644 index 00000000..26470db3 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentPostSummaryRoot.md @@ -0,0 +1,18 @@ + + +# TemplatedPAComponentPostSummaryRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**TemplatedPAComponentPostSummary**](TemplatedPAComponentPostSummary.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentRoot.md new file mode 100644 index 00000000..5c49c451 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentRoot.md @@ -0,0 +1,18 @@ + + +# TemplatedPAComponentRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**TemplatedPAComponent**](TemplatedPAComponent.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentSummary.md b/auto-generated-sdk/docs/TemplatedPAComponentSummary.md new file mode 100644 index 00000000..ca4d272c --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentSummary.md @@ -0,0 +1,20 @@ + + +# TemplatedPAComponentSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **String** | | [optional] +**name** | **String** | | [optional] +**parentTemplateId** | **String** | | [optional] +**type** | **String** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentSummaryRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentSummaryRoot.md new file mode 100644 index 00000000..2c872ec6 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentSummaryRoot.md @@ -0,0 +1,18 @@ + + +# TemplatedPAComponentSummaryRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**Map<String, TemplatedPAComponentSummary>**](TemplatedPAComponentSummary.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentUpdateParameters.md b/auto-generated-sdk/docs/TemplatedPAComponentUpdateParameters.md new file mode 100644 index 00000000..5aa26595 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentUpdateParameters.md @@ -0,0 +1,19 @@ + + +# TemplatedPAComponentUpdateParameters + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**parentTemplateId** | **String** | Parent template id | [optional] +**description** | **String** | Component description. | [optional] +**componentData** | [**PAComponentData**](PAComponentData.md) | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentUpdateParametersRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentUpdateParametersRoot.md new file mode 100644 index 00000000..120428e3 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentUpdateParametersRoot.md @@ -0,0 +1,18 @@ + + +# TemplatedPAComponentUpdateParametersRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**TemplatedPAComponentUpdateParameters**](TemplatedPAComponentUpdateParameters.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/TemplatedPaComponentsApi.md b/auto-generated-sdk/docs/TemplatedPaComponentsApi.md new file mode 100644 index 00000000..cf13e030 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPaComponentsApi.md @@ -0,0 +1,445 @@ + +# TemplatedPaComponentsApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createTemplatedPAComponents**](TemplatedPaComponentsApi.md#createTemplatedPAComponents) | **POST** /analytics/engines/pa/v3/templated-components | Create templated PA component +[**deleteTemplatedPAComponents**](TemplatedPaComponentsApi.md#deleteTemplatedPAComponents) | **DELETE** /analytics/engines/pa/v3/templated-components/{id} | Delete templated PA component +[**getTemplatedPAComponentById**](TemplatedPaComponentsApi.md#getTemplatedPAComponentById) | **GET** /analytics/engines/pa/v3/templated-components/{id} | Get templated PA component by id +[**getTemplatedPAComponentsInPath**](TemplatedPaComponentsApi.md#getTemplatedPAComponentsInPath) | **GET** /analytics/engines/pa/v3/templated-components | Get templated PA components in path +[**updateTemplatedPAComponents**](TemplatedPaComponentsApi.md#updateTemplatedPAComponents) | **PUT** /analytics/engines/pa/v3/templated-components/{id} | Update templated PA component + + + +## createTemplatedPAComponents + +> TemplatedPAComponentPostSummaryRoot createTemplatedPAComponents(templatedPAComponentParametersRoot) + +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. + +### Example + +```java +// Import classes: +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.auth.*; +import factset.analyticsapi.engines.model.*; +import factset.analyticsapi.engines.api.TemplatedPaComponentsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.factset.com"); + + // Configure HTTP basic authorization: Basic + HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); + Basic.setUsername("YOUR USERNAME"); + Basic.setPassword("YOUR PASSWORD"); + + // Configure HTTP bearer authorization: Bearer + HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer"); + Bearer.setBearerToken("BEARER TOKEN"); + + TemplatedPaComponentsApi apiInstance = new TemplatedPaComponentsApi(defaultClient); + TemplatedPAComponentParametersRoot templatedPAComponentParametersRoot = new TemplatedPAComponentParametersRoot(); // TemplatedPAComponentParametersRoot | Request Parameters + try { + TemplatedPAComponentPostSummaryRoot result = apiInstance.createTemplatedPAComponents(templatedPAComponentParametersRoot); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TemplatedPaComponentsApi#createTemplatedPAComponents"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getClientErrorResponse()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **templatedPAComponentParametersRoot** | [**TemplatedPAComponentParametersRoot**](TemplatedPAComponentParametersRoot.md)| Request Parameters | + +### Return type + +[**TemplatedPAComponentPostSummaryRoot**](TemplatedPAComponentPostSummaryRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: text/plain, application/json, text/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **201** | Expected response, templated PA component created successfully. | * 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 data provided. Please check the request parameters before attempting again. | * 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** | Template 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.
| +| **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.
| + + +## deleteTemplatedPAComponents + +> deleteTemplatedPAComponents(id) + +Delete templated PA component + +This endpoint deletes an existing templated PA component + +### Example + +```java +// Import classes: +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.auth.*; +import factset.analyticsapi.engines.model.*; +import factset.analyticsapi.engines.api.TemplatedPaComponentsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.factset.com"); + + // Configure HTTP basic authorization: Basic + HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); + Basic.setUsername("YOUR USERNAME"); + Basic.setPassword("YOUR PASSWORD"); + + // Configure HTTP bearer authorization: Bearer + HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer"); + Bearer.setBearerToken("BEARER TOKEN"); + + TemplatedPaComponentsApi apiInstance = new TemplatedPaComponentsApi(defaultClient); + String id = "id_example"; // String | Unique identifier for a templated PA component + try { + apiInstance.deleteTemplatedPAComponents(id); + } catch (ApiException e) { + System.err.println("Exception when calling TemplatedPaComponentsApi#deleteTemplatedPAComponents"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getClientErrorResponse()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| Unique identifier for a templated PA component | + +### Return type + +null (empty response body) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/plain, application/json, text/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Expected response, deleted the templated PA component successfully. | * 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 data provided. Please check the request parameters before attempting again. | * 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.
| + + +## getTemplatedPAComponentById + +> TemplatedPAComponentRoot getTemplatedPAComponentById(id) + +Get templated PA component by id + +This endpoint fetches the templated PA component settings. + +### Example + +```java +// Import classes: +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.auth.*; +import factset.analyticsapi.engines.model.*; +import factset.analyticsapi.engines.api.TemplatedPaComponentsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.factset.com"); + + // Configure HTTP basic authorization: Basic + HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); + Basic.setUsername("YOUR USERNAME"); + Basic.setPassword("YOUR PASSWORD"); + + // Configure HTTP bearer authorization: Bearer + HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer"); + Bearer.setBearerToken("BEARER TOKEN"); + + TemplatedPaComponentsApi apiInstance = new TemplatedPaComponentsApi(defaultClient); + String id = "id_example"; // String | Unique identifier for a templated PA component + try { + TemplatedPAComponentRoot result = apiInstance.getTemplatedPAComponentById(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TemplatedPaComponentsApi#getTemplatedPAComponentById"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getClientErrorResponse()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| Unique identifier for a templated PA component | + +### Return type + +[**TemplatedPAComponentRoot**](TemplatedPAComponentRoot.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, templated PA component details. | * 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 data provided. Please check the request parameters before attempting again. | * 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** | Templated PA 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.
| + + +## getTemplatedPAComponentsInPath + +> TemplatedPAComponentSummaryRoot getTemplatedPAComponentsInPath(directory) + +Get templated PA components in path + +This endpoint returns the list of templated PA components in path. + +### Example + +```java +// Import classes: +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.auth.*; +import factset.analyticsapi.engines.model.*; +import factset.analyticsapi.engines.api.TemplatedPaComponentsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.factset.com"); + + // Configure HTTP basic authorization: Basic + HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); + Basic.setUsername("YOUR USERNAME"); + Basic.setPassword("YOUR PASSWORD"); + + // Configure HTTP bearer authorization: Bearer + HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer"); + Bearer.setBearerToken("BEARER TOKEN"); + + TemplatedPaComponentsApi apiInstance = new TemplatedPaComponentsApi(defaultClient); + String directory = "directory_example"; // String | Get templated PA components in path + try { + TemplatedPAComponentSummaryRoot result = apiInstance.getTemplatedPAComponentsInPath(directory); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TemplatedPaComponentsApi#getTemplatedPAComponentsInPath"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getClientErrorResponse()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **directory** | **String**| Get templated PA components in path | + +### Return type + +[**TemplatedPAComponentSummaryRoot**](TemplatedPAComponentSummaryRoot.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 a list templated PA components. | * 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 data provided. Please check the request parameters before attempting again. | * 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.
| + + +## updateTemplatedPAComponents + +> TemplatedPAComponentPostSummaryRoot updateTemplatedPAComponents(id, templatedPAComponentUpdateParametersRoot) + +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. + +### Example + +```java +// Import classes: +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.auth.*; +import factset.analyticsapi.engines.model.*; +import factset.analyticsapi.engines.api.TemplatedPaComponentsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.factset.com"); + + // Configure HTTP basic authorization: Basic + HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); + Basic.setUsername("YOUR USERNAME"); + Basic.setPassword("YOUR PASSWORD"); + + // Configure HTTP bearer authorization: Bearer + HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer"); + Bearer.setBearerToken("BEARER TOKEN"); + + TemplatedPaComponentsApi apiInstance = new TemplatedPaComponentsApi(defaultClient); + String id = "id_example"; // String | Unique identifier for a templated PA component + TemplatedPAComponentUpdateParametersRoot templatedPAComponentUpdateParametersRoot = new TemplatedPAComponentUpdateParametersRoot(); // TemplatedPAComponentUpdateParametersRoot | Request Parameters + try { + TemplatedPAComponentPostSummaryRoot result = apiInstance.updateTemplatedPAComponents(id, templatedPAComponentUpdateParametersRoot); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TemplatedPaComponentsApi#updateTemplatedPAComponents"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getClientErrorResponse()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| Unique identifier for a templated PA component | + **templatedPAComponentUpdateParametersRoot** | [**TemplatedPAComponentUpdateParametersRoot**](TemplatedPAComponentUpdateParametersRoot.md)| Request Parameters | + +### Return type + +[**TemplatedPAComponentPostSummaryRoot**](TemplatedPAComponentPostSummaryRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Expected response, updated successfully. | * 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 data provided. Please check the request parameters before attempting again. | * 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 or template 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.
| + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplate.md b/auto-generated-sdk/docs/UnlinkedPATemplate.md new file mode 100644 index 00000000..f6cb517a --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplate.md @@ -0,0 +1,31 @@ + + +# UnlinkedPATemplate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | Template id. | [optional] +**directory** | **String** | Template directory. | [optional] +**templateTypeId** | **String** | Template type id | [optional] +**snapshot** | **Boolean** | snapshot. | [optional] +**accounts** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of accounts | [optional] +**benchmarks** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of benchmarks | [optional] +**columns** | [**java.util.List<PACalculationColumn>**](PACalculationColumn.md) | List of columns for the PA calculation | [optional] +**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] +**groups** | [**java.util.List<PACalculationGroup>**](PACalculationGroup.md) | List of groupings for the PA calculation | [optional] +**currencyisocode** | **String** | Currency ISO code for calculation. | [optional] +**componentdetail** | **String** | PA storage type. It can be GROUPS or TOTALS or SECURITIES. | [optional] +**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] +**description** | **String** | Template description. | [optional] +**name** | **String** | Template name. | [optional] +**category** | **String** | Unlinked template category | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndType.md b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndType.md new file mode 100644 index 00000000..57284683 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndType.md @@ -0,0 +1,18 @@ + + +# UnlinkedPATemplateCategoryAndType + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**category** | **String** | Unlinked template category | [optional] +**name** | **String** | Unlinked template type | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetails.md b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetails.md new file mode 100644 index 00000000..74d9792b --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetails.md @@ -0,0 +1,22 @@ + + +# UnlinkedPATemplateCategoryAndTypeDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | Type Id | [optional] +**columns** | [**java.util.List<UnlinkedPATemplateColumnDetails>**](UnlinkedPATemplateColumnDetails.md) | List of default columns | [optional] +**groups** | [**java.util.List<UnlinkedPATemplateGroupDetails>**](UnlinkedPATemplateGroupDetails.md) | List of default groupings | [optional] +**snapshot** | **Boolean** | Snapshot | [optional] +**category** | **String** | Unlinked template category | [optional] +**name** | **String** | Unlinked template type | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md new file mode 100644 index 00000000..a402f96d --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md @@ -0,0 +1,18 @@ + + +# UnlinkedPATemplateCategoryAndTypeDetailsRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**UnlinkedPATemplateCategoryAndTypeDetails**](UnlinkedPATemplateCategoryAndTypeDetails.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeRoot.md new file mode 100644 index 00000000..577c8681 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeRoot.md @@ -0,0 +1,18 @@ + + +# UnlinkedPATemplateCategoryAndTypeRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**Map<String, UnlinkedPATemplateCategoryAndType>**](UnlinkedPATemplateCategoryAndType.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateColumnDetails.md b/auto-generated-sdk/docs/UnlinkedPATemplateColumnDetails.md new file mode 100644 index 00000000..6c4cc890 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateColumnDetails.md @@ -0,0 +1,19 @@ + + +# UnlinkedPATemplateColumnDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | Unlinked template column name | [optional] +**id** | **String** | FactSet-defined or User-defined Column identifier. | [optional] +**statistics** | **java.util.List<String>** | Column Statistic identifier | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateGroupDetails.md b/auto-generated-sdk/docs/UnlinkedPATemplateGroupDetails.md new file mode 100644 index 00000000..901faa42 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateGroupDetails.md @@ -0,0 +1,18 @@ + + +# UnlinkedPATemplateGroupDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | Unlinked template group name | [optional] +**id** | **String** | FactSet-defined or User-defined Group identifier. | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md b/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md new file mode 100644 index 00000000..c19070c0 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md @@ -0,0 +1,27 @@ + + +# UnlinkedPATemplateParameters + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**directory** | **String** | The directory to create an unlinked PA template | +**templateTypeId** | **String** | Template type id | +**description** | **String** | Template description | [optional] +**accounts** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of accounts | [optional] +**benchmarks** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of benchmarks | [optional] +**columns** | [**java.util.List<PACalculationColumn>**](PACalculationColumn.md) | List of columns for the PA calculation | [optional] +**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] +**groups** | [**java.util.List<PACalculationGroup>**](PACalculationGroup.md) | List of groupings for the PA calculation | [optional] +**currencyisocode** | **String** | Currency ISO code for calculation. | [optional] +**componentdetail** | **String** | PA storage type. It can be GROUPS or TOTALS or SECURITIES. | [optional] +**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateParametersRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateParametersRoot.md new file mode 100644 index 00000000..7f89e17d --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateParametersRoot.md @@ -0,0 +1,18 @@ + + +# UnlinkedPATemplateParametersRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**UnlinkedPATemplateParameters**](UnlinkedPATemplateParameters.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplatePostSummary.md b/auto-generated-sdk/docs/UnlinkedPATemplatePostSummary.md new file mode 100644 index 00000000..4ba7f514 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplatePostSummary.md @@ -0,0 +1,20 @@ + + +# UnlinkedPATemplatePostSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | Template id. | [optional] +**description** | **String** | Template description. | [optional] +**name** | **String** | Template name. | [optional] +**category** | **String** | Unlinked template category | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplatePostSummaryRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplatePostSummaryRoot.md new file mode 100644 index 00000000..6f488e6e --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplatePostSummaryRoot.md @@ -0,0 +1,18 @@ + + +# UnlinkedPATemplatePostSummaryRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**UnlinkedPATemplatePostSummary**](UnlinkedPATemplatePostSummary.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateRoot.md new file mode 100644 index 00000000..2821b693 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateRoot.md @@ -0,0 +1,18 @@ + + +# UnlinkedPATemplateRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**UnlinkedPATemplate**](UnlinkedPATemplate.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateSummary.md b/auto-generated-sdk/docs/UnlinkedPATemplateSummary.md new file mode 100644 index 00000000..879862c1 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateSummary.md @@ -0,0 +1,19 @@ + + +# UnlinkedPATemplateSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **String** | Template description. | [optional] +**name** | **String** | Template name. | [optional] +**category** | **String** | Unlinked template category | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateSummaryRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateSummaryRoot.md new file mode 100644 index 00000000..79061ec3 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateSummaryRoot.md @@ -0,0 +1,18 @@ + + +# UnlinkedPATemplateSummaryRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**Map<String, UnlinkedPATemplateSummary>**](UnlinkedPATemplateSummary.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md b/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md new file mode 100644 index 00000000..5438cfd4 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md @@ -0,0 +1,25 @@ + + +# UnlinkedPATemplateUpdateParameters + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **String** | Template description | [optional] +**accounts** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of accounts | [optional] +**benchmarks** | [**java.util.List<PAIdentifier>**](PAIdentifier.md) | List of benchmarks | [optional] +**columns** | [**java.util.List<PACalculationColumn>**](PACalculationColumn.md) | List of columns for the PA calculation | [optional] +**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] +**groups** | [**java.util.List<PACalculationGroup>**](PACalculationGroup.md) | List of groupings for the PA calculation | [optional] +**currencyisocode** | **String** | Currency ISO code for calculation. | [optional] +**componentdetail** | **String** | PA storage type. It can be GROUPS or TOTALS or SECURITIES. | [optional] +**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParametersRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParametersRoot.md new file mode 100644 index 00000000..61284b1f --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParametersRoot.md @@ -0,0 +1,18 @@ + + +# UnlinkedPATemplateUpdateParametersRoot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**UnlinkedPATemplateUpdateParameters**](UnlinkedPATemplateUpdateParameters.md) | | +**meta** | **Object** | | [optional] + + +## Implemented Interfaces + +* Serializable + + diff --git a/auto-generated-sdk/docs/UnlinkedPaTemplatesApi.md b/auto-generated-sdk/docs/UnlinkedPaTemplatesApi.md new file mode 100644 index 00000000..74990040 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPaTemplatesApi.md @@ -0,0 +1,626 @@ + +# UnlinkedPaTemplatesApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createUnlinkedPATemplates**](UnlinkedPaTemplatesApi.md#createUnlinkedPATemplates) | **POST** /analytics/engines/pa/v3/unlinked-templates | Create unlinked PA template +[**deleteUnlinkedPATemplates**](UnlinkedPaTemplatesApi.md#deleteUnlinkedPATemplates) | **DELETE** /analytics/engines/pa/v3/unlinked-templates/{id} | Delete unlinked PA template +[**getDefaultUnlinkedPATemplateTypes**](UnlinkedPaTemplatesApi.md#getDefaultUnlinkedPATemplateTypes) | **GET** /analytics/engines/pa/v3/unlinked-templates/template-types | Get default unlinked PA template types. +[**getDetailsType**](UnlinkedPaTemplatesApi.md#getDetailsType) | **GET** /analytics/engines/pa/v3/unlinked-templates/template-types/{id} | Get unlinked PA template type details by id. +[**getUnlinkedPATemplates**](UnlinkedPaTemplatesApi.md#getUnlinkedPATemplates) | **GET** /analytics/engines/pa/v3/unlinked-templates | Get unlinked PA templates +[**getUnlinkedPATemplatesById**](UnlinkedPaTemplatesApi.md#getUnlinkedPATemplatesById) | **GET** /analytics/engines/pa/v3/unlinked-templates/{id} | Get unlinked PA template details by id +[**updateUnlinkedPATemplates**](UnlinkedPaTemplatesApi.md#updateUnlinkedPATemplates) | **PUT** /analytics/engines/pa/v3/unlinked-templates/{id} | Update unlinked PA template + + + +## createUnlinkedPATemplates + +> UnlinkedPATemplatePostSummaryRoot createUnlinkedPATemplates(unlinkedPATemplateParametersRoot) + +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", "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. + +### Example + +```java +// Import classes: +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.auth.*; +import factset.analyticsapi.engines.model.*; +import factset.analyticsapi.engines.api.UnlinkedPaTemplatesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.factset.com"); + + // Configure HTTP basic authorization: Basic + HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); + Basic.setUsername("YOUR USERNAME"); + Basic.setPassword("YOUR PASSWORD"); + + // Configure HTTP bearer authorization: Bearer + HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer"); + Bearer.setBearerToken("BEARER TOKEN"); + + UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient); + UnlinkedPATemplateParametersRoot unlinkedPATemplateParametersRoot = new UnlinkedPATemplateParametersRoot(); // UnlinkedPATemplateParametersRoot | Request Parameters + try { + UnlinkedPATemplatePostSummaryRoot result = apiInstance.createUnlinkedPATemplates(unlinkedPATemplateParametersRoot); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UnlinkedPaTemplatesApi#createUnlinkedPATemplates"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getClientErrorResponse()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **unlinkedPATemplateParametersRoot** | [**UnlinkedPATemplateParametersRoot**](UnlinkedPATemplateParametersRoot.md)| Request Parameters | + +### Return type + +[**UnlinkedPATemplatePostSummaryRoot**](UnlinkedPATemplatePostSummaryRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **201** | Expected response, created a unlinked PA template. | * 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 data provided. Please check the request parameters before attempting again. | * 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.
| + + +## deleteUnlinkedPATemplates + +> deleteUnlinkedPATemplates(id) + +Delete unlinked PA template + +This endpoint deletes an existing unliked PA template. + +### Example + +```java +// Import classes: +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.auth.*; +import factset.analyticsapi.engines.model.*; +import factset.analyticsapi.engines.api.UnlinkedPaTemplatesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.factset.com"); + + // Configure HTTP basic authorization: Basic + HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); + Basic.setUsername("YOUR USERNAME"); + Basic.setPassword("YOUR PASSWORD"); + + // Configure HTTP bearer authorization: Bearer + HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer"); + Bearer.setBearerToken("BEARER TOKEN"); + + UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient); + String id = "id_example"; // String | Unique identifier for an unlinked PA template + try { + apiInstance.deleteUnlinkedPATemplates(id); + } catch (ApiException e) { + System.err.println("Exception when calling UnlinkedPaTemplatesApi#deleteUnlinkedPATemplates"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getClientErrorResponse()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| Unique identifier for an unlinked PA template | + +### Return type + +null (empty response body) + +### 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 | +|-------------|-------------|------------------| +| **204** | Expected response, deleted the unlinked PA template successfully. | * 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 data provided. Please check the request parameters before attempting again. | * 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** | Template 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.
| + + +## getDefaultUnlinkedPATemplateTypes + +> UnlinkedPATemplateCategoryAndTypeRoot getDefaultUnlinkedPATemplateTypes() + +Get default unlinked PA template types. + +This endpoint fetches default unlinked PA template types. + +### Example + +```java +// Import classes: +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.auth.*; +import factset.analyticsapi.engines.model.*; +import factset.analyticsapi.engines.api.UnlinkedPaTemplatesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.factset.com"); + + // Configure HTTP basic authorization: Basic + HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); + Basic.setUsername("YOUR USERNAME"); + Basic.setPassword("YOUR PASSWORD"); + + // Configure HTTP bearer authorization: Bearer + HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer"); + Bearer.setBearerToken("BEARER TOKEN"); + + UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient); + try { + UnlinkedPATemplateCategoryAndTypeRoot result = apiInstance.getDefaultUnlinkedPATemplateTypes(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UnlinkedPaTemplatesApi#getDefaultUnlinkedPATemplateTypes"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getClientErrorResponse()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**UnlinkedPATemplateCategoryAndTypeRoot**](UnlinkedPATemplateCategoryAndTypeRoot.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, default unlinked PA template types | * 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.
| + + +## getDetailsType + +> UnlinkedPATemplateCategoryAndTypeDetailsRoot getDetailsType(id) + +Get unlinked PA template type details by id. + +This endpoint fetches the unlinked PA template type details. + +### Example + +```java +// Import classes: +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.auth.*; +import factset.analyticsapi.engines.model.*; +import factset.analyticsapi.engines.api.UnlinkedPaTemplatesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.factset.com"); + + // Configure HTTP basic authorization: Basic + HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); + Basic.setUsername("YOUR USERNAME"); + Basic.setPassword("YOUR PASSWORD"); + + // Configure HTTP bearer authorization: Bearer + HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer"); + Bearer.setBearerToken("BEARER TOKEN"); + + UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient); + String id = "id_example"; // String | Unique identifier for an unlinked PA template type + try { + UnlinkedPATemplateCategoryAndTypeDetailsRoot result = apiInstance.getDetailsType(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UnlinkedPaTemplatesApi#getDetailsType"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getClientErrorResponse()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| Unique identifier for an unlinked PA template type | + +### Return type + +[**UnlinkedPATemplateCategoryAndTypeDetailsRoot**](UnlinkedPATemplateCategoryAndTypeDetailsRoot.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, details of the unlinked PA template type | * 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 data provided. Please check the request parameters before attempting again. | * 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** | Unlinked PA template type 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.
| + + +## getUnlinkedPATemplates + +> UnlinkedPATemplateSummaryRoot getUnlinkedPATemplates(directory, category) + +Get unlinked PA templates + +This endpoint returns the list of unlinked PA templates. + +### Example + +```java +// Import classes: +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.auth.*; +import factset.analyticsapi.engines.model.*; +import factset.analyticsapi.engines.api.UnlinkedPaTemplatesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.factset.com"); + + // Configure HTTP basic authorization: Basic + HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); + Basic.setUsername("YOUR USERNAME"); + Basic.setPassword("YOUR PASSWORD"); + + // Configure HTTP bearer authorization: Bearer + HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer"); + Bearer.setBearerToken("BEARER TOKEN"); + + UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient); + String directory = "directory_example"; // String | Get unlinked PA templates in path. + String category = "category_example"; // String | Get unlinked PA templates by category. + try { + UnlinkedPATemplateSummaryRoot result = apiInstance.getUnlinkedPATemplates(directory, category); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UnlinkedPaTemplatesApi#getUnlinkedPATemplates"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getClientErrorResponse()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **directory** | **String**| Get unlinked PA templates in path. | [optional] + **category** | **String**| Get unlinked PA templates by category. | [optional] + +### Return type + +[**UnlinkedPATemplateSummaryRoot**](UnlinkedPATemplateSummaryRoot.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 a list of unlinked PA templates. | * 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 data provided. Please check the request parameters before attempting again. | * 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.
| + + +## getUnlinkedPATemplatesById + +> UnlinkedPATemplateRoot getUnlinkedPATemplatesById(id) + +Get unlinked PA template details by id + +This endpoint fetches the template settings. + +### Example + +```java +// Import classes: +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.auth.*; +import factset.analyticsapi.engines.model.*; +import factset.analyticsapi.engines.api.UnlinkedPaTemplatesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.factset.com"); + + // Configure HTTP basic authorization: Basic + HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); + Basic.setUsername("YOUR USERNAME"); + Basic.setPassword("YOUR PASSWORD"); + + // Configure HTTP bearer authorization: Bearer + HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer"); + Bearer.setBearerToken("BEARER TOKEN"); + + UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient); + String id = "id_example"; // String | Unique identifier for an unlinked PA template + try { + UnlinkedPATemplateRoot result = apiInstance.getUnlinkedPATemplatesById(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UnlinkedPaTemplatesApi#getUnlinkedPATemplatesById"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getClientErrorResponse()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| Unique identifier for an unlinked PA template | + +### Return type + +[**UnlinkedPATemplateRoot**](UnlinkedPATemplateRoot.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, get details of the unlinked PA template. | * 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 data provided. Please check the request parameters before attempting again. | * 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** | Template 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.
| + + +## updateUnlinkedPATemplates + +> UnlinkedPATemplatePostSummaryRoot updateUnlinkedPATemplates(id, unlinkedPATemplateUpdateParametersRoot) + +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", "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. + +### Example + +```java +// Import classes: +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.auth.*; +import factset.analyticsapi.engines.model.*; +import factset.analyticsapi.engines.api.UnlinkedPaTemplatesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.factset.com"); + + // Configure HTTP basic authorization: Basic + HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); + Basic.setUsername("YOUR USERNAME"); + Basic.setPassword("YOUR PASSWORD"); + + // Configure HTTP bearer authorization: Bearer + HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer"); + Bearer.setBearerToken("BEARER TOKEN"); + + UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient); + String id = "id_example"; // String | Unique identifier for an unlinked PA template + UnlinkedPATemplateUpdateParametersRoot unlinkedPATemplateUpdateParametersRoot = new UnlinkedPATemplateUpdateParametersRoot(); // UnlinkedPATemplateUpdateParametersRoot | Request Parameters + try { + UnlinkedPATemplatePostSummaryRoot result = apiInstance.updateUnlinkedPATemplates(id, unlinkedPATemplateUpdateParametersRoot); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling UnlinkedPaTemplatesApi#updateUnlinkedPATemplates"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getClientErrorResponse()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| Unique identifier for an unlinked PA template | + **unlinkedPATemplateUpdateParametersRoot** | [**UnlinkedPATemplateUpdateParametersRoot**](UnlinkedPATemplateUpdateParametersRoot.md)| Request Parameters | + +### Return type + +[**UnlinkedPATemplatePostSummaryRoot**](UnlinkedPATemplatePostSummaryRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Expected response, updated the unlinked PA template. | * 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 data provided. Please check the request parameters before attempting again. | * 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** | Template 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.
| + diff --git a/auto-generated-sdk/docs/VaultCalculationParameters.md b/auto-generated-sdk/docs/VaultCalculationParameters.md index ed2a05e1..476728a3 100644 --- a/auto-generated-sdk/docs/VaultCalculationParameters.md +++ b/auto-generated-sdk/docs/VaultCalculationParameters.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **account** | [**VaultIdentifier**](VaultIdentifier.md) | | **dates** | [**VaultDateParameters**](VaultDateParameters.md) | | [optional] **configid** | **String** | Vault Configuration identifier. | -**componentdetail** | **String** | Component detail type for the Vault component. It can be GROUPS or TOTALS. | [optional] +**componentdetail** | **String** | Component detail type for the Vault component. It can be GROUPS or TOTALS or SECURITIES. | [optional] ## Implemented Interfaces diff --git a/auto-generated-sdk/docs/VaultComponent.md b/auto-generated-sdk/docs/VaultComponent.md index 268a1aac..57bc4534 100644 --- a/auto-generated-sdk/docs/VaultComponent.md +++ b/auto-generated-sdk/docs/VaultComponent.md @@ -13,6 +13,7 @@ Name | Type | Description | Notes **currencyisocode** | **String** | Currency iso code saved in the document | [optional] **dates** | [**VaultDateParameters**](VaultDateParameters.md) | | [optional] **snapshot** | **Boolean** | Snapshot | [optional] +**path** | **String** | The path to the document | [optional] **name** | **String** | Component name. | [optional] **category** | **String** | Component category. | [optional] diff --git a/auto-generated-sdk/git_push.sh b/auto-generated-sdk/git_push.sh index ced3be2b..f53a75d4 100644 --- a/auto-generated-sdk/git_push.sh +++ b/auto-generated-sdk/git_push.sh @@ -1,7 +1,7 @@ #!/bin/sh # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ # -# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com" +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" git_user_id=$1 git_repo_id=$2 @@ -38,14 +38,14 @@ git add . git commit -m "$release_note" # Sets the new remote -git_remote=`git remote` +git_remote=$(git remote) if [ "$git_remote" = "" ]; then # git remote not defined if [ "$GIT_TOKEN" = "" ]; then echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git else - git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git fi fi @@ -55,4 +55,3 @@ git pull origin master # Pushes (Forces) the changes in the local repository up to the remote repository echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" git push origin master 2>&1 | grep -v 'To https' - diff --git a/auto-generated-sdk/gradle.properties b/auto-generated-sdk/gradle.properties index 05644f07..a3408578 100644 --- a/auto-generated-sdk/gradle.properties +++ b/auto-generated-sdk/gradle.properties @@ -1,2 +1,6 @@ -# Uncomment to build for Android -#target = android \ No newline at end of file +# This file is automatically generated by OpenAPI Generator (https://github.com/openAPITools/openapi-generator). +# To include other gradle properties as part of the code generation process, please use the `gradleProperties` option. +# +# Gradle properties reference: https://docs.gradle.org/current/userguide/build_environment.html#sec:gradle_configuration_properties +# For example, uncomment below to build for Android +#target = android diff --git a/auto-generated-sdk/gradle/wrapper/gradle-wrapper.jar b/auto-generated-sdk/gradle/wrapper/gradle-wrapper.jar index e708b1c0..7454180f 100644 Binary files a/auto-generated-sdk/gradle/wrapper/gradle-wrapper.jar and b/auto-generated-sdk/gradle/wrapper/gradle-wrapper.jar differ diff --git a/auto-generated-sdk/gradle/wrapper/gradle-wrapper.properties b/auto-generated-sdk/gradle/wrapper/gradle-wrapper.properties index 4d9ca164..ffed3a25 100644 --- a/auto-generated-sdk/gradle/wrapper/gradle-wrapper.properties +++ b/auto-generated-sdk/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,5 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-6.7.1-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/auto-generated-sdk/gradlew b/auto-generated-sdk/gradlew index 4f906e0c..005bcde0 100644 --- a/auto-generated-sdk/gradlew +++ b/auto-generated-sdk/gradlew @@ -1,7 +1,7 @@ -#!/usr/bin/env sh +#!/bin/sh # -# Copyright 2015 the original author or authors. +# Copyright © 2015-2021 the original authors. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -17,67 +17,101 @@ # ############################################################################## -## -## Gradle start up script for UN*X -## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# ############################################################################## # Attempt to set APP_HOME + # Resolve links: $0 may be a link -PRG="$0" -# Need this for relative symlinks. -while [ -h "$PRG" ] ; do - ls=`ls -ld "$PRG"` - link=`expr "$ls" : '.*-> \(.*\)$'` - if expr "$link" : '/.*' > /dev/null; then - PRG="$link" - else - PRG=`dirname "$PRG"`"/$link" - fi +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac done -SAVED="`pwd`" -cd "`dirname \"$PRG\"`/" >/dev/null -APP_HOME="`pwd -P`" -cd "$SAVED" >/dev/null + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit APP_NAME="Gradle" -APP_BASE_NAME=`basename "$0"` +APP_BASE_NAME=${0##*/} # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' +DEFAULT_JVM_OPTS='-Dfile.encoding=UTF-8 "-Xmx64m" "-Xms64m"' # Use the maximum available, or set MAX_FD != -1 to use that value. -MAX_FD="maximum" +MAX_FD=maximum warn () { echo "$*" -} +} >&2 die () { echo echo "$*" echo exit 1 -} +} >&2 # OS specific support (must be 'true' or 'false'). cygwin=false msys=false darwin=false nonstop=false -case "`uname`" in - CYGWIN* ) - cygwin=true - ;; - Darwin* ) - darwin=true - ;; - MINGW* ) - msys=true - ;; - NONSTOP* ) - nonstop=true - ;; +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; esac CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar @@ -87,9 +121,9 @@ CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar if [ -n "$JAVA_HOME" ] ; then if [ -x "$JAVA_HOME/jre/sh/java" ] ; then # IBM's JDK on AIX uses strange locations for the executables - JAVACMD="$JAVA_HOME/jre/sh/java" + JAVACMD=$JAVA_HOME/jre/sh/java else - JAVACMD="$JAVA_HOME/bin/java" + JAVACMD=$JAVA_HOME/bin/java fi if [ ! -x "$JAVACMD" ] ; then die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME @@ -98,7 +132,7 @@ Please set the JAVA_HOME variable in your environment to match the location of your Java installation." fi else - JAVACMD="java" + JAVACMD=java which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. Please set the JAVA_HOME variable in your environment to match the @@ -106,80 +140,95 @@ location of your Java installation." fi # Increase the maximum file descriptors if we can. -if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then - MAX_FD_LIMIT=`ulimit -H -n` - if [ $? -eq 0 ] ; then - if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then - MAX_FD="$MAX_FD_LIMIT" - fi - ulimit -n $MAX_FD - if [ $? -ne 0 ] ; then - warn "Could not set maximum file descriptor limit: $MAX_FD" - fi - else - warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" - fi +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac fi -# For Darwin, add options to specify how the application appears in the dock -if $darwin; then - GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" -fi +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. # For Cygwin or MSYS, switch paths to Windows format before running java -if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then - APP_HOME=`cygpath --path --mixed "$APP_HOME"` - CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` - - JAVACMD=`cygpath --unix "$JAVACMD"` - - # We build the pattern for arguments to be converted via cygpath - ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` - SEP="" - for dir in $ROOTDIRSRAW ; do - ROOTDIRS="$ROOTDIRS$SEP$dir" - SEP="|" - done - OURCYGPATTERN="(^($ROOTDIRS))" - # Add a user-defined pattern to the cygpath arguments - if [ "$GRADLE_CYGPATTERN" != "" ] ; then - OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" - fi +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + # Now convert the arguments - kludge to limit ourselves to /bin/sh - i=0 - for arg in "$@" ; do - CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` - CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option - - if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition - eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` - else - eval `echo args$i`="\"$arg\"" + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) fi - i=`expr $i + 1` + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg done - case $i in - 0) set -- ;; - 1) set -- "$args0" ;; - 2) set -- "$args0" "$args1" ;; - 3) set -- "$args0" "$args1" "$args2" ;; - 4) set -- "$args0" "$args1" "$args2" "$args3" ;; - 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; - 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; - 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; - 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; - 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; - esac fi -# Escape application args -save () { - for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done - echo " " -} -APP_ARGS=`save "$@"` +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# -# Collect all arguments for the java command, following the shell quoting and substitution rules -eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' exec "$JAVACMD" "$@" diff --git a/auto-generated-sdk/gradlew.bat b/auto-generated-sdk/gradlew.bat index 107acd32..6a68175e 100644 --- a/auto-generated-sdk/gradlew.bat +++ b/auto-generated-sdk/gradlew.bat @@ -33,7 +33,7 @@ set APP_HOME=%DIRNAME% for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" +set DEFAULT_JVM_OPTS=-Dfile.encoding=UTF-8 "-Xmx64m" "-Xms64m" @rem Find java.exe if defined JAVA_HOME goto findJavaFromJavaHome diff --git a/auto-generated-sdk/pom.xml b/auto-generated-sdk/pom.xml index 32dd46a7..8c0fa39e 100644 --- a/auto-generated-sdk/pom.xml +++ b/auto-generated-sdk/pom.xml @@ -5,7 +5,7 @@ engines-sdk jar engines-sdk - 5.1.0 + 5.2.0 https://github.com/factset/analyticsapi-engines-java-sdk SDK for FactSet Analytics Engines API diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ApiClient.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ApiClient.java index 5ac11f50..3a1d0ae6 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ApiClient.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ApiClient.java @@ -118,7 +118,7 @@ public ApiClient(Map authMap) { httpClient = buildHttpClient(); this.dateFormat = new RFC3339DateFormat(); // Set default User-Agent. - setUserAgent("engines-api/5.0.0/java"); + setUserAgent("engines-api/5.2.0/java"); // Setup authentications (key: authentication name, value: authentication). authentications = new HashMap(); Authentication auth = null; diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ServerConfiguration.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ServerConfiguration.java index c1c73c28..74f458ee 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ServerConfiguration.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ServerConfiguration.java @@ -12,7 +12,7 @@ public class ServerConfiguration { /** * @param URL A URL to the target host. - * @param description A describtion of the host designated by the URL. + * @param description A description of the host designated by the URL. * @param variables A map between a variable name and its value. The value is used for substitution in the server's URL template. */ public ServerConfiguration(String URL, String description, Map variables) { diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AccountsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AccountsApi.java index a13cd9bb..3d875056 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AccountsApi.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AccountsApi.java @@ -16,6 +16,7 @@ import factset.analyticsapi.engines.models.AccountDirectoriesRoot; import factset.analyticsapi.engines.models.ClientErrorResponse; +import factset.analyticsapi.engines.models.SPARAccountsRoot; @javax.annotation.Generated(value = "CustomJavaClientCodegen") public class AccountsApi { @@ -135,4 +136,93 @@ public ApiResponse getAccountsWithHttpInfo(String path) localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, returnTypeMap, false); } + /** + * Get SPAR account returns type details + * This endpoint returns the returns type of account associated with SPAR + * @param accountPath URL encoded account path (required) + @return SPARAccountsRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns the list of return types for the account. * 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 account. * 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 Account 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.
+ */ + public SPARAccountsRoot getSPARReturnsType(String accountPath) throws ApiException { + return getSPARReturnsTypeWithHttpInfo(accountPath).getData(); + } + + /** + * Get SPAR account returns type details + * This endpoint returns the returns type of account associated with SPAR + * @param accountPath URL encoded account path (required) + * @return ApiResponse<SPARAccountsRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns the list of return types for the account. * 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 account. * 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 Account 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.
+ */ + public ApiResponse getSPARReturnsTypeWithHttpInfo(String accountPath) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'accountPath' is set + if (accountPath == null) { + throw new ApiException(400, "Missing the required parameter 'accountPath' when calling getSPARReturnsType"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/spar/v3/accounts/{accountPath}/returns-type" + .replaceAll("\\{" + "accountPath" + "\\}", apiClient.escapeString(accountPath.toString())); + + // query params + java.util.List localVarQueryParams = new java.util.ArrayList(); + java.util.Map localVarHeaderParams = new java.util.HashMap(); + java.util.Map localVarCookieParams = new java.util.HashMap(); + java.util.Map localVarFormParams = new java.util.HashMap(); + + + + + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(200, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("AccountsApi.getSPARReturnsType", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java new file mode 100644 index 00000000..2b979913 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/LinkedPaTemplatesApi.java @@ -0,0 +1,500 @@ + +package factset.analyticsapi.engines.api; + +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiResponse; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.Pair; + +import javax.ws.rs.core.GenericType; + +import java.util.HashMap; +import java.util.Map; + +import java.io.File; + +import factset.analyticsapi.engines.models.ClientErrorResponse; +import factset.analyticsapi.engines.models.LinkedPATemplateParametersRoot; +import factset.analyticsapi.engines.models.LinkedPATemplatePostSummaryRoot; +import factset.analyticsapi.engines.models.LinkedPATemplateRoot; +import factset.analyticsapi.engines.models.LinkedPATemplateSummaryRoot; +import factset.analyticsapi.engines.models.LinkedPATemplateUpdateParametersRoot; + +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPaTemplatesApi { + private ApiClient apiClient; + public LinkedPaTemplatesApi() { + this(Configuration.getDefaultApiClient()); + } + + public LinkedPaTemplatesApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Get the API cilent + * + * @return API client + */ + public ApiClient getApiClient() { + return apiClient; + } + + /** + * Set the API cilent + * + * @param apiClient an instance of API client + */ + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Create a linked PA template + * This endpoint creates a template from an **existing portfolio analysis tile**, allowing the user to replicate and fetch reports settings. 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\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Multi-horizon frequencies are not supported through this endpoint. + * @param linkedPATemplateParametersRoot Request Parameters (required) + @return LinkedPATemplatePostSummaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
201 Expected response, created a template linked to a PA3 tile. * 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 data provided. Please check the request parameters before attempting again. * 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 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.
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.
+ */ + public LinkedPATemplatePostSummaryRoot createLinkedPATemplates(LinkedPATemplateParametersRoot linkedPATemplateParametersRoot) throws ApiException { + return createLinkedPATemplatesWithHttpInfo(linkedPATemplateParametersRoot).getData(); + } + + /** + * Create a linked PA template + * This endpoint creates a template from an **existing portfolio analysis tile**, allowing the user to replicate and fetch reports settings. 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\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Multi-horizon frequencies are not supported through this endpoint. + * @param linkedPATemplateParametersRoot Request Parameters (required) + * @return ApiResponse<LinkedPATemplatePostSummaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
201 Expected response, created a template linked to a PA3 tile. * 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 data provided. Please check the request parameters before attempting again. * 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 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.
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.
+ */ + public ApiResponse createLinkedPATemplatesWithHttpInfo(LinkedPATemplateParametersRoot linkedPATemplateParametersRoot) throws ApiException { + Object localVarPostBody = linkedPATemplateParametersRoot; + + // verify the required parameter 'linkedPATemplateParametersRoot' is set + if (linkedPATemplateParametersRoot == null) { + throw new ApiException(400, "Missing the required parameter 'linkedPATemplateParametersRoot' when calling createLinkedPATemplates"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/linked-templates"; + + // query params + java.util.List localVarQueryParams = new java.util.ArrayList(); + java.util.Map localVarHeaderParams = new java.util.HashMap(); + java.util.Map localVarCookieParams = new java.util.HashMap(); + java.util.Map localVarFormParams = new java.util.HashMap(); + + + + + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(201, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("LinkedPaTemplatesApi.createLinkedPATemplates", localVarPath, "POST", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Delete a linked PA template. + * This endpoint deletes an existing linked PA template. + * @param id Unique identifier for a linked PA template (required) + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
204 Expected response, deleted the linked PA template successfully. * 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 data provided. Please check the request parameters before attempting again. * 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 Template 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.
+ */ + public void deleteLinkedPATemplates(String id) throws ApiException { + deleteLinkedPATemplatesWithHttpInfo(id); + } + + /** + * Delete a linked PA template. + * This endpoint deletes an existing linked PA template. + * @param id Unique identifier for a linked PA template (required) + * @return ApiResponse<Void> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
204 Expected response, deleted the linked PA template successfully. * 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 data provided. Please check the request parameters before attempting again. * 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 Template 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.
+ */ + public ApiResponse deleteLinkedPATemplatesWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling deleteLinkedPATemplates"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/linked-templates/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())); + + // query params + java.util.List localVarQueryParams = new java.util.ArrayList(); + java.util.Map localVarHeaderParams = new java.util.HashMap(); + java.util.Map localVarCookieParams = new java.util.HashMap(); + java.util.Map localVarFormParams = new java.util.HashMap(); + + + + + + final String[] localVarAccepts = { + "text/plain", "application/json", "text/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("LinkedPaTemplatesApi.deleteLinkedPATemplates", localVarPath, "DELETE", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get linked PA templates + * This endpoint returns the list of linked PA templates in given path. + * @param directory Get linked PA templates in path. (optional) + * @param documentDirectory Get linked PA templates for documents in document path (optional) + * @param documentName Get linked PA templates for documents by document name (optional) + @return LinkedPATemplateSummaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a list of templates linked to PA3 tile. * 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 data provided. Please check the request parameters before attempting again. * 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 Document 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.
+ */ + public LinkedPATemplateSummaryRoot getLinkedPATemplates(String directory, String documentDirectory, String documentName) throws ApiException { + return getLinkedPATemplatesWithHttpInfo(directory, documentDirectory, documentName).getData(); + } + + /** + * Get linked PA templates + * This endpoint returns the list of linked PA templates in given path. + * @param directory Get linked PA templates in path. (optional) + * @param documentDirectory Get linked PA templates for documents in document path (optional) + * @param documentName Get linked PA templates for documents by document name (optional) + * @return ApiResponse<LinkedPATemplateSummaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a list of templates linked to PA3 tile. * 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 data provided. Please check the request parameters before attempting again. * 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 Document 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.
+ */ + public ApiResponse getLinkedPATemplatesWithHttpInfo(String directory, String documentDirectory, String documentName) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/linked-templates"; + + // query params + java.util.List localVarQueryParams = new java.util.ArrayList(); + java.util.Map localVarHeaderParams = new java.util.HashMap(); + java.util.Map localVarCookieParams = new java.util.HashMap(); + java.util.Map localVarFormParams = new java.util.HashMap(); + + localVarQueryParams.addAll(apiClient.parameterToPairs("", "directory", directory)); + localVarQueryParams.addAll(apiClient.parameterToPairs("", "documentDirectory", documentDirectory)); + localVarQueryParams.addAll(apiClient.parameterToPairs("", "documentName", documentName)); + + + + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(200, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("LinkedPaTemplatesApi.getLinkedPATemplates", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get linked PA template by id + * This endpoint fetches the linked PA template settings. + * @param id Unique identifier for a linked PA template (required) + @return LinkedPATemplateRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, linked PA template details. * 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 data provided. Please check the request parameters before attempting again. * 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 Template 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.
+ */ + public LinkedPATemplateRoot getLinkedPATemplatesById(String id) throws ApiException { + return getLinkedPATemplatesByIdWithHttpInfo(id).getData(); + } + + /** + * Get linked PA template by id + * This endpoint fetches the linked PA template settings. + * @param id Unique identifier for a linked PA template (required) + * @return ApiResponse<LinkedPATemplateRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, linked PA template details. * 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 data provided. Please check the request parameters before attempting again. * 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 Template 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.
+ */ + public ApiResponse getLinkedPATemplatesByIdWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling getLinkedPATemplatesById"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/linked-templates/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())); + + // query params + java.util.List localVarQueryParams = new java.util.ArrayList(); + java.util.Map localVarHeaderParams = new java.util.HashMap(); + java.util.Map localVarCookieParams = new java.util.HashMap(); + java.util.Map localVarFormParams = new java.util.HashMap(); + + + + + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(200, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("LinkedPaTemplatesApi.getLinkedPATemplatesById", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Update a linked PA template + * This endpoint allows the user to change the request body and description from an existing 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\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Multi-horizon frequencies are not supported through this endpoint. + * @param id Unique identifier for a linked PA template (required) + * @param linkedPATemplateUpdateParametersRoot Request Parameters (required) + @return LinkedPATemplatePostSummaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, updated a template linked to a PA3 tile. * 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 data provided. Please check the request parameters before attempting again. * 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 Template or 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.
+ */ + public LinkedPATemplatePostSummaryRoot updateLinkedPATemplates(String id, LinkedPATemplateUpdateParametersRoot linkedPATemplateUpdateParametersRoot) throws ApiException { + return updateLinkedPATemplatesWithHttpInfo(id, linkedPATemplateUpdateParametersRoot).getData(); + } + + /** + * Update a linked PA template + * This endpoint allows the user to change the request body and description from an existing 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\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Multi-horizon frequencies are not supported through this endpoint. + * @param id Unique identifier for a linked PA template (required) + * @param linkedPATemplateUpdateParametersRoot Request Parameters (required) + * @return ApiResponse<LinkedPATemplatePostSummaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, updated a template linked to a PA3 tile. * 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 data provided. Please check the request parameters before attempting again. * 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 Template or 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.
+ */ + public ApiResponse updateLinkedPATemplatesWithHttpInfo(String id, LinkedPATemplateUpdateParametersRoot linkedPATemplateUpdateParametersRoot) throws ApiException { + Object localVarPostBody = linkedPATemplateUpdateParametersRoot; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling updateLinkedPATemplates"); + } + + // verify the required parameter 'linkedPATemplateUpdateParametersRoot' is set + if (linkedPATemplateUpdateParametersRoot == null) { + throw new ApiException(400, "Missing the required parameter 'linkedPATemplateUpdateParametersRoot' when calling updateLinkedPATemplates"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/linked-templates/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())); + + // query params + java.util.List localVarQueryParams = new java.util.ArrayList(); + java.util.Map localVarHeaderParams = new java.util.HashMap(); + java.util.Map localVarCookieParams = new java.util.HashMap(); + java.util.Map localVarFormParams = new java.util.HashMap(); + + + + + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(200, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("LinkedPaTemplatesApi.updateLinkedPATemplates", localVarPath, "PUT", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } +} diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java new file mode 100644 index 00000000..3eafce4f --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java @@ -0,0 +1,496 @@ + +package factset.analyticsapi.engines.api; + +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiResponse; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.Pair; + +import javax.ws.rs.core.GenericType; + +import java.util.HashMap; +import java.util.Map; + +import java.io.File; + +import factset.analyticsapi.engines.models.ClientErrorResponse; +import factset.analyticsapi.engines.models.TemplatedPAComponentParametersRoot; +import factset.analyticsapi.engines.models.TemplatedPAComponentPostSummaryRoot; +import factset.analyticsapi.engines.models.TemplatedPAComponentRoot; +import factset.analyticsapi.engines.models.TemplatedPAComponentSummaryRoot; +import factset.analyticsapi.engines.models.TemplatedPAComponentUpdateParametersRoot; + +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPaComponentsApi { + private ApiClient apiClient; + public TemplatedPaComponentsApi() { + this(Configuration.getDefaultApiClient()); + } + + public TemplatedPaComponentsApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Get the API cilent + * + * @return API client + */ + public ApiClient getApiClient() { + return apiClient; + } + + /** + * Set the API cilent + * + * @param apiClient an instance of API client + */ + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * 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. + * @param templatedPAComponentParametersRoot Request Parameters (required) + @return TemplatedPAComponentPostSummaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
201 Expected response, templated PA component created successfully. * 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 data provided. Please check the request parameters before attempting again. * 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 Template 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.
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.
+ */ + public TemplatedPAComponentPostSummaryRoot createTemplatedPAComponents(TemplatedPAComponentParametersRoot templatedPAComponentParametersRoot) throws ApiException { + return createTemplatedPAComponentsWithHttpInfo(templatedPAComponentParametersRoot).getData(); + } + + /** + * 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. + * @param templatedPAComponentParametersRoot Request Parameters (required) + * @return ApiResponse<TemplatedPAComponentPostSummaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
201 Expected response, templated PA component created successfully. * 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 data provided. Please check the request parameters before attempting again. * 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 Template 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.
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.
+ */ + public ApiResponse createTemplatedPAComponentsWithHttpInfo(TemplatedPAComponentParametersRoot templatedPAComponentParametersRoot) throws ApiException { + Object localVarPostBody = templatedPAComponentParametersRoot; + + // verify the required parameter 'templatedPAComponentParametersRoot' is set + if (templatedPAComponentParametersRoot == null) { + throw new ApiException(400, "Missing the required parameter 'templatedPAComponentParametersRoot' when calling createTemplatedPAComponents"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/templated-components"; + + // query params + java.util.List localVarQueryParams = new java.util.ArrayList(); + java.util.Map localVarHeaderParams = new java.util.HashMap(); + java.util.Map localVarCookieParams = new java.util.HashMap(); + java.util.Map localVarFormParams = new java.util.HashMap(); + + + + + + final String[] localVarAccepts = { + "text/plain", "application/json", "text/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(201, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("TemplatedPaComponentsApi.createTemplatedPAComponents", localVarPath, "POST", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Delete templated PA component + * This endpoint deletes an existing templated PA component + * @param id Unique identifier for a templated PA component (required) + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
204 Expected response, deleted the templated PA component successfully. * 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 data provided. Please check the request parameters before attempting again. * 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.
+ */ + public void deleteTemplatedPAComponents(String id) throws ApiException { + deleteTemplatedPAComponentsWithHttpInfo(id); + } + + /** + * Delete templated PA component + * This endpoint deletes an existing templated PA component + * @param id Unique identifier for a templated PA component (required) + * @return ApiResponse<Void> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
204 Expected response, deleted the templated PA component successfully. * 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 data provided. Please check the request parameters before attempting again. * 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.
+ */ + public ApiResponse deleteTemplatedPAComponentsWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling deleteTemplatedPAComponents"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/templated-components/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())); + + // query params + java.util.List localVarQueryParams = new java.util.ArrayList(); + java.util.Map localVarHeaderParams = new java.util.HashMap(); + java.util.Map localVarCookieParams = new java.util.HashMap(); + java.util.Map localVarFormParams = new java.util.HashMap(); + + + + + + final String[] localVarAccepts = { + "text/plain", "application/json", "text/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("TemplatedPaComponentsApi.deleteTemplatedPAComponents", localVarPath, "DELETE", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get templated PA component by id + * This endpoint fetches the templated PA component settings. + * @param id Unique identifier for a templated PA component (required) + @return TemplatedPAComponentRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, templated PA component details. * 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 data provided. Please check the request parameters before attempting again. * 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 Templated PA 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.
+ */ + public TemplatedPAComponentRoot getTemplatedPAComponentById(String id) throws ApiException { + return getTemplatedPAComponentByIdWithHttpInfo(id).getData(); + } + + /** + * Get templated PA component by id + * This endpoint fetches the templated PA component settings. + * @param id Unique identifier for a templated PA component (required) + * @return ApiResponse<TemplatedPAComponentRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, templated PA component details. * 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 data provided. Please check the request parameters before attempting again. * 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 Templated PA 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.
+ */ + public ApiResponse getTemplatedPAComponentByIdWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling getTemplatedPAComponentById"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/templated-components/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())); + + // query params + java.util.List localVarQueryParams = new java.util.ArrayList(); + java.util.Map localVarHeaderParams = new java.util.HashMap(); + java.util.Map localVarCookieParams = new java.util.HashMap(); + java.util.Map localVarFormParams = new java.util.HashMap(); + + + + + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(200, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("TemplatedPaComponentsApi.getTemplatedPAComponentById", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get templated PA components in path + * This endpoint returns the list of templated PA components in path. + * @param directory Get templated PA components in path (required) + @return TemplatedPAComponentSummaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a list templated PA components. * 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 data provided. Please check the request parameters before attempting again. * 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.
+ */ + public TemplatedPAComponentSummaryRoot getTemplatedPAComponentsInPath(String directory) throws ApiException { + return getTemplatedPAComponentsInPathWithHttpInfo(directory).getData(); + } + + /** + * Get templated PA components in path + * This endpoint returns the list of templated PA components in path. + * @param directory Get templated PA components in path (required) + * @return ApiResponse<TemplatedPAComponentSummaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a list templated PA components. * 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 data provided. Please check the request parameters before attempting again. * 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.
+ */ + public ApiResponse getTemplatedPAComponentsInPathWithHttpInfo(String directory) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'directory' is set + if (directory == null) { + throw new ApiException(400, "Missing the required parameter 'directory' when calling getTemplatedPAComponentsInPath"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/templated-components"; + + // query params + java.util.List localVarQueryParams = new java.util.ArrayList(); + java.util.Map localVarHeaderParams = new java.util.HashMap(); + java.util.Map localVarCookieParams = new java.util.HashMap(); + java.util.Map localVarFormParams = new java.util.HashMap(); + + localVarQueryParams.addAll(apiClient.parameterToPairs("", "directory", directory)); + + + + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(200, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("TemplatedPaComponentsApi.getTemplatedPAComponentsInPath", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * 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. + * @param id Unique identifier for a templated PA component (required) + * @param templatedPAComponentUpdateParametersRoot Request Parameters (required) + @return TemplatedPAComponentPostSummaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, updated successfully. * 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 data provided. Please check the request parameters before attempting again. * 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 or template 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.
+ */ + public TemplatedPAComponentPostSummaryRoot updateTemplatedPAComponents(String id, TemplatedPAComponentUpdateParametersRoot templatedPAComponentUpdateParametersRoot) throws ApiException { + return updateTemplatedPAComponentsWithHttpInfo(id, templatedPAComponentUpdateParametersRoot).getData(); + } + + /** + * 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. + * @param id Unique identifier for a templated PA component (required) + * @param templatedPAComponentUpdateParametersRoot Request Parameters (required) + * @return ApiResponse<TemplatedPAComponentPostSummaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, updated successfully. * 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 data provided. Please check the request parameters before attempting again. * 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 or template 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.
+ */ + public ApiResponse updateTemplatedPAComponentsWithHttpInfo(String id, TemplatedPAComponentUpdateParametersRoot templatedPAComponentUpdateParametersRoot) throws ApiException { + Object localVarPostBody = templatedPAComponentUpdateParametersRoot; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling updateTemplatedPAComponents"); + } + + // verify the required parameter 'templatedPAComponentUpdateParametersRoot' is set + if (templatedPAComponentUpdateParametersRoot == null) { + throw new ApiException(400, "Missing the required parameter 'templatedPAComponentUpdateParametersRoot' when calling updateTemplatedPAComponents"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/templated-components/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())); + + // query params + java.util.List localVarQueryParams = new java.util.ArrayList(); + java.util.Map localVarHeaderParams = new java.util.HashMap(); + java.util.Map localVarCookieParams = new java.util.HashMap(); + java.util.Map localVarFormParams = new java.util.HashMap(); + + + + + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(200, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("TemplatedPaComponentsApi.updateTemplatedPAComponents", localVarPath, "PUT", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } +} diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java new file mode 100644 index 00000000..1f02f543 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java @@ -0,0 +1,658 @@ + +package factset.analyticsapi.engines.api; + +import factset.analyticsapi.engines.ApiException; +import factset.analyticsapi.engines.ApiClient; +import factset.analyticsapi.engines.ApiResponse; +import factset.analyticsapi.engines.Configuration; +import factset.analyticsapi.engines.Pair; + +import javax.ws.rs.core.GenericType; + +import java.util.HashMap; +import java.util.Map; + +import java.io.File; + +import factset.analyticsapi.engines.models.ClientErrorResponse; +import factset.analyticsapi.engines.models.UnlinkedPATemplateCategoryAndTypeDetailsRoot; +import factset.analyticsapi.engines.models.UnlinkedPATemplateCategoryAndTypeRoot; +import factset.analyticsapi.engines.models.UnlinkedPATemplateParametersRoot; +import factset.analyticsapi.engines.models.UnlinkedPATemplatePostSummaryRoot; +import factset.analyticsapi.engines.models.UnlinkedPATemplateRoot; +import factset.analyticsapi.engines.models.UnlinkedPATemplateSummaryRoot; +import factset.analyticsapi.engines.models.UnlinkedPATemplateUpdateParametersRoot; + +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPaTemplatesApi { + private ApiClient apiClient; + public UnlinkedPaTemplatesApi() { + this(Configuration.getDefaultApiClient()); + } + + public UnlinkedPaTemplatesApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Get the API cilent + * + * @return API client + */ + public ApiClient getApiClient() { + return apiClient; + } + + /** + * Set the API cilent + * + * @param apiClient an instance of API client + */ + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * 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\", \"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. + * @param unlinkedPATemplateParametersRoot Request Parameters (required) + @return UnlinkedPATemplatePostSummaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + +
Status Code Description Response Headers
201 Expected response, created a unlinked PA template. * 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 data provided. Please check the request parameters before attempting again. * 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.
+ */ + public UnlinkedPATemplatePostSummaryRoot createUnlinkedPATemplates(UnlinkedPATemplateParametersRoot unlinkedPATemplateParametersRoot) throws ApiException { + return createUnlinkedPATemplatesWithHttpInfo(unlinkedPATemplateParametersRoot).getData(); + } + + /** + * 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\", \"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. + * @param unlinkedPATemplateParametersRoot Request Parameters (required) + * @return ApiResponse<UnlinkedPATemplatePostSummaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + +
Status Code Description Response Headers
201 Expected response, created a unlinked PA template. * 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 data provided. Please check the request parameters before attempting again. * 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.
+ */ + public ApiResponse createUnlinkedPATemplatesWithHttpInfo(UnlinkedPATemplateParametersRoot unlinkedPATemplateParametersRoot) throws ApiException { + Object localVarPostBody = unlinkedPATemplateParametersRoot; + + // verify the required parameter 'unlinkedPATemplateParametersRoot' is set + if (unlinkedPATemplateParametersRoot == null) { + throw new ApiException(400, "Missing the required parameter 'unlinkedPATemplateParametersRoot' when calling createUnlinkedPATemplates"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/unlinked-templates"; + + // query params + java.util.List localVarQueryParams = new java.util.ArrayList(); + java.util.Map localVarHeaderParams = new java.util.HashMap(); + java.util.Map localVarCookieParams = new java.util.HashMap(); + java.util.Map localVarFormParams = new java.util.HashMap(); + + + + + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(201, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("UnlinkedPaTemplatesApi.createUnlinkedPATemplates", localVarPath, "POST", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Delete unlinked PA template + * This endpoint deletes an existing unliked PA template. + * @param id Unique identifier for an unlinked PA template (required) + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
204 Expected response, deleted the unlinked PA template successfully. * 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 data provided. Please check the request parameters before attempting again. * 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 Template 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.
+ */ + public void deleteUnlinkedPATemplates(String id) throws ApiException { + deleteUnlinkedPATemplatesWithHttpInfo(id); + } + + /** + * Delete unlinked PA template + * This endpoint deletes an existing unliked PA template. + * @param id Unique identifier for an unlinked PA template (required) + * @return ApiResponse<Void> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
204 Expected response, deleted the unlinked PA template successfully. * 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 data provided. Please check the request parameters before attempting again. * 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 Template 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.
+ */ + public ApiResponse deleteUnlinkedPATemplatesWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling deleteUnlinkedPATemplates"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/unlinked-templates/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())); + + // query params + java.util.List localVarQueryParams = new java.util.ArrayList(); + java.util.Map localVarHeaderParams = new java.util.HashMap(); + java.util.Map localVarCookieParams = new java.util.HashMap(); + java.util.Map localVarFormParams = new java.util.HashMap(); + + + + + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("UnlinkedPaTemplatesApi.deleteUnlinkedPATemplates", localVarPath, "DELETE", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get default unlinked PA template types. + * This endpoint fetches default unlinked PA template types. + @return UnlinkedPATemplateCategoryAndTypeRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, default unlinked PA template types * 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.
+ */ + public UnlinkedPATemplateCategoryAndTypeRoot getDefaultUnlinkedPATemplateTypes() throws ApiException { + return getDefaultUnlinkedPATemplateTypesWithHttpInfo().getData(); + } + + /** + * Get default unlinked PA template types. + * This endpoint fetches default unlinked PA template types. + * @return ApiResponse<UnlinkedPATemplateCategoryAndTypeRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, default unlinked PA template types * 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.
+ */ + public ApiResponse getDefaultUnlinkedPATemplateTypesWithHttpInfo() throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/unlinked-templates/template-types"; + + // query params + java.util.List localVarQueryParams = new java.util.ArrayList(); + java.util.Map localVarHeaderParams = new java.util.HashMap(); + java.util.Map localVarCookieParams = new java.util.HashMap(); + java.util.Map localVarFormParams = new java.util.HashMap(); + + + + + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(200, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("UnlinkedPaTemplatesApi.getDefaultUnlinkedPATemplateTypes", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get unlinked PA template type details by id. + * This endpoint fetches the unlinked PA template type details. + * @param id Unique identifier for an unlinked PA template type (required) + @return UnlinkedPATemplateCategoryAndTypeDetailsRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, details of the unlinked PA template type * 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 data provided. Please check the request parameters before attempting again. * 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 Unlinked PA template type 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.
+ */ + public UnlinkedPATemplateCategoryAndTypeDetailsRoot getDetailsType(String id) throws ApiException { + return getDetailsTypeWithHttpInfo(id).getData(); + } + + /** + * Get unlinked PA template type details by id. + * This endpoint fetches the unlinked PA template type details. + * @param id Unique identifier for an unlinked PA template type (required) + * @return ApiResponse<UnlinkedPATemplateCategoryAndTypeDetailsRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, details of the unlinked PA template type * 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 data provided. Please check the request parameters before attempting again. * 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 Unlinked PA template type 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.
+ */ + public ApiResponse getDetailsTypeWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling getDetailsType"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/unlinked-templates/template-types/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())); + + // query params + java.util.List localVarQueryParams = new java.util.ArrayList(); + java.util.Map localVarHeaderParams = new java.util.HashMap(); + java.util.Map localVarCookieParams = new java.util.HashMap(); + java.util.Map localVarFormParams = new java.util.HashMap(); + + + + + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(200, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("UnlinkedPaTemplatesApi.getDetailsType", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get unlinked PA templates + * This endpoint returns the list of unlinked PA templates. + * @param directory Get unlinked PA templates in path. (optional) + * @param category Get unlinked PA templates by category. (optional) + @return UnlinkedPATemplateSummaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a list of unlinked PA templates. * 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 data provided. Please check the request parameters before attempting again. * 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.
+ */ + public UnlinkedPATemplateSummaryRoot getUnlinkedPATemplates(String directory, String category) throws ApiException { + return getUnlinkedPATemplatesWithHttpInfo(directory, category).getData(); + } + + /** + * Get unlinked PA templates + * This endpoint returns the list of unlinked PA templates. + * @param directory Get unlinked PA templates in path. (optional) + * @param category Get unlinked PA templates by category. (optional) + * @return ApiResponse<UnlinkedPATemplateSummaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, returns a list of unlinked PA templates. * 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 data provided. Please check the request parameters before attempting again. * 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.
+ */ + public ApiResponse getUnlinkedPATemplatesWithHttpInfo(String directory, String category) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/unlinked-templates"; + + // query params + java.util.List localVarQueryParams = new java.util.ArrayList(); + java.util.Map localVarHeaderParams = new java.util.HashMap(); + java.util.Map localVarCookieParams = new java.util.HashMap(); + java.util.Map localVarFormParams = new java.util.HashMap(); + + localVarQueryParams.addAll(apiClient.parameterToPairs("", "directory", directory)); + localVarQueryParams.addAll(apiClient.parameterToPairs("", "category", category)); + + + + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(200, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("UnlinkedPaTemplatesApi.getUnlinkedPATemplates", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * Get unlinked PA template details by id + * This endpoint fetches the template settings. + * @param id Unique identifier for an unlinked PA template (required) + @return UnlinkedPATemplateRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, get details of the unlinked PA template. * 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 data provided. Please check the request parameters before attempting again. * 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 Template 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.
+ */ + public UnlinkedPATemplateRoot getUnlinkedPATemplatesById(String id) throws ApiException { + return getUnlinkedPATemplatesByIdWithHttpInfo(id).getData(); + } + + /** + * Get unlinked PA template details by id + * This endpoint fetches the template settings. + * @param id Unique identifier for an unlinked PA template (required) + * @return ApiResponse<UnlinkedPATemplateRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, get details of the unlinked PA template. * 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 data provided. Please check the request parameters before attempting again. * 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 Template 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.
+ */ + public ApiResponse getUnlinkedPATemplatesByIdWithHttpInfo(String id) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling getUnlinkedPATemplatesById"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/unlinked-templates/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())); + + // query params + java.util.List localVarQueryParams = new java.util.ArrayList(); + java.util.Map localVarHeaderParams = new java.util.HashMap(); + java.util.Map localVarCookieParams = new java.util.HashMap(); + java.util.Map localVarFormParams = new java.util.HashMap(); + + + + + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(200, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("UnlinkedPaTemplatesApi.getUnlinkedPATemplatesById", localVarPath, "GET", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } + /** + * 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\", \"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. + * @param id Unique identifier for an unlinked PA template (required) + * @param unlinkedPATemplateUpdateParametersRoot Request Parameters (required) + @return UnlinkedPATemplatePostSummaryRoot + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, updated the unlinked PA template. * 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 data provided. Please check the request parameters before attempting again. * 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 Template 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.
+ */ + public UnlinkedPATemplatePostSummaryRoot updateUnlinkedPATemplates(String id, UnlinkedPATemplateUpdateParametersRoot unlinkedPATemplateUpdateParametersRoot) throws ApiException { + return updateUnlinkedPATemplatesWithHttpInfo(id, unlinkedPATemplateUpdateParametersRoot).getData(); + } + + /** + * 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\", \"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. + * @param id Unique identifier for an unlinked PA template (required) + * @param unlinkedPATemplateUpdateParametersRoot Request Parameters (required) + * @return ApiResponse<UnlinkedPATemplatePostSummaryRoot> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + + + + + + + +
Status Code Description Response Headers
200 Expected response, updated the unlinked PA template. * 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 data provided. Please check the request parameters before attempting again. * 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 Template 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.
+ */ + public ApiResponse updateUnlinkedPATemplatesWithHttpInfo(String id, UnlinkedPATemplateUpdateParametersRoot unlinkedPATemplateUpdateParametersRoot) throws ApiException { + Object localVarPostBody = unlinkedPATemplateUpdateParametersRoot; + + // verify the required parameter 'id' is set + if (id == null) { + throw new ApiException(400, "Missing the required parameter 'id' when calling updateUnlinkedPATemplates"); + } + + // verify the required parameter 'unlinkedPATemplateUpdateParametersRoot' is set + if (unlinkedPATemplateUpdateParametersRoot == null) { + throw new ApiException(400, "Missing the required parameter 'unlinkedPATemplateUpdateParametersRoot' when calling updateUnlinkedPATemplates"); + } + + // create path and map variables + String localVarPath = "/analytics/engines/pa/v3/unlinked-templates/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())); + + // query params + java.util.List localVarQueryParams = new java.util.ArrayList(); + java.util.Map localVarHeaderParams = new java.util.HashMap(); + java.util.Map localVarCookieParams = new java.util.HashMap(); + java.util.Map localVarFormParams = new java.util.HashMap(); + + + + + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "Basic", "Bearer" }; + + GenericType localVarReturnType = new GenericType() {}; + + Map returnTypeMap = new HashMap(); + returnTypeMap.put(200, new GenericType(){}); + returnTypeMap.put(400, new GenericType(){}); + returnTypeMap.put(404, new GenericType(){}); + + return apiClient.invokeAPIWithReturnMap("UnlinkedPaTemplatesApi.updateUnlinkedPATemplates", localVarPath, "PUT", localVarQueryParams, localVarPostBody, + localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, + localVarAuthNames, returnTypeMap, false); + } +} diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AFIOptimizationParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AFIOptimizationParameters.java index ff2dbb55..56fcc802 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AFIOptimizationParameters.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AFIOptimizationParameters.java @@ -58,6 +58,8 @@ public class AFIOptimizationParameters implements Serializable { public static final String JSON_PROPERTY_OUTPUT_TYPES = "outputTypes"; private OptimizerOutputTypes outputTypes; + public AFIOptimizationParameters() { + } public AFIOptimizationParameters strategy(AFIOptimizerStrategy strategy) { this.strategy = strategy; @@ -68,6 +70,7 @@ public AFIOptimizationParameters strategy(AFIOptimizerStrategy strategy) { * Get strategy * @return strategy **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_STRATEGY) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -77,6 +80,8 @@ public AFIOptimizerStrategy getStrategy() { } + @JsonProperty(JSON_PROPERTY_STRATEGY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setStrategy(AFIOptimizerStrategy strategy) { this.strategy = strategy; } @@ -101,6 +106,8 @@ public OptimizerAccount getAccount() { } + @JsonProperty(JSON_PROPERTY_ACCOUNT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccount(OptimizerAccount account) { this.account = account; } @@ -125,6 +132,8 @@ public Optimization getOptimization() { } + @JsonProperty(JSON_PROPERTY_OPTIMIZATION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOptimization(Optimization optimization) { this.optimization = optimization; } @@ -139,6 +148,7 @@ public AFIOptimizationParameters outputTypes(OptimizerOutputTypes outputTypes) { * Get outputTypes * @return outputTypes **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_OUTPUT_TYPES) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -148,6 +158,8 @@ public OptimizerOutputTypes getOutputTypes() { } + @JsonProperty(JSON_PROPERTY_OUTPUT_TYPES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setOutputTypes(OptimizerOutputTypes outputTypes) { this.outputTypes = outputTypes; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AFIOptimizationParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AFIOptimizationParametersRoot.java index 3e51d6d6..a539eb07 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AFIOptimizationParametersRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AFIOptimizationParametersRoot.java @@ -47,6 +47,8 @@ public class AFIOptimizationParametersRoot implements Serializable { public static final String JSON_PROPERTY_META = "meta"; private Object meta; + public AFIOptimizationParametersRoot() { + } public AFIOptimizationParametersRoot data(AFIOptimizationParameters data) { this.data = data; @@ -67,6 +69,8 @@ public AFIOptimizationParameters getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(AFIOptimizationParameters data) { this.data = data; } @@ -91,6 +95,8 @@ public Object getMeta() { } + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMeta(Object meta) { this.meta = meta; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AFIOptimizerStrategy.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AFIOptimizerStrategy.java index d2369a52..377c34b6 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AFIOptimizerStrategy.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AFIOptimizerStrategy.java @@ -47,6 +47,8 @@ public class AFIOptimizerStrategy implements Serializable { public static final String JSON_PROPERTY_ID = "id"; private String id; + public AFIOptimizerStrategy() { + } public AFIOptimizerStrategy overrides(AFIOptimizerStrategyOverrides overrides) { this.overrides = overrides; @@ -67,6 +69,8 @@ public AFIOptimizerStrategyOverrides getOverrides() { } + @JsonProperty(JSON_PROPERTY_OVERRIDES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOverrides(AFIOptimizerStrategyOverrides overrides) { this.overrides = overrides; } @@ -81,6 +85,7 @@ public AFIOptimizerStrategy id(String id) { * OptimizerStrategy document path * @return id **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "OptimizerStrategy document path") @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -90,6 +95,8 @@ public String getId() { } + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setId(String id) { this.id = id; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AFIOptimizerStrategyOverrides.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AFIOptimizerStrategyOverrides.java index 4970857d..a0f68056 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AFIOptimizerStrategyOverrides.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AFIOptimizerStrategyOverrides.java @@ -93,6 +93,8 @@ public static InnerEnum fromValue(String value) { public static final String JSON_PROPERTY_TRANSACTION_COST = "transactionCost"; private String transactionCost; + public AFIOptimizerStrategyOverrides() { + } public AFIOptimizerStrategyOverrides objective(String objective) { this.objective = objective; @@ -113,6 +115,8 @@ public String getObjective() { } + @JsonProperty(JSON_PROPERTY_OBJECTIVE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setObjective(String objective) { this.objective = objective; } @@ -137,6 +141,8 @@ public String getTax() { } + @JsonProperty(JSON_PROPERTY_TAX) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTax(String tax) { this.tax = tax; } @@ -169,6 +175,8 @@ public java.util.Map getConstraints() { } + @JsonProperty(JSON_PROPERTY_CONSTRAINTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setConstraints(java.util.Map constraints) { this.constraints = constraints; } @@ -193,6 +201,8 @@ public String getAlpha() { } + @JsonProperty(JSON_PROPERTY_ALPHA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAlpha(String alpha) { this.alpha = alpha; } @@ -217,6 +227,8 @@ public String getTransactionCost() { } + @JsonProperty(JSON_PROPERTY_TRANSACTION_COST) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransactionCost(String transactionCost) { this.transactionCost = transactionCost; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AccountDirectories.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AccountDirectories.java index bce52cfb..2f2b7ee5 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AccountDirectories.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AccountDirectories.java @@ -46,6 +46,8 @@ public class AccountDirectories implements Serializable { public static final String JSON_PROPERTY_DIRECTORIES = "directories"; private java.util.List directories = null; + public AccountDirectories() { + } public AccountDirectories accounts(java.util.List accounts) { this.accounts = accounts; @@ -74,6 +76,8 @@ public java.util.List getAccounts() { } + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccounts(java.util.List accounts) { this.accounts = accounts; } @@ -106,6 +110,8 @@ public java.util.List getDirectories() { } + @JsonProperty(JSON_PROPERTY_DIRECTORIES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDirectories(java.util.List directories) { this.directories = directories; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AccountDirectoriesRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AccountDirectoriesRoot.java index d07f0fce..90dab243 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AccountDirectoriesRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AccountDirectoriesRoot.java @@ -25,6 +25,10 @@ import factset.analyticsapi.engines.models.AccountDirectories; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; import java.io.Serializable; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import factset.analyticsapi.engines.JSON; @@ -45,8 +49,10 @@ public class AccountDirectoriesRoot implements Serializable { private AccountDirectories data; public static final String JSON_PROPERTY_META = "meta"; - private Object meta; + private JsonNullable meta = JsonNullable.of(null); + public AccountDirectoriesRoot() { + } public AccountDirectoriesRoot data(AccountDirectories data) { this.data = data; @@ -57,6 +63,7 @@ public AccountDirectoriesRoot data(AccountDirectories data) { * Get data * @return data **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -66,13 +73,15 @@ public AccountDirectories getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setData(AccountDirectories data) { this.data = data; } public AccountDirectoriesRoot meta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); return this; } @@ -82,16 +91,26 @@ public AccountDirectoriesRoot meta(Object meta) { **/ @javax.annotation.Nullable @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + @JsonProperty(JSON_PROPERTY_META) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Object getMeta() { + public JsonNullable getMeta_JsonNullable() { return meta; } - + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } public void setMeta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); } @@ -108,12 +127,23 @@ public boolean equals(Object o) { } AccountDirectoriesRoot accountDirectoriesRoot = (AccountDirectoriesRoot) o; return Objects.equals(this.data, accountDirectoriesRoot.data) && - Objects.equals(this.meta, accountDirectoriesRoot.meta); + equalsNullable(this.meta, accountDirectoriesRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); } @Override public int hashCode() { - return Objects.hash(data, meta); + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; } @Override diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AxiomaEquityOptimizationParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AxiomaEquityOptimizationParameters.java index 2467bbc9..59b5a8e4 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AxiomaEquityOptimizationParameters.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AxiomaEquityOptimizationParameters.java @@ -58,6 +58,8 @@ public class AxiomaEquityOptimizationParameters implements Serializable { public static final String JSON_PROPERTY_OUTPUT_TYPES = "outputTypes"; private OptimizerOutputTypes outputTypes; + public AxiomaEquityOptimizationParameters() { + } public AxiomaEquityOptimizationParameters strategy(AxiomaEquityOptimizerStrategy strategy) { this.strategy = strategy; @@ -68,6 +70,7 @@ public AxiomaEquityOptimizationParameters strategy(AxiomaEquityOptimizerStrategy * Get strategy * @return strategy **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_STRATEGY) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -77,6 +80,8 @@ public AxiomaEquityOptimizerStrategy getStrategy() { } + @JsonProperty(JSON_PROPERTY_STRATEGY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setStrategy(AxiomaEquityOptimizerStrategy strategy) { this.strategy = strategy; } @@ -101,6 +106,8 @@ public OptimizerAccount getAccount() { } + @JsonProperty(JSON_PROPERTY_ACCOUNT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccount(OptimizerAccount account) { this.account = account; } @@ -125,6 +132,8 @@ public Optimization getOptimization() { } + @JsonProperty(JSON_PROPERTY_OPTIMIZATION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOptimization(Optimization optimization) { this.optimization = optimization; } @@ -139,6 +148,7 @@ public AxiomaEquityOptimizationParameters outputTypes(OptimizerOutputTypes outpu * Get outputTypes * @return outputTypes **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_OUTPUT_TYPES) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -148,6 +158,8 @@ public OptimizerOutputTypes getOutputTypes() { } + @JsonProperty(JSON_PROPERTY_OUTPUT_TYPES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setOutputTypes(OptimizerOutputTypes outputTypes) { this.outputTypes = outputTypes; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AxiomaEquityOptimizationParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AxiomaEquityOptimizationParametersRoot.java index fefafa3f..cb0dfc51 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AxiomaEquityOptimizationParametersRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AxiomaEquityOptimizationParametersRoot.java @@ -47,6 +47,8 @@ public class AxiomaEquityOptimizationParametersRoot implements Serializable { public static final String JSON_PROPERTY_META = "meta"; private Object meta; + public AxiomaEquityOptimizationParametersRoot() { + } public AxiomaEquityOptimizationParametersRoot data(AxiomaEquityOptimizationParameters data) { this.data = data; @@ -67,6 +69,8 @@ public AxiomaEquityOptimizationParameters getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(AxiomaEquityOptimizationParameters data) { this.data = data; } @@ -91,6 +95,8 @@ public Object getMeta() { } + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMeta(Object meta) { this.meta = meta; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AxiomaEquityOptimizerStrategy.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AxiomaEquityOptimizerStrategy.java index 2da1d656..8449cc2a 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AxiomaEquityOptimizerStrategy.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AxiomaEquityOptimizerStrategy.java @@ -47,6 +47,8 @@ public class AxiomaEquityOptimizerStrategy implements Serializable { public static final String JSON_PROPERTY_ID = "id"; private String id; + public AxiomaEquityOptimizerStrategy() { + } public AxiomaEquityOptimizerStrategy overrides(AxiomaEquityOptimizerStrategyOverrides overrides) { this.overrides = overrides; @@ -67,6 +69,8 @@ public AxiomaEquityOptimizerStrategyOverrides getOverrides() { } + @JsonProperty(JSON_PROPERTY_OVERRIDES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOverrides(AxiomaEquityOptimizerStrategyOverrides overrides) { this.overrides = overrides; } @@ -81,6 +85,7 @@ public AxiomaEquityOptimizerStrategy id(String id) { * OptimizerStrategy document path * @return id **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "OptimizerStrategy document path") @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -90,6 +95,8 @@ public String getId() { } + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setId(String id) { this.id = id; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AxiomaEquityOptimizerStrategyOverrides.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AxiomaEquityOptimizerStrategyOverrides.java index 19464c7b..dad3e73a 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AxiomaEquityOptimizerStrategyOverrides.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/AxiomaEquityOptimizerStrategyOverrides.java @@ -93,6 +93,8 @@ public static InnerEnum fromValue(String value) { public static final String JSON_PROPERTY_TRANSACTION_COST = "transactionCost"; private String transactionCost; + public AxiomaEquityOptimizerStrategyOverrides() { + } public AxiomaEquityOptimizerStrategyOverrides objective(String objective) { this.objective = objective; @@ -113,6 +115,8 @@ public String getObjective() { } + @JsonProperty(JSON_PROPERTY_OBJECTIVE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setObjective(String objective) { this.objective = objective; } @@ -137,6 +141,8 @@ public String getTax() { } + @JsonProperty(JSON_PROPERTY_TAX) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTax(String tax) { this.tax = tax; } @@ -169,6 +175,8 @@ public java.util.Map getConstraints() { } + @JsonProperty(JSON_PROPERTY_CONSTRAINTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setConstraints(java.util.Map constraints) { this.constraints = constraints; } @@ -193,6 +201,8 @@ public String getAlpha() { } + @JsonProperty(JSON_PROPERTY_ALPHA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAlpha(String alpha) { this.alpha = alpha; } @@ -217,6 +227,8 @@ public String getTransactionCost() { } + @JsonProperty(JSON_PROPERTY_TRANSACTION_COST) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransactionCost(String transactionCost) { this.transactionCost = transactionCost; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimization.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimization.java index b9a57754..3856557f 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimization.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimization.java @@ -58,6 +58,8 @@ public class BPMOptimization implements Serializable { public static final String JSON_PROPERTY_CASHFLOW = "cashflow"; private String cashflow; + public BPMOptimization() { + } public BPMOptimization market(String market) { this.market = market; @@ -78,6 +80,8 @@ public String getMarket() { } + @JsonProperty(JSON_PROPERTY_MARKET) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMarket(String market) { this.market = market; } @@ -102,6 +106,8 @@ public Boolean getInvestAllCash() { } + @JsonProperty(JSON_PROPERTY_INVEST_ALL_CASH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInvestAllCash(Boolean investAllCash) { this.investAllCash = investAllCash; } @@ -126,6 +132,8 @@ public String getRiskModelDate() { } + @JsonProperty(JSON_PROPERTY_RISK_MODEL_DATE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskModelDate(String riskModelDate) { this.riskModelDate = riskModelDate; } @@ -150,6 +158,8 @@ public String getBacktestDate() { } + @JsonProperty(JSON_PROPERTY_BACKTEST_DATE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBacktestDate(String backtestDate) { this.backtestDate = backtestDate; } @@ -174,6 +184,8 @@ public String getCashflow() { } + @JsonProperty(JSON_PROPERTY_CASHFLOW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCashflow(String cashflow) { this.cashflow = cashflow; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimizationParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimizationParameters.java index fffc6ccd..b205aa1e 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimizationParameters.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimizationParameters.java @@ -58,6 +58,8 @@ public class BPMOptimizationParameters implements Serializable { public static final String JSON_PROPERTY_OUTPUT_TYPES = "outputTypes"; private OptimizerOutputTypes outputTypes; + public BPMOptimizationParameters() { + } public BPMOptimizationParameters strategy(BPMOptimizerStrategy strategy) { this.strategy = strategy; @@ -68,6 +70,7 @@ public BPMOptimizationParameters strategy(BPMOptimizerStrategy strategy) { * Get strategy * @return strategy **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_STRATEGY) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -77,6 +80,8 @@ public BPMOptimizerStrategy getStrategy() { } + @JsonProperty(JSON_PROPERTY_STRATEGY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setStrategy(BPMOptimizerStrategy strategy) { this.strategy = strategy; } @@ -101,6 +106,8 @@ public BPMOptimization getOptimization() { } + @JsonProperty(JSON_PROPERTY_OPTIMIZATION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOptimization(BPMOptimization optimization) { this.optimization = optimization; } @@ -125,6 +132,8 @@ public OptimizerAccount getAccount() { } + @JsonProperty(JSON_PROPERTY_ACCOUNT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccount(OptimizerAccount account) { this.account = account; } @@ -139,6 +148,7 @@ public BPMOptimizationParameters outputTypes(OptimizerOutputTypes outputTypes) { * Get outputTypes * @return outputTypes **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_OUTPUT_TYPES) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -148,6 +158,8 @@ public OptimizerOutputTypes getOutputTypes() { } + @JsonProperty(JSON_PROPERTY_OUTPUT_TYPES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setOutputTypes(OptimizerOutputTypes outputTypes) { this.outputTypes = outputTypes; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimizationParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimizationParametersRoot.java index 482d5245..2fcfdeb9 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimizationParametersRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimizationParametersRoot.java @@ -47,6 +47,8 @@ public class BPMOptimizationParametersRoot implements Serializable { public static final String JSON_PROPERTY_META = "meta"; private Object meta; + public BPMOptimizationParametersRoot() { + } public BPMOptimizationParametersRoot data(BPMOptimizationParameters data) { this.data = data; @@ -67,6 +69,8 @@ public BPMOptimizationParameters getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(BPMOptimizationParameters data) { this.data = data; } @@ -91,6 +95,8 @@ public Object getMeta() { } + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMeta(Object meta) { this.meta = meta; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimizerStrategy.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimizerStrategy.java index fbf6eaee..cd3dcbbb 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimizerStrategy.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimizerStrategy.java @@ -47,6 +47,8 @@ public class BPMOptimizerStrategy implements Serializable { public static final String JSON_PROPERTY_ID = "id"; private String id; + public BPMOptimizerStrategy() { + } public BPMOptimizerStrategy overrides(BPMOptimizerStrategyOverrides overrides) { this.overrides = overrides; @@ -67,6 +69,8 @@ public BPMOptimizerStrategyOverrides getOverrides() { } + @JsonProperty(JSON_PROPERTY_OVERRIDES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOverrides(BPMOptimizerStrategyOverrides overrides) { this.overrides = overrides; } @@ -81,6 +85,7 @@ public BPMOptimizerStrategy id(String id) { * OptimizerStrategy document path * @return id **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "OptimizerStrategy document path") @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -90,6 +95,8 @@ public String getId() { } + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setId(String id) { this.id = id; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimizerStrategyAlphaOverride.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimizerStrategyAlphaOverride.java index 585aa1f7..8db650c7 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimizerStrategyAlphaOverride.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimizerStrategyAlphaOverride.java @@ -91,6 +91,8 @@ public static ReturnTypeEnum fromValue(String value) { public static final String JSON_PROPERTY_RETURN_MULTIPLIER = "returnMultiplier"; private String returnMultiplier; + public BPMOptimizerStrategyAlphaOverride() { + } public BPMOptimizerStrategyAlphaOverride formula(String formula) { this.formula = formula; @@ -111,6 +113,8 @@ public String getFormula() { } + @JsonProperty(JSON_PROPERTY_FORMULA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFormula(String formula) { this.formula = formula; } @@ -135,6 +139,8 @@ public ReturnTypeEnum getReturnType() { } + @JsonProperty(JSON_PROPERTY_RETURN_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReturnType(ReturnTypeEnum returnType) { this.returnType = returnType; } @@ -159,6 +165,8 @@ public String getReturnMultiplier() { } + @JsonProperty(JSON_PROPERTY_RETURN_MULTIPLIER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReturnMultiplier(String returnMultiplier) { this.returnMultiplier = returnMultiplier; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimizerStrategyOverrides.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimizerStrategyOverrides.java index b9bffae0..04926803 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimizerStrategyOverrides.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/BPMOptimizerStrategyOverrides.java @@ -56,6 +56,8 @@ public class BPMOptimizerStrategyOverrides implements Serializable { public static final String JSON_PROPERTY_TRANSACTION_COST = "transactionCost"; private String transactionCost; + public BPMOptimizerStrategyOverrides() { + } public BPMOptimizerStrategyOverrides constraints(java.util.List constraints) { this.constraints = constraints; @@ -84,6 +86,8 @@ public java.util.List getConstraints() { } + @JsonProperty(JSON_PROPERTY_CONSTRAINTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setConstraints(java.util.List constraints) { this.constraints = constraints; } @@ -108,6 +112,8 @@ public BPMOptimizerStrategyAlphaOverride getAlpha() { } + @JsonProperty(JSON_PROPERTY_ALPHA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAlpha(BPMOptimizerStrategyAlphaOverride alpha) { this.alpha = alpha; } @@ -132,6 +138,8 @@ public String getTax() { } + @JsonProperty(JSON_PROPERTY_TAX) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTax(String tax) { this.tax = tax; } @@ -156,6 +164,8 @@ public String getTransactionCost() { } + @JsonProperty(JSON_PROPERTY_TRANSACTION_COST) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransactionCost(String transactionCost) { this.transactionCost = transactionCost; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationInfo.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationInfo.java index f0bd0783..7bbd20d7 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationInfo.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationInfo.java @@ -42,6 +42,8 @@ public class CalculationInfo implements Serializable { public static final String JSON_PROPERTY_CALCULATION_ID = "calculationId"; private String calculationId; + public CalculationInfo() { + } public CalculationInfo calculationId(String calculationId) { this.calculationId = calculationId; @@ -62,6 +64,8 @@ public String getCalculationId() { } + @JsonProperty(JSON_PROPERTY_CALCULATION_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCalculationId(String calculationId) { this.calculationId = calculationId; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationInfoRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationInfoRoot.java index 53a6211f..c7ac07ea 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationInfoRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationInfoRoot.java @@ -25,6 +25,10 @@ import factset.analyticsapi.engines.models.CalculationInfo; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; import java.io.Serializable; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import factset.analyticsapi.engines.JSON; @@ -45,8 +49,10 @@ public class CalculationInfoRoot implements Serializable { private CalculationInfo data; public static final String JSON_PROPERTY_META = "meta"; - private Object meta; + private JsonNullable meta = JsonNullable.of(null); + public CalculationInfoRoot() { + } public CalculationInfoRoot data(CalculationInfo data) { this.data = data; @@ -57,6 +63,7 @@ public CalculationInfoRoot data(CalculationInfo data) { * Get data * @return data **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -66,13 +73,15 @@ public CalculationInfo getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setData(CalculationInfo data) { this.data = data; } public CalculationInfoRoot meta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); return this; } @@ -82,16 +91,26 @@ public CalculationInfoRoot meta(Object meta) { **/ @javax.annotation.Nullable @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + @JsonProperty(JSON_PROPERTY_META) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Object getMeta() { + public JsonNullable getMeta_JsonNullable() { return meta; } - + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } public void setMeta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); } @@ -108,12 +127,23 @@ public boolean equals(Object o) { } CalculationInfoRoot calculationInfoRoot = (CalculationInfoRoot) o; return Objects.equals(this.data, calculationInfoRoot.data) && - Objects.equals(this.meta, calculationInfoRoot.meta); + equalsNullable(this.meta, calculationInfoRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); } @Override public int hashCode() { - return Objects.hash(data, meta); + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; } @Override diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationMeta.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationMeta.java index d861f5bd..add5d814 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationMeta.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationMeta.java @@ -216,6 +216,8 @@ public static FormatEnum fromValue(String value) { public static final String JSON_PROPERTY_FORMAT = "format"; private FormatEnum format = FormatEnum.JSONSTACH; + public CalculationMeta() { + } public CalculationMeta contentorganization(ContentorganizationEnum contentorganization) { this.contentorganization = contentorganization; @@ -225,7 +227,9 @@ public CalculationMeta contentorganization(ContentorganizationEnum contentorgani /** * Get contentorganization * @return contentorganization + * @deprecated **/ + @Deprecated @javax.annotation.Nullable @ApiModelProperty(value = "") @JsonProperty(JSON_PROPERTY_CONTENTORGANIZATION) @@ -236,6 +240,8 @@ public ContentorganizationEnum getContentorganization() { } + @JsonProperty(JSON_PROPERTY_CONTENTORGANIZATION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContentorganization(ContentorganizationEnum contentorganization) { this.contentorganization = contentorganization; } @@ -260,6 +266,8 @@ public StachContentOrganizationEnum getStachContentOrganization() { } + @JsonProperty(JSON_PROPERTY_STACH_CONTENT_ORGANIZATION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStachContentOrganization(StachContentOrganizationEnum stachContentOrganization) { this.stachContentOrganization = stachContentOrganization; } @@ -273,7 +281,9 @@ public CalculationMeta contenttype(ContenttypeEnum contenttype) { /** * Get contenttype * @return contenttype + * @deprecated **/ + @Deprecated @javax.annotation.Nullable @ApiModelProperty(value = "") @JsonProperty(JSON_PROPERTY_CONTENTTYPE) @@ -284,6 +294,8 @@ public ContenttypeEnum getContenttype() { } + @JsonProperty(JSON_PROPERTY_CONTENTTYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContenttype(ContenttypeEnum contenttype) { this.contenttype = contenttype; } @@ -308,6 +320,8 @@ public FormatEnum getFormat() { } + @JsonProperty(JSON_PROPERTY_FORMAT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFormat(FormatEnum format) { this.format = format; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatus.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatus.java index b70483c3..2381233f 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatus.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatus.java @@ -90,6 +90,8 @@ public static StatusEnum fromValue(String value) { public static final String JSON_PROPERTY_UNITS = "units"; private java.util.Map units = null; + public CalculationStatus() { + } public CalculationStatus calculationid(String calculationid) { this.calculationid = calculationid; @@ -110,6 +112,8 @@ public String getCalculationid() { } + @JsonProperty(JSON_PROPERTY_CALCULATIONID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCalculationid(String calculationid) { this.calculationid = calculationid; } @@ -134,6 +138,8 @@ public StatusEnum getStatus() { } + @JsonProperty(JSON_PROPERTY_STATUS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { this.status = status; } @@ -166,6 +172,8 @@ public java.util.Map getUnits() { } + @JsonProperty(JSON_PROPERTY_UNITS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUnits(java.util.Map units) { this.units = units; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatusMeta.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatusMeta.java index 2e147455..dcf24a22 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatusMeta.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatusMeta.java @@ -43,6 +43,8 @@ public class CalculationStatusMeta implements Serializable { public static final String JSON_PROPERTY_UNITS = "units"; private java.util.Map units = null; + public CalculationStatusMeta() { + } public CalculationStatusMeta units(java.util.Map units) { this.units = units; @@ -71,6 +73,8 @@ public java.util.Map getUnits() { } + @JsonProperty(JSON_PROPERTY_UNITS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUnits(java.util.Map units) { this.units = units; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatusRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatusRoot.java index 4121cd00..df20f390 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatusRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationStatusRoot.java @@ -48,6 +48,8 @@ public class CalculationStatusRoot implements Serializable { public static final String JSON_PROPERTY_META = "meta"; private CalculationStatusMeta meta; + public CalculationStatusRoot() { + } public CalculationStatusRoot data(CalculationStatus data) { this.data = data; @@ -58,6 +60,7 @@ public CalculationStatusRoot data(CalculationStatus data) { * Get data * @return data **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -67,6 +70,8 @@ public CalculationStatus getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setData(CalculationStatus data) { this.data = data; } @@ -91,6 +96,8 @@ public CalculationStatusMeta getMeta() { } + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMeta(CalculationStatusMeta meta) { this.meta = meta; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatus.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatus.java index 6cee7ea3..4f719a6b 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatus.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatus.java @@ -37,7 +37,8 @@ CalculationUnitStatus.JSON_PROPERTY_STATUS, CalculationUnitStatus.JSON_PROPERTY_ERRORS, CalculationUnitStatus.JSON_PROPERTY_RESULT, - CalculationUnitStatus.JSON_PROPERTY_PROGRESS + CalculationUnitStatus.JSON_PROPERTY_PROGRESS, + CalculationUnitStatus.JSON_PROPERTY_POINTS }) @javax.annotation.Generated(value = "CustomJavaClientCodegen") public class CalculationUnitStatus implements Serializable { @@ -96,6 +97,11 @@ public static StatusEnum fromValue(String value) { public static final String JSON_PROPERTY_PROGRESS = "progress"; private String progress; + public static final String JSON_PROPERTY_POINTS = "points"; + private Integer points; + + public CalculationUnitStatus() { + } public CalculationUnitStatus status(StatusEnum status) { this.status = status; @@ -116,6 +122,8 @@ public StatusEnum getStatus() { } + @JsonProperty(JSON_PROPERTY_STATUS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { this.status = status; } @@ -148,6 +156,8 @@ public java.util.List getErrors() { } + @JsonProperty(JSON_PROPERTY_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrors(java.util.List errors) { this.errors = errors; } @@ -172,6 +182,8 @@ public String getResult() { } + @JsonProperty(JSON_PROPERTY_RESULT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResult(String result) { this.result = result; } @@ -196,11 +208,39 @@ public String getProgress() { } + @JsonProperty(JSON_PROPERTY_PROGRESS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProgress(String progress) { this.progress = progress; } + public CalculationUnitStatus points(Integer points) { + this.points = points; + return this; + } + + /** + * The points for the calculation unit. + * @return points + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The points for the calculation unit.") + @JsonProperty(JSON_PROPERTY_POINTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Integer getPoints() { + return points; + } + + + @JsonProperty(JSON_PROPERTY_POINTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setPoints(Integer points) { + this.points = points; + } + + /** * Return true if this CalculationUnitStatus object is equal to o. */ @@ -216,12 +256,13 @@ public boolean equals(Object o) { return Objects.equals(this.status, calculationUnitStatus.status) && Objects.equals(this.errors, calculationUnitStatus.errors) && Objects.equals(this.result, calculationUnitStatus.result) && - Objects.equals(this.progress, calculationUnitStatus.progress); + Objects.equals(this.progress, calculationUnitStatus.progress) && + Objects.equals(this.points, calculationUnitStatus.points); } @Override public int hashCode() { - return Objects.hash(status, errors, result, progress); + return Objects.hash(status, errors, result, progress, points); } @Override @@ -232,6 +273,7 @@ public String toString() { sb.append(" errors: ").append(toIndentedString(errors)).append("\n"); sb.append(" result: ").append(toIndentedString(result)).append("\n"); sb.append(" progress: ").append(toIndentedString(progress)).append("\n"); + sb.append(" points: ").append(toIndentedString(points)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatusMeta.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatusMeta.java index b82df615..5373442a 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatusMeta.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CalculationUnitStatusMeta.java @@ -42,6 +42,8 @@ public class CalculationUnitStatusMeta implements Serializable { public static final String JSON_PROPERTY_INFO = "info"; private String info; + public CalculationUnitStatusMeta() { + } public CalculationUnitStatusMeta info(String info) { this.info = info; @@ -62,6 +64,8 @@ public String getInfo() { } + @JsonProperty(JSON_PROPERTY_INFO) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInfo(String info) { this.info = info; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ClientErrorResponse.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ClientErrorResponse.java index dca52a70..9e82f30f 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ClientErrorResponse.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ClientErrorResponse.java @@ -43,6 +43,8 @@ public class ClientErrorResponse implements Serializable { public static final String JSON_PROPERTY_ERRORS = "errors"; private java.util.List errors = null; + public ClientErrorResponse() { + } public ClientErrorResponse errors(java.util.List errors) { this.errors = errors; @@ -71,6 +73,8 @@ public java.util.List getErrors() { } + @JsonProperty(JSON_PROPERTY_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrors(java.util.List errors) { this.errors = errors; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Column.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Column.java index 59734eb8..489c1891 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Column.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Column.java @@ -54,6 +54,8 @@ public class Column implements Serializable { public static final String JSON_PROPERTY_CATEGORY = "category"; private String category; + public Column() { + } public Column defaultstatisticsids(java.util.List defaultstatisticsids) { this.defaultstatisticsids = defaultstatisticsids; @@ -82,6 +84,8 @@ public java.util.List getDefaultstatisticsids() { } + @JsonProperty(JSON_PROPERTY_DEFAULTSTATISTICSIDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDefaultstatisticsids(java.util.List defaultstatisticsids) { this.defaultstatisticsids = defaultstatisticsids; } @@ -106,6 +110,8 @@ public String getName() { } + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } @@ -130,6 +136,8 @@ public String getDirectory() { } + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDirectory(String directory) { this.directory = directory; } @@ -154,6 +162,8 @@ public String getCategory() { } + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCategory(String category) { this.category = category; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnRoot.java index 7d0a5597..bc96487c 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnRoot.java @@ -25,6 +25,10 @@ import factset.analyticsapi.engines.models.Column; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; import java.io.Serializable; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import factset.analyticsapi.engines.JSON; @@ -45,8 +49,10 @@ public class ColumnRoot implements Serializable { private Column data; public static final String JSON_PROPERTY_META = "meta"; - private Object meta; + private JsonNullable meta = JsonNullable.of(null); + public ColumnRoot() { + } public ColumnRoot data(Column data) { this.data = data; @@ -57,6 +63,7 @@ public ColumnRoot data(Column data) { * Get data * @return data **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -66,13 +73,15 @@ public Column getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setData(Column data) { this.data = data; } public ColumnRoot meta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); return this; } @@ -82,16 +91,26 @@ public ColumnRoot meta(Object meta) { **/ @javax.annotation.Nullable @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + @JsonProperty(JSON_PROPERTY_META) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Object getMeta() { + public JsonNullable getMeta_JsonNullable() { return meta; } - + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } public void setMeta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); } @@ -108,12 +127,23 @@ public boolean equals(Object o) { } ColumnRoot columnRoot = (ColumnRoot) o; return Objects.equals(this.data, columnRoot.data) && - Objects.equals(this.meta, columnRoot.meta); + equalsNullable(this.meta, columnRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); } @Override public int hashCode() { - return Objects.hash(data, meta); + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; } @Override diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatistic.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatistic.java index 78a24a91..f14cbe3d 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatistic.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatistic.java @@ -42,6 +42,8 @@ public class ColumnStatistic implements Serializable { public static final String JSON_PROPERTY_NAME = "name"; private String name; + public ColumnStatistic() { + } public ColumnStatistic name(String name) { this.name = name; @@ -62,6 +64,8 @@ public String getName() { } + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatisticRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatisticRoot.java index 9e0f7a3f..1dff6425 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatisticRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnStatisticRoot.java @@ -25,6 +25,10 @@ import factset.analyticsapi.engines.models.ColumnStatistic; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; import java.io.Serializable; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import factset.analyticsapi.engines.JSON; @@ -45,8 +49,10 @@ public class ColumnStatisticRoot implements Serializable { private java.util.Map data = new java.util.HashMap(); public static final String JSON_PROPERTY_META = "meta"; - private Object meta; + private JsonNullable meta = JsonNullable.of(null); + public ColumnStatisticRoot() { + } public ColumnStatisticRoot data(java.util.Map data) { this.data = data; @@ -62,6 +68,7 @@ public ColumnStatisticRoot putDataItem(String key, ColumnStatistic dataItem) { * Get data * @return data **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -71,13 +78,15 @@ public java.util.Map getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setData(java.util.Map data) { this.data = data; } public ColumnStatisticRoot meta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); return this; } @@ -87,16 +96,26 @@ public ColumnStatisticRoot meta(Object meta) { **/ @javax.annotation.Nullable @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + @JsonProperty(JSON_PROPERTY_META) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Object getMeta() { + public JsonNullable getMeta_JsonNullable() { return meta; } - + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } public void setMeta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); } @@ -113,12 +132,23 @@ public boolean equals(Object o) { } ColumnStatisticRoot columnStatisticRoot = (ColumnStatisticRoot) o; return Objects.equals(this.data, columnStatisticRoot.data) && - Objects.equals(this.meta, columnStatisticRoot.meta); + equalsNullable(this.meta, columnStatisticRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); } @Override public int hashCode() { - return Objects.hash(data, meta); + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; } @Override diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummary.java index c2c7b06f..d25db0e9 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummary.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummary.java @@ -51,6 +51,8 @@ public class ColumnSummary implements Serializable { public static final String JSON_PROPERTY_CATEGORY = "category"; private String category; + public ColumnSummary() { + } public ColumnSummary name(String name) { this.name = name; @@ -71,6 +73,8 @@ public String getName() { } + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } @@ -95,6 +99,8 @@ public String getDirectory() { } + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDirectory(String directory) { this.directory = directory; } @@ -119,6 +125,8 @@ public String getCategory() { } + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCategory(String category) { this.category = category; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummaryRoot.java index cd92b299..11f26ce4 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummaryRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ColumnSummaryRoot.java @@ -25,6 +25,10 @@ import factset.analyticsapi.engines.models.ColumnSummary; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; import java.io.Serializable; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import factset.analyticsapi.engines.JSON; @@ -45,8 +49,10 @@ public class ColumnSummaryRoot implements Serializable { private java.util.Map data = new java.util.HashMap(); public static final String JSON_PROPERTY_META = "meta"; - private Object meta; + private JsonNullable meta = JsonNullable.of(null); + public ColumnSummaryRoot() { + } public ColumnSummaryRoot data(java.util.Map data) { this.data = data; @@ -62,6 +68,7 @@ public ColumnSummaryRoot putDataItem(String key, ColumnSummary dataItem) { * Get data * @return data **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -71,13 +78,15 @@ public java.util.Map getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setData(java.util.Map data) { this.data = data; } public ColumnSummaryRoot meta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); return this; } @@ -87,16 +96,26 @@ public ColumnSummaryRoot meta(Object meta) { **/ @javax.annotation.Nullable @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + @JsonProperty(JSON_PROPERTY_META) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Object getMeta() { + public JsonNullable getMeta_JsonNullable() { return meta; } - + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } public void setMeta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); } @@ -113,12 +132,23 @@ public boolean equals(Object o) { } ColumnSummaryRoot columnSummaryRoot = (ColumnSummaryRoot) o; return Objects.equals(this.data, columnSummaryRoot.data) && - Objects.equals(this.meta, columnSummaryRoot.meta); + equalsNullable(this.meta, columnSummaryRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); } @Override public int hashCode() { - return Objects.hash(data, meta); + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; } @Override diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ComponentSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ComponentSummary.java index c936aed7..3017bfa1 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ComponentSummary.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ComponentSummary.java @@ -46,6 +46,8 @@ public class ComponentSummary implements Serializable { public static final String JSON_PROPERTY_CATEGORY = "category"; private String category; + public ComponentSummary() { + } public ComponentSummary name(String name) { this.name = name; @@ -66,6 +68,8 @@ public String getName() { } + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } @@ -90,6 +94,8 @@ public String getCategory() { } + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCategory(String category) { this.category = category; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ComponentSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ComponentSummaryRoot.java index bb1db1b7..c08811e2 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ComponentSummaryRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ComponentSummaryRoot.java @@ -25,6 +25,10 @@ import factset.analyticsapi.engines.models.ComponentSummary; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; import java.io.Serializable; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import factset.analyticsapi.engines.JSON; @@ -45,8 +49,10 @@ public class ComponentSummaryRoot implements Serializable { private java.util.Map data = new java.util.HashMap(); public static final String JSON_PROPERTY_META = "meta"; - private Object meta; + private JsonNullable meta = JsonNullable.of(null); + public ComponentSummaryRoot() { + } public ComponentSummaryRoot data(java.util.Map data) { this.data = data; @@ -62,6 +68,7 @@ public ComponentSummaryRoot putDataItem(String key, ComponentSummary dataItem) { * Get data * @return data **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -71,13 +78,15 @@ public java.util.Map getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setData(java.util.Map data) { this.data = data; } public ComponentSummaryRoot meta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); return this; } @@ -87,16 +96,26 @@ public ComponentSummaryRoot meta(Object meta) { **/ @javax.annotation.Nullable @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + @JsonProperty(JSON_PROPERTY_META) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Object getMeta() { + public JsonNullable getMeta_JsonNullable() { return meta; } - + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } public void setMeta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); } @@ -113,12 +132,23 @@ public boolean equals(Object o) { } ComponentSummaryRoot componentSummaryRoot = (ComponentSummaryRoot) o; return Objects.equals(this.data, componentSummaryRoot.data) && - Objects.equals(this.meta, componentSummaryRoot.meta); + equalsNullable(this.meta, componentSummaryRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); } @Override public int hashCode() { - return Objects.hash(data, meta); + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; } @Override diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ConfigurationAccount.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ConfigurationAccount.java index bd3228e6..f44b42ba 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ConfigurationAccount.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ConfigurationAccount.java @@ -62,6 +62,8 @@ public class ConfigurationAccount implements Serializable { public static final String JSON_PROPERTY_NAME = "name"; private String name; + public ConfigurationAccount() { + } public ConfigurationAccount benchmarkCode(String benchmarkCode) { this.benchmarkCode = benchmarkCode; @@ -82,6 +84,8 @@ public String getBenchmarkCode() { } + @JsonProperty(JSON_PROPERTY_BENCHMARK_CODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBenchmarkCode(String benchmarkCode) { this.benchmarkCode = benchmarkCode; } @@ -106,6 +110,8 @@ public String getBenchmarkName() { } + @JsonProperty(JSON_PROPERTY_BENCHMARK_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBenchmarkName(String benchmarkName) { this.benchmarkName = benchmarkName; } @@ -130,6 +136,8 @@ public String getMaxEndDate() { } + @JsonProperty(JSON_PROPERTY_MAX_END_DATE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMaxEndDate(String maxEndDate) { this.maxEndDate = maxEndDate; } @@ -154,6 +162,8 @@ public String getMinStartDate() { } + @JsonProperty(JSON_PROPERTY_MIN_START_DATE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMinStartDate(String minStartDate) { this.minStartDate = minStartDate; } @@ -178,6 +188,8 @@ public String getLockingDate() { } + @JsonProperty(JSON_PROPERTY_LOCKING_DATE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLockingDate(String lockingDate) { this.lockingDate = lockingDate; } @@ -202,6 +214,8 @@ public String getName() { } + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ConstraintAction.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ConstraintAction.java index 9ad9bdaa..2c12df30 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ConstraintAction.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ConstraintAction.java @@ -81,6 +81,8 @@ public static Item2Enum fromValue(String value) { public static final String JSON_PROPERTY_ITEM2 = "item2"; private Item2Enum item2; + public ConstraintAction() { + } public ConstraintAction item1(String item1) { this.item1 = item1; @@ -101,6 +103,8 @@ public String getItem1() { } + @JsonProperty(JSON_PROPERTY_ITEM1) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setItem1(String item1) { this.item1 = item1; } @@ -125,6 +129,8 @@ public Item2Enum getItem2() { } + @JsonProperty(JSON_PROPERTY_ITEM2) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setItem2(Item2Enum item2) { this.item2 = item2; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Currency.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Currency.java index 1e808c23..2255df8e 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Currency.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Currency.java @@ -42,6 +42,8 @@ public class Currency implements Serializable { public static final String JSON_PROPERTY_NAME = "name"; private String name; + public Currency() { + } public Currency name(String name) { this.name = name; @@ -62,6 +64,8 @@ public String getName() { } + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CurrencyRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CurrencyRoot.java index 529c8a3e..246ccb20 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CurrencyRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/CurrencyRoot.java @@ -25,6 +25,10 @@ import factset.analyticsapi.engines.models.Currency; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; import java.io.Serializable; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import factset.analyticsapi.engines.JSON; @@ -45,8 +49,10 @@ public class CurrencyRoot implements Serializable { private java.util.Map data = new java.util.HashMap(); public static final String JSON_PROPERTY_META = "meta"; - private Object meta; + private JsonNullable meta = JsonNullable.of(null); + public CurrencyRoot() { + } public CurrencyRoot data(java.util.Map data) { this.data = data; @@ -62,6 +68,7 @@ public CurrencyRoot putDataItem(String key, Currency dataItem) { * Get data * @return data **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -71,13 +78,15 @@ public java.util.Map getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setData(java.util.Map data) { this.data = data; } public CurrencyRoot meta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); return this; } @@ -87,16 +96,26 @@ public CurrencyRoot meta(Object meta) { **/ @javax.annotation.Nullable @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + @JsonProperty(JSON_PROPERTY_META) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Object getMeta() { + public JsonNullable getMeta_JsonNullable() { return meta; } - + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } public void setMeta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); } @@ -113,12 +132,23 @@ public boolean equals(Object o) { } CurrencyRoot currencyRoot = (CurrencyRoot) o; return Objects.equals(this.data, currencyRoot.data) && - Objects.equals(this.meta, currencyRoot.meta); + equalsNullable(this.meta, currencyRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); } @Override public int hashCode() { - return Objects.hash(data, meta); + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; } @Override diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/DateParametersSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/DateParametersSummary.java index 46793192..da6dd6ab 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/DateParametersSummary.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/DateParametersSummary.java @@ -46,6 +46,8 @@ public class DateParametersSummary implements Serializable { public static final String JSON_PROPERTY_ENDDATE = "enddate"; private String enddate; + public DateParametersSummary() { + } public DateParametersSummary startdate(String startdate) { this.startdate = startdate; @@ -66,6 +68,8 @@ public String getStartdate() { } + @JsonProperty(JSON_PROPERTY_STARTDATE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStartdate(String startdate) { this.startdate = startdate; } @@ -90,6 +94,8 @@ public String getEnddate() { } + @JsonProperty(JSON_PROPERTY_ENDDATE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnddate(String enddate) { this.enddate = enddate; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/DateParametersSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/DateParametersSummaryRoot.java index ca3795b8..92a4ac0b 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/DateParametersSummaryRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/DateParametersSummaryRoot.java @@ -25,6 +25,10 @@ import factset.analyticsapi.engines.models.DateParametersSummary; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; import java.io.Serializable; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import factset.analyticsapi.engines.JSON; @@ -45,8 +49,10 @@ public class DateParametersSummaryRoot implements Serializable { private DateParametersSummary data; public static final String JSON_PROPERTY_META = "meta"; - private Object meta; + private JsonNullable meta = JsonNullable.of(null); + public DateParametersSummaryRoot() { + } public DateParametersSummaryRoot data(DateParametersSummary data) { this.data = data; @@ -57,6 +63,7 @@ public DateParametersSummaryRoot data(DateParametersSummary data) { * Get data * @return data **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -66,13 +73,15 @@ public DateParametersSummary getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setData(DateParametersSummary data) { this.data = data; } public DateParametersSummaryRoot meta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); return this; } @@ -82,16 +91,26 @@ public DateParametersSummaryRoot meta(Object meta) { **/ @javax.annotation.Nullable @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + @JsonProperty(JSON_PROPERTY_META) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Object getMeta() { + public JsonNullable getMeta_JsonNullable() { return meta; } - + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } public void setMeta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); } @@ -108,12 +127,23 @@ public boolean equals(Object o) { } DateParametersSummaryRoot dateParametersSummaryRoot = (DateParametersSummaryRoot) o; return Objects.equals(this.data, dateParametersSummaryRoot.data) && - Objects.equals(this.meta, dateParametersSummaryRoot.meta); + equalsNullable(this.meta, dateParametersSummaryRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); } @Override public int hashCode() { - return Objects.hash(data, meta); + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; } @Override diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/DocumentDirectories.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/DocumentDirectories.java index 55c4a709..1507c6e4 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/DocumentDirectories.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/DocumentDirectories.java @@ -46,6 +46,8 @@ public class DocumentDirectories implements Serializable { public static final String JSON_PROPERTY_DIRECTORIES = "directories"; private java.util.List directories = null; + public DocumentDirectories() { + } public DocumentDirectories documents(java.util.List documents) { this.documents = documents; @@ -74,6 +76,8 @@ public java.util.List getDocuments() { } + @JsonProperty(JSON_PROPERTY_DOCUMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDocuments(java.util.List documents) { this.documents = documents; } @@ -106,6 +110,8 @@ public java.util.List getDirectories() { } + @JsonProperty(JSON_PROPERTY_DIRECTORIES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDirectories(java.util.List directories) { this.directories = directories; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/DocumentDirectoriesRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/DocumentDirectoriesRoot.java index ff3e684b..842e2551 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/DocumentDirectoriesRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/DocumentDirectoriesRoot.java @@ -25,6 +25,10 @@ import factset.analyticsapi.engines.models.DocumentDirectories; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; import java.io.Serializable; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import factset.analyticsapi.engines.JSON; @@ -45,8 +49,10 @@ public class DocumentDirectoriesRoot implements Serializable { private DocumentDirectories data; public static final String JSON_PROPERTY_META = "meta"; - private Object meta; + private JsonNullable meta = JsonNullable.of(null); + public DocumentDirectoriesRoot() { + } public DocumentDirectoriesRoot data(DocumentDirectories data) { this.data = data; @@ -57,6 +63,7 @@ public DocumentDirectoriesRoot data(DocumentDirectories data) { * Get data * @return data **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -66,13 +73,15 @@ public DocumentDirectories getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setData(DocumentDirectories data) { this.data = data; } public DocumentDirectoriesRoot meta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); return this; } @@ -82,16 +91,26 @@ public DocumentDirectoriesRoot meta(Object meta) { **/ @javax.annotation.Nullable @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + @JsonProperty(JSON_PROPERTY_META) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Object getMeta() { + public JsonNullable getMeta_JsonNullable() { return meta; } - + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } public void setMeta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); } @@ -108,12 +127,23 @@ public boolean equals(Object o) { } DocumentDirectoriesRoot documentDirectoriesRoot = (DocumentDirectoriesRoot) o; return Objects.equals(this.data, documentDirectoriesRoot.data) && - Objects.equals(this.meta, documentDirectoriesRoot.meta); + equalsNullable(this.meta, documentDirectoriesRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); } @Override public int hashCode() { - return Objects.hash(data, meta); + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; } @Override diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Error.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Error.java index db98695e..dbe28755 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Error.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Error.java @@ -51,6 +51,8 @@ public class Error implements Serializable { public static final String JSON_PROPERTY_SOURCE = "source"; private ErrorSource source; + public Error() { + } public Error id(String id) { this.id = id; @@ -71,6 +73,8 @@ public String getId() { } + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { this.id = id; } @@ -95,6 +99,8 @@ public String getDetail() { } + @JsonProperty(JSON_PROPERTY_DETAIL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDetail(String detail) { this.detail = detail; } @@ -119,6 +125,8 @@ public ErrorSource getSource() { } + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSource(ErrorSource source) { this.source = source; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ErrorSource.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ErrorSource.java index a71d69d8..e85ed7be 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ErrorSource.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ErrorSource.java @@ -46,6 +46,8 @@ public class ErrorSource implements Serializable { public static final String JSON_PROPERTY_PARAMETER = "parameter"; private String parameter; + public ErrorSource() { + } public ErrorSource pointer(String pointer) { this.pointer = pointer; @@ -66,6 +68,8 @@ public String getPointer() { } + @JsonProperty(JSON_PROPERTY_POINTER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPointer(String pointer) { this.pointer = pointer; } @@ -90,6 +94,8 @@ public String getParameter() { } + @JsonProperty(JSON_PROPERTY_PARAMETER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setParameter(String parameter) { this.parameter = parameter; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/EventSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/EventSummary.java index 83f59684..167c6532 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/EventSummary.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/EventSummary.java @@ -51,6 +51,8 @@ public class EventSummary implements Serializable { public static final String JSON_PROPERTY_TYPE = "type"; private String type; + public EventSummary() { + } public EventSummary message(String message) { this.message = message; @@ -71,6 +73,8 @@ public String getMessage() { } + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { this.message = message; } @@ -95,6 +99,8 @@ public OffsetDateTime getSubmissiondatetime() { } + @JsonProperty(JSON_PROPERTY_SUBMISSIONDATETIME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubmissiondatetime(OffsetDateTime submissiondatetime) { this.submissiondatetime = submissiondatetime; } @@ -119,6 +125,8 @@ public String getType() { } + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { this.type = type; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIABCalculationParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIABCalculationParameters.java index b10af773..4c3591b8 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIABCalculationParameters.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIABCalculationParameters.java @@ -60,6 +60,8 @@ public class FIABCalculationParameters implements Serializable { public static final String JSON_PROPERTY_FISETTINGSDOCUMENT = "fisettingsdocument"; private String fisettingsdocument; + public FIABCalculationParameters() { + } public FIABCalculationParameters fiabdocument(String fiabdocument) { this.fiabdocument = fiabdocument; @@ -80,6 +82,8 @@ public String getFiabdocument() { } + @JsonProperty(JSON_PROPERTY_FIABDOCUMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFiabdocument(String fiabdocument) { this.fiabdocument = fiabdocument; } @@ -94,6 +98,7 @@ public FIABCalculationParameters account(FIABIdentifier account) { * Get account * @return account **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_ACCOUNT) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -103,6 +108,8 @@ public FIABIdentifier getAccount() { } + @JsonProperty(JSON_PROPERTY_ACCOUNT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAccount(FIABIdentifier account) { this.account = account; } @@ -117,6 +124,7 @@ public FIABCalculationParameters dates(FIABDateParameters dates) { * Get dates * @return dates **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_DATES) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -126,6 +134,8 @@ public FIABDateParameters getDates() { } + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setDates(FIABDateParameters dates) { this.dates = dates; } @@ -150,6 +160,8 @@ public String getMsl() { } + @JsonProperty(JSON_PROPERTY_MSL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMsl(String msl) { this.msl = msl; } @@ -174,6 +186,8 @@ public String getFisettingsdocument() { } + @JsonProperty(JSON_PROPERTY_FISETTINGSDOCUMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFisettingsdocument(String fisettingsdocument) { this.fisettingsdocument = fisettingsdocument; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIABCalculationStatus.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIABCalculationStatus.java index 20567381..ff312138 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIABCalculationStatus.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIABCalculationStatus.java @@ -107,6 +107,8 @@ public static StatusEnum fromValue(String value) { public static final String JSON_PROPERTY_BATCHEVENTS = "batchevents"; private java.util.List batchevents = null; + public FIABCalculationStatus() { + } public FIABCalculationStatus id(String id) { this.id = id; @@ -127,6 +129,8 @@ public String getId() { } + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { this.id = id; } @@ -151,6 +155,8 @@ public StatusEnum getStatus() { } + @JsonProperty(JSON_PROPERTY_STATUS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { this.status = status; } @@ -175,6 +181,8 @@ public OffsetDateTime getStartdatetime() { } + @JsonProperty(JSON_PROPERTY_STARTDATETIME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStartdatetime(OffsetDateTime startdatetime) { this.startdatetime = startdatetime; } @@ -199,6 +207,8 @@ public OffsetDateTime getCompletiondatetime() { } + @JsonProperty(JSON_PROPERTY_COMPLETIONDATETIME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompletiondatetime(OffsetDateTime completiondatetime) { this.completiondatetime = completiondatetime; } @@ -223,6 +233,8 @@ public Integer getProgress() { } + @JsonProperty(JSON_PROPERTY_PROGRESS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProgress(Integer progress) { this.progress = progress; } @@ -255,6 +267,8 @@ public java.util.List getBatchevents() { } + @JsonProperty(JSON_PROPERTY_BATCHEVENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBatchevents(java.util.List batchevents) { this.batchevents = batchevents; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIABCalculationStatusSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIABCalculationStatusSummary.java index a9607699..530c52f0 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIABCalculationStatusSummary.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIABCalculationStatusSummary.java @@ -47,6 +47,8 @@ public class FIABCalculationStatusSummary implements Serializable { public static final String JSON_PROPERTY_LASTPOLLTIME = "lastpolltime"; private OffsetDateTime lastpolltime; + public FIABCalculationStatusSummary() { + } public FIABCalculationStatusSummary requesttime(OffsetDateTime requesttime) { this.requesttime = requesttime; @@ -67,6 +69,8 @@ public OffsetDateTime getRequesttime() { } + @JsonProperty(JSON_PROPERTY_REQUESTTIME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequesttime(OffsetDateTime requesttime) { this.requesttime = requesttime; } @@ -91,6 +95,8 @@ public OffsetDateTime getLastpolltime() { } + @JsonProperty(JSON_PROPERTY_LASTPOLLTIME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastpolltime(OffsetDateTime lastpolltime) { this.lastpolltime = lastpolltime; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIABDateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIABDateParameters.java index adbf0cdd..da276ff9 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIABDateParameters.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIABDateParameters.java @@ -47,6 +47,8 @@ public class FIABDateParameters implements Serializable { public static final String JSON_PROPERTY_ENDDATE = "enddate"; private String enddate; + public FIABDateParameters() { + } public FIABDateParameters startdate(String startdate) { this.startdate = startdate; @@ -57,6 +59,7 @@ public FIABDateParameters startdate(String startdate) { * Calculation's start date. * @return startdate **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "Calculation's start date.") @JsonProperty(JSON_PROPERTY_STARTDATE) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -66,6 +69,8 @@ public String getStartdate() { } + @JsonProperty(JSON_PROPERTY_STARTDATE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setStartdate(String startdate) { this.startdate = startdate; } @@ -80,6 +85,7 @@ public FIABDateParameters enddate(String enddate) { * Calculation's end date. * @return enddate **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "Calculation's end date.") @JsonProperty(JSON_PROPERTY_ENDDATE) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -89,6 +95,8 @@ public String getEnddate() { } + @JsonProperty(JSON_PROPERTY_ENDDATE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setEnddate(String enddate) { this.enddate = enddate; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIABIdentifier.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIABIdentifier.java index a3f0e43e..60179c62 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIABIdentifier.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIABIdentifier.java @@ -42,6 +42,8 @@ public class FIABIdentifier implements Serializable { public static final String JSON_PROPERTY_ID = "id"; private String id; + public FIABIdentifier() { + } public FIABIdentifier id(String id) { this.id = id; @@ -52,6 +54,7 @@ public FIABIdentifier id(String id) { * User's FactSet account path. * @return id **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "User's FactSet account path.") @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -61,6 +64,8 @@ public String getId() { } + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setId(String id) { this.id = id; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FICalculationParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FICalculationParameters.java index bd5915ff..49365169 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FICalculationParameters.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FICalculationParameters.java @@ -52,6 +52,8 @@ public class FICalculationParameters implements Serializable { public static final String JSON_PROPERTY_JOB_SETTINGS = "jobSettings"; private FIJobSettings jobSettings; + public FICalculationParameters() { + } public FICalculationParameters securities(java.util.List securities) { this.securities = securities; @@ -67,6 +69,7 @@ public FICalculationParameters addSecuritiesItem(FISecurity securitiesItem) { * List of securities * @return securities **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "List of securities") @JsonProperty(JSON_PROPERTY_SECURITIES) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -76,6 +79,8 @@ public java.util.List getSecurities() { } + @JsonProperty(JSON_PROPERTY_SECURITIES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSecurities(java.util.List securities) { this.securities = securities; } @@ -95,6 +100,7 @@ public FICalculationParameters addCalculationsItem(String calculationsItem) { * List of calculations * @return calculations **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "List of calculations") @JsonProperty(JSON_PROPERTY_CALCULATIONS) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -104,6 +110,8 @@ public java.util.List getCalculations() { } + @JsonProperty(JSON_PROPERTY_CALCULATIONS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCalculations(java.util.List calculations) { this.calculations = calculations; } @@ -118,6 +126,7 @@ public FICalculationParameters jobSettings(FIJobSettings jobSettings) { * Get jobSettings * @return jobSettings **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_JOB_SETTINGS) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -127,6 +136,8 @@ public FIJobSettings getJobSettings() { } + @JsonProperty(JSON_PROPERTY_JOB_SETTINGS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setJobSettings(FIJobSettings jobSettings) { this.jobSettings = jobSettings; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FICalculationParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FICalculationParametersRoot.java index 4dcf2208..3cc26413 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FICalculationParametersRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FICalculationParametersRoot.java @@ -48,6 +48,8 @@ public class FICalculationParametersRoot implements Serializable { public static final String JSON_PROPERTY_META = "meta"; private CalculationMeta meta; + public FICalculationParametersRoot() { + } public FICalculationParametersRoot data(FICalculationParameters data) { this.data = data; @@ -68,6 +70,8 @@ public FICalculationParameters getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(FICalculationParameters data) { this.data = data; } @@ -92,6 +96,8 @@ public CalculationMeta getMeta() { } + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMeta(CalculationMeta meta) { this.meta = meta; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIJobSettings.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIJobSettings.java index fec07070..f1c0ce4d 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIJobSettings.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIJobSettings.java @@ -34,7 +34,10 @@ */ @JsonPropertyOrder({ FIJobSettings.JSON_PROPERTY_AS_OF_DATE, - FIJobSettings.JSON_PROPERTY_PARTIAL_DURATION_MONTHS + FIJobSettings.JSON_PROPERTY_PARTIAL_DURATION_MONTHS, + FIJobSettings.JSON_PROPERTY_CALL_METHOD, + FIJobSettings.JSON_PROPERTY_SETTLEMENT, + FIJobSettings.JSON_PROPERTY_CALC_FROM_METHOD }) @javax.annotation.Generated(value = "CustomJavaClientCodegen") public class FIJobSettings implements Serializable { @@ -46,6 +49,56 @@ public class FIJobSettings implements Serializable { public static final String JSON_PROPERTY_PARTIAL_DURATION_MONTHS = "partialDurationMonths"; private java.util.List partialDurationMonths = null; + /** + * Call Method + */ + public enum CallMethodEnum { + NO_CALL("No Call"), + + INTRINSIC_VALUE("Intrinsic Value"), + + FIRST_CALL("First Call"), + + FIRST_PAR("First Par"); + + private String value; + + CallMethodEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static CallMethodEnum fromValue(String value) { + for (CallMethodEnum b : CallMethodEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_CALL_METHOD = "callMethod"; + private CallMethodEnum callMethod; + + public static final String JSON_PROPERTY_SETTLEMENT = "settlement"; + private String settlement; + + public static final String JSON_PROPERTY_CALC_FROM_METHOD = "calcFromMethod"; + private String calcFromMethod; + + public FIJobSettings() { + } public FIJobSettings asOfDate(String asOfDate) { this.asOfDate = asOfDate; @@ -56,6 +109,7 @@ public FIJobSettings asOfDate(String asOfDate) { * As of date * @return asOfDate **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "As of date") @JsonProperty(JSON_PROPERTY_AS_OF_DATE) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -65,6 +119,8 @@ public String getAsOfDate() { } + @JsonProperty(JSON_PROPERTY_AS_OF_DATE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAsOfDate(String asOfDate) { this.asOfDate = asOfDate; } @@ -97,11 +153,91 @@ public java.util.List getPartialDurationMonths() { } + @JsonProperty(JSON_PROPERTY_PARTIAL_DURATION_MONTHS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPartialDurationMonths(java.util.List partialDurationMonths) { this.partialDurationMonths = partialDurationMonths; } + public FIJobSettings callMethod(CallMethodEnum callMethod) { + this.callMethod = callMethod; + return this; + } + + /** + * Call Method + * @return callMethod + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Call Method") + @JsonProperty(JSON_PROPERTY_CALL_METHOD) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public CallMethodEnum getCallMethod() { + return callMethod; + } + + + @JsonProperty(JSON_PROPERTY_CALL_METHOD) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCallMethod(CallMethodEnum callMethod) { + this.callMethod = callMethod; + } + + + public FIJobSettings settlement(String settlement) { + this.settlement = settlement; + return this; + } + + /** + * Settlement Date + * @return settlement + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Settlement Date") + @JsonProperty(JSON_PROPERTY_SETTLEMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSettlement() { + return settlement; + } + + + @JsonProperty(JSON_PROPERTY_SETTLEMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSettlement(String settlement) { + this.settlement = settlement; + } + + + public FIJobSettings calcFromMethod(String calcFromMethod) { + this.calcFromMethod = calcFromMethod; + return this; + } + + /** + * 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 + * @return calcFromMethod + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "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") + @JsonProperty(JSON_PROPERTY_CALC_FROM_METHOD) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCalcFromMethod() { + return calcFromMethod; + } + + + @JsonProperty(JSON_PROPERTY_CALC_FROM_METHOD) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCalcFromMethod(String calcFromMethod) { + this.calcFromMethod = calcFromMethod; + } + + /** * Return true if this FIJobSettings object is equal to o. */ @@ -115,12 +251,15 @@ public boolean equals(Object o) { } FIJobSettings fiJobSettings = (FIJobSettings) o; return Objects.equals(this.asOfDate, fiJobSettings.asOfDate) && - Objects.equals(this.partialDurationMonths, fiJobSettings.partialDurationMonths); + Objects.equals(this.partialDurationMonths, fiJobSettings.partialDurationMonths) && + Objects.equals(this.callMethod, fiJobSettings.callMethod) && + Objects.equals(this.settlement, fiJobSettings.settlement) && + Objects.equals(this.calcFromMethod, fiJobSettings.calcFromMethod); } @Override public int hashCode() { - return Objects.hash(asOfDate, partialDurationMonths); + return Objects.hash(asOfDate, partialDurationMonths, callMethod, settlement, calcFromMethod); } @Override @@ -129,6 +268,9 @@ public String toString() { sb.append("class FIJobSettings {\n"); sb.append(" asOfDate: ").append(toIndentedString(asOfDate)).append("\n"); sb.append(" partialDurationMonths: ").append(toIndentedString(partialDurationMonths)).append("\n"); + sb.append(" callMethod: ").append(toIndentedString(callMethod)).append("\n"); + sb.append(" settlement: ").append(toIndentedString(settlement)).append("\n"); + sb.append(" calcFromMethod: ").append(toIndentedString(calcFromMethod)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FILoss.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FILoss.java new file mode 100644 index 00000000..fd8f20e5 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FILoss.java @@ -0,0 +1,115 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * FILoss + */ +@JsonPropertyOrder({ + FILoss.JSON_PROPERTY_LOSS_NAME +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class FILoss implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_LOSS_NAME = "lossName"; + private String lossName; + + public FILoss() { + } + + public FILoss lossName(String lossName) { + this.lossName = lossName; + return this; + } + + /** + * Loss Name + * @return lossName + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Loss Name") + @JsonProperty(JSON_PROPERTY_LOSS_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getLossName() { + return lossName; + } + + + @JsonProperty(JSON_PROPERTY_LOSS_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setLossName(String lossName) { + this.lossName = lossName; + } + + + /** + * Return true if this FILoss object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FILoss fiLoss = (FILoss) o; + return Objects.equals(this.lossName, fiLoss.lossName); + } + + @Override + public int hashCode() { + return Objects.hash(lossName); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FILoss {\n"); + sb.append(" lossName: ").append(toIndentedString(lossName)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIPrepay.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIPrepay.java new file mode 100644 index 00000000..f85b9adc --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIPrepay.java @@ -0,0 +1,115 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * FIPrepay + */ +@JsonPropertyOrder({ + FIPrepay.JSON_PROPERTY_PREPAY_NAME +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class FIPrepay implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_PREPAY_NAME = "prepayName"; + private String prepayName; + + public FIPrepay() { + } + + public FIPrepay prepayName(String prepayName) { + this.prepayName = prepayName; + return this; + } + + /** + * Prepay Name + * @return prepayName + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Prepay Name") + @JsonProperty(JSON_PROPERTY_PREPAY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getPrepayName() { + return prepayName; + } + + + @JsonProperty(JSON_PROPERTY_PREPAY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setPrepayName(String prepayName) { + this.prepayName = prepayName; + } + + + /** + * Return true if this FIPrepay object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FIPrepay fiPrepay = (FIPrepay) o; + return Objects.equals(this.prepayName, fiPrepay.prepayName); + } + + @Override + public int hashCode() { + return Objects.hash(prepayName); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FIPrepay {\n"); + sb.append(" prepayName: ").append(toIndentedString(prepayName)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIReferencePrepay.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIReferencePrepay.java new file mode 100644 index 00000000..c7b96491 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIReferencePrepay.java @@ -0,0 +1,115 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * FIReferencePrepay + */ +@JsonPropertyOrder({ + FIReferencePrepay.JSON_PROPERTY_PREPAY_NAME +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class FIReferencePrepay implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_PREPAY_NAME = "prepayName"; + private String prepayName; + + public FIReferencePrepay() { + } + + public FIReferencePrepay prepayName(String prepayName) { + this.prepayName = prepayName; + return this; + } + + /** + * Reference Prepay Name + * @return prepayName + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Reference Prepay Name") + @JsonProperty(JSON_PROPERTY_PREPAY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getPrepayName() { + return prepayName; + } + + + @JsonProperty(JSON_PROPERTY_PREPAY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setPrepayName(String prepayName) { + this.prepayName = prepayName; + } + + + /** + * Return true if this FIReferencePrepay object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FIReferencePrepay fiReferencePrepay = (FIReferencePrepay) o; + return Objects.equals(this.prepayName, fiReferencePrepay.prepayName); + } + + @Override + public int hashCode() { + return Objects.hash(prepayName); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FIReferencePrepay {\n"); + sb.append(" prepayName: ").append(toIndentedString(prepayName)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIReferenceSecurity.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIReferenceSecurity.java new file mode 100644 index 00000000..2ad02bd2 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FIReferenceSecurity.java @@ -0,0 +1,276 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.FIReferencePrepay; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * FIReferenceSecurity + */ +@JsonPropertyOrder({ + FIReferenceSecurity.JSON_PROPERTY_SECURITY_TYPE, + FIReferenceSecurity.JSON_PROPERTY_SECURITY_NAME, + FIReferenceSecurity.JSON_PROPERTY_CALC_FROM_METHOD, + FIReferenceSecurity.JSON_PROPERTY_CALC_FROM_VALUE, + FIReferenceSecurity.JSON_PROPERTY_PREPAY, + FIReferenceSecurity.JSON_PROPERTY_SETTLEMENT +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class FIReferenceSecurity implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_SECURITY_TYPE = "securityType"; + private String securityType; + + public static final String JSON_PROPERTY_SECURITY_NAME = "securityName"; + private String securityName; + + public static final String JSON_PROPERTY_CALC_FROM_METHOD = "calcFromMethod"; + private String calcFromMethod; + + public static final String JSON_PROPERTY_CALC_FROM_VALUE = "calcFromValue"; + private Double calcFromValue; + + public static final String JSON_PROPERTY_PREPAY = "prepay"; + private FIReferencePrepay prepay; + + public static final String JSON_PROPERTY_SETTLEMENT = "settlement"; + private String settlement; + + public FIReferenceSecurity() { + } + + public FIReferenceSecurity securityType(String securityType) { + this.securityType = securityType; + return this; + } + + /** + * Reference Security Type + * @return securityType + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Reference Security Type") + @JsonProperty(JSON_PROPERTY_SECURITY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSecurityType() { + return securityType; + } + + + @JsonProperty(JSON_PROPERTY_SECURITY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSecurityType(String securityType) { + this.securityType = securityType; + } + + + public FIReferenceSecurity securityName(String securityName) { + this.securityName = securityName; + return this; + } + + /** + * Reference Security Name + * @return securityName + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Reference Security Name") + @JsonProperty(JSON_PROPERTY_SECURITY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSecurityName() { + return securityName; + } + + + @JsonProperty(JSON_PROPERTY_SECURITY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSecurityName(String securityName) { + this.securityName = securityName; + } + + + public FIReferenceSecurity calcFromMethod(String calcFromMethod) { + this.calcFromMethod = calcFromMethod; + return this; + } + + /** + * Reference 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 + * @return calcFromMethod + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Reference 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") + @JsonProperty(JSON_PROPERTY_CALC_FROM_METHOD) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCalcFromMethod() { + return calcFromMethod; + } + + + @JsonProperty(JSON_PROPERTY_CALC_FROM_METHOD) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCalcFromMethod(String calcFromMethod) { + this.calcFromMethod = calcFromMethod; + } + + + public FIReferenceSecurity calcFromValue(Double calcFromValue) { + this.calcFromValue = calcFromValue; + return this; + } + + /** + * Reference CalcFromValue + * @return calcFromValue + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Reference CalcFromValue") + @JsonProperty(JSON_PROPERTY_CALC_FROM_VALUE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Double getCalcFromValue() { + return calcFromValue; + } + + + @JsonProperty(JSON_PROPERTY_CALC_FROM_VALUE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCalcFromValue(Double calcFromValue) { + this.calcFromValue = calcFromValue; + } + + + public FIReferenceSecurity prepay(FIReferencePrepay prepay) { + this.prepay = prepay; + return this; + } + + /** + * Get prepay + * @return prepay + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_PREPAY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public FIReferencePrepay getPrepay() { + return prepay; + } + + + @JsonProperty(JSON_PROPERTY_PREPAY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setPrepay(FIReferencePrepay prepay) { + this.prepay = prepay; + } + + + public FIReferenceSecurity settlement(String settlement) { + this.settlement = settlement; + return this; + } + + /** + * Reference Settlement Date + * @return settlement + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Reference Settlement Date") + @JsonProperty(JSON_PROPERTY_SETTLEMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSettlement() { + return settlement; + } + + + @JsonProperty(JSON_PROPERTY_SETTLEMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSettlement(String settlement) { + this.settlement = settlement; + } + + + /** + * Return true if this FIReferenceSecurity object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FIReferenceSecurity fiReferenceSecurity = (FIReferenceSecurity) o; + return Objects.equals(this.securityType, fiReferenceSecurity.securityType) && + Objects.equals(this.securityName, fiReferenceSecurity.securityName) && + Objects.equals(this.calcFromMethod, fiReferenceSecurity.calcFromMethod) && + Objects.equals(this.calcFromValue, fiReferenceSecurity.calcFromValue) && + Objects.equals(this.prepay, fiReferenceSecurity.prepay) && + Objects.equals(this.settlement, fiReferenceSecurity.settlement); + } + + @Override + public int hashCode() { + return Objects.hash(securityType, securityName, calcFromMethod, calcFromValue, prepay, settlement); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FIReferenceSecurity {\n"); + sb.append(" securityType: ").append(toIndentedString(securityType)).append("\n"); + sb.append(" securityName: ").append(toIndentedString(securityName)).append("\n"); + sb.append(" calcFromMethod: ").append(toIndentedString(calcFromMethod)).append("\n"); + sb.append(" calcFromValue: ").append(toIndentedString(calcFromValue)).append("\n"); + sb.append(" prepay: ").append(toIndentedString(prepay)).append("\n"); + sb.append(" settlement: ").append(toIndentedString(settlement)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FISecurity.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FISecurity.java index 3d0485dd..6c63a207 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FISecurity.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FISecurity.java @@ -22,6 +22,9 @@ import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonTypeName; import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.FILoss; +import factset.analyticsapi.engines.models.FIPrepay; +import factset.analyticsapi.engines.models.FIReferenceSecurity; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.Serializable; @@ -34,6 +37,12 @@ */ @JsonPropertyOrder({ FISecurity.JSON_PROPERTY_SETTLEMENT, + FISecurity.JSON_PROPERTY_CALL_METHOD, + FISecurity.JSON_PROPERTY_REFERENCE_SECURITY, + FISecurity.JSON_PROPERTY_LOSS, + FISecurity.JSON_PROPERTY_PREPAY, + FISecurity.JSON_PROPERTY_MATRIX_SPREAD_ADJUSTMENT, + FISecurity.JSON_PROPERTY_MATRIX_MULTIPLIER, FISecurity.JSON_PROPERTY_CALC_FROM_METHOD, FISecurity.JSON_PROPERTY_CALC_FROM_VALUE, FISecurity.JSON_PROPERTY_FACE, @@ -48,6 +57,63 @@ public class FISecurity implements Serializable { public static final String JSON_PROPERTY_SETTLEMENT = "settlement"; private String settlement; + /** + * Call Method + */ + public enum CallMethodEnum { + NO_CALL("No Call"), + + INTRINSIC_VALUE("Intrinsic Value"), + + FIRST_CALL("First Call"), + + FIRST_PAR("First Par"); + + private String value; + + CallMethodEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static CallMethodEnum fromValue(String value) { + for (CallMethodEnum b : CallMethodEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_CALL_METHOD = "callMethod"; + private CallMethodEnum callMethod; + + public static final String JSON_PROPERTY_REFERENCE_SECURITY = "referenceSecurity"; + private FIReferenceSecurity referenceSecurity; + + public static final String JSON_PROPERTY_LOSS = "loss"; + private FILoss loss; + + public static final String JSON_PROPERTY_PREPAY = "prepay"; + private FIPrepay prepay; + + public static final String JSON_PROPERTY_MATRIX_SPREAD_ADJUSTMENT = "matrixSpreadAdjustment"; + private Double matrixSpreadAdjustment; + + public static final String JSON_PROPERTY_MATRIX_MULTIPLIER = "matrixMultiplier"; + private Double matrixMultiplier; + public static final String JSON_PROPERTY_CALC_FROM_METHOD = "calcFromMethod"; private String calcFromMethod; @@ -101,6 +167,8 @@ public static FaceTypeEnum fromValue(String value) { public static final String JSON_PROPERTY_DISCOUNT_CURVE = "discountCurve"; private String discountCurve; + public FISecurity() { + } public FISecurity settlement(String settlement) { this.settlement = settlement; @@ -121,29 +189,190 @@ public String getSettlement() { } + @JsonProperty(JSON_PROPERTY_SETTLEMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSettlement(String settlement) { this.settlement = settlement; } + public FISecurity callMethod(CallMethodEnum callMethod) { + this.callMethod = callMethod; + return this; + } + + /** + * Call Method + * @return callMethod + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Call Method") + @JsonProperty(JSON_PROPERTY_CALL_METHOD) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public CallMethodEnum getCallMethod() { + return callMethod; + } + + + @JsonProperty(JSON_PROPERTY_CALL_METHOD) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCallMethod(CallMethodEnum callMethod) { + this.callMethod = callMethod; + } + + + public FISecurity referenceSecurity(FIReferenceSecurity referenceSecurity) { + this.referenceSecurity = referenceSecurity; + return this; + } + + /** + * Get referenceSecurity + * @return referenceSecurity + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_REFERENCE_SECURITY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public FIReferenceSecurity getReferenceSecurity() { + return referenceSecurity; + } + + + @JsonProperty(JSON_PROPERTY_REFERENCE_SECURITY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setReferenceSecurity(FIReferenceSecurity referenceSecurity) { + this.referenceSecurity = referenceSecurity; + } + + + public FISecurity loss(FILoss loss) { + this.loss = loss; + return this; + } + + /** + * Get loss + * @return loss + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_LOSS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public FILoss getLoss() { + return loss; + } + + + @JsonProperty(JSON_PROPERTY_LOSS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setLoss(FILoss loss) { + this.loss = loss; + } + + + public FISecurity prepay(FIPrepay prepay) { + this.prepay = prepay; + return this; + } + + /** + * Get prepay + * @return prepay + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_PREPAY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public FIPrepay getPrepay() { + return prepay; + } + + + @JsonProperty(JSON_PROPERTY_PREPAY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setPrepay(FIPrepay prepay) { + this.prepay = prepay; + } + + + public FISecurity matrixSpreadAdjustment(Double matrixSpreadAdjustment) { + this.matrixSpreadAdjustment = matrixSpreadAdjustment; + return this; + } + + /** + * Matrix Spread Adjustment + * @return matrixSpreadAdjustment + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Matrix Spread Adjustment") + @JsonProperty(JSON_PROPERTY_MATRIX_SPREAD_ADJUSTMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Double getMatrixSpreadAdjustment() { + return matrixSpreadAdjustment; + } + + + @JsonProperty(JSON_PROPERTY_MATRIX_SPREAD_ADJUSTMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setMatrixSpreadAdjustment(Double matrixSpreadAdjustment) { + this.matrixSpreadAdjustment = matrixSpreadAdjustment; + } + + + public FISecurity matrixMultiplier(Double matrixMultiplier) { + this.matrixMultiplier = matrixMultiplier; + return this; + } + + /** + * Matrix Multiplier + * @return matrixMultiplier + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Matrix Multiplier") + @JsonProperty(JSON_PROPERTY_MATRIX_MULTIPLIER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Double getMatrixMultiplier() { + return matrixMultiplier; + } + + + @JsonProperty(JSON_PROPERTY_MATRIX_MULTIPLIER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setMatrixMultiplier(Double matrixMultiplier) { + this.matrixMultiplier = matrixMultiplier; + } + + public FISecurity calcFromMethod(String calcFromMethod) { this.calcFromMethod = calcFromMethod; return this; } /** - * Calculation from method + * 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 * @return calcFromMethod **/ - @ApiModelProperty(required = true, value = "Calculation from method") + @javax.annotation.Nullable + @ApiModelProperty(value = "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") @JsonProperty(JSON_PROPERTY_CALC_FROM_METHOD) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getCalcFromMethod() { return calcFromMethod; } + @JsonProperty(JSON_PROPERTY_CALC_FROM_METHOD) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCalcFromMethod(String calcFromMethod) { this.calcFromMethod = calcFromMethod; } @@ -158,6 +387,7 @@ public FISecurity calcFromValue(Double calcFromValue) { * Calculation from value * @return calcFromValue **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "Calculation from value") @JsonProperty(JSON_PROPERTY_CALC_FROM_VALUE) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -167,6 +397,8 @@ public Double getCalcFromValue() { } + @JsonProperty(JSON_PROPERTY_CALC_FROM_VALUE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCalcFromValue(Double calcFromValue) { this.calcFromValue = calcFromValue; } @@ -191,6 +423,8 @@ public Double getFace() { } + @JsonProperty(JSON_PROPERTY_FACE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFace(Double face) { this.face = face; } @@ -215,6 +449,8 @@ public FaceTypeEnum getFaceType() { } + @JsonProperty(JSON_PROPERTY_FACE_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFaceType(FaceTypeEnum faceType) { this.faceType = faceType; } @@ -229,6 +465,7 @@ public FISecurity symbol(String symbol) { * Symbol * @return symbol **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "Symbol") @JsonProperty(JSON_PROPERTY_SYMBOL) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -238,6 +475,8 @@ public String getSymbol() { } + @JsonProperty(JSON_PROPERTY_SYMBOL) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSymbol(String symbol) { this.symbol = symbol; } @@ -262,6 +501,8 @@ public String getDiscountCurve() { } + @JsonProperty(JSON_PROPERTY_DISCOUNT_CURVE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDiscountCurve(String discountCurve) { this.discountCurve = discountCurve; } @@ -280,6 +521,12 @@ public boolean equals(Object o) { } FISecurity fiSecurity = (FISecurity) o; return Objects.equals(this.settlement, fiSecurity.settlement) && + Objects.equals(this.callMethod, fiSecurity.callMethod) && + Objects.equals(this.referenceSecurity, fiSecurity.referenceSecurity) && + Objects.equals(this.loss, fiSecurity.loss) && + Objects.equals(this.prepay, fiSecurity.prepay) && + Objects.equals(this.matrixSpreadAdjustment, fiSecurity.matrixSpreadAdjustment) && + Objects.equals(this.matrixMultiplier, fiSecurity.matrixMultiplier) && Objects.equals(this.calcFromMethod, fiSecurity.calcFromMethod) && Objects.equals(this.calcFromValue, fiSecurity.calcFromValue) && Objects.equals(this.face, fiSecurity.face) && @@ -290,7 +537,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(settlement, calcFromMethod, calcFromValue, face, faceType, symbol, discountCurve); + return Objects.hash(settlement, callMethod, referenceSecurity, loss, prepay, matrixSpreadAdjustment, matrixMultiplier, calcFromMethod, calcFromValue, face, faceType, symbol, discountCurve); } @Override @@ -298,6 +545,12 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class FISecurity {\n"); sb.append(" settlement: ").append(toIndentedString(settlement)).append("\n"); + sb.append(" callMethod: ").append(toIndentedString(callMethod)).append("\n"); + sb.append(" referenceSecurity: ").append(toIndentedString(referenceSecurity)).append("\n"); + sb.append(" loss: ").append(toIndentedString(loss)).append("\n"); + sb.append(" prepay: ").append(toIndentedString(prepay)).append("\n"); + sb.append(" matrixSpreadAdjustment: ").append(toIndentedString(matrixSpreadAdjustment)).append("\n"); + sb.append(" matrixMultiplier: ").append(toIndentedString(matrixMultiplier)).append("\n"); sb.append(" calcFromMethod: ").append(toIndentedString(calcFromMethod)).append("\n"); sb.append(" calcFromValue: ").append(toIndentedString(calcFromValue)).append("\n"); sb.append(" face: ").append(toIndentedString(face)).append("\n"); diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOAccount.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOAccount.java index c06c9586..a5182e88 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOAccount.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOAccount.java @@ -52,6 +52,8 @@ public class FPOAccount implements Serializable { public static final String JSON_PROPERTY_OVERRIDES = "overrides"; private OptimizerAccountOverrides overrides; + public FPOAccount() { + } public FPOAccount paDocument(PaDoc paDocument) { this.paDocument = paDocument; @@ -62,6 +64,7 @@ public FPOAccount paDocument(PaDoc paDocument) { * Get paDocument * @return paDocument **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_PA_DOCUMENT) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -71,6 +74,8 @@ public PaDoc getPaDocument() { } + @JsonProperty(JSON_PROPERTY_PA_DOCUMENT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setPaDocument(PaDoc paDocument) { this.paDocument = paDocument; } @@ -95,6 +100,8 @@ public String getId() { } + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { this.id = id; } @@ -119,6 +126,8 @@ public OptimizerAccountOverrides getOverrides() { } + @JsonProperty(JSON_PROPERTY_OVERRIDES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOverrides(OptimizerAccountOverrides overrides) { this.overrides = overrides; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOObjective.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOObjective.java new file mode 100644 index 00000000..00606c75 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOObjective.java @@ -0,0 +1,190 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * FPOObjective + */ +@JsonPropertyOrder({ + FPOObjective.JSON_PROPERTY_ACTIVE, + FPOObjective.JSON_PROPERTY_TERMS +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class FPOObjective implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ACTIVE = "active"; + private String active; + + /** + * Gets or Sets inner + */ + public enum InnerEnum { + DISABLE("Disable"), + + ENABLE("Enable"); + + private String value; + + InnerEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static InnerEnum fromValue(String value) { + for (InnerEnum b : InnerEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_TERMS = "terms"; + private java.util.Map terms = null; + + public FPOObjective() { + } + + public FPOObjective active(String active) { + this.active = active; + return this; + } + + /** + * Get active + * @return active + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_ACTIVE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getActive() { + return active; + } + + + @JsonProperty(JSON_PROPERTY_ACTIVE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setActive(String active) { + this.active = active; + } + + + public FPOObjective terms(java.util.Map terms) { + this.terms = terms; + return this; + } + + public FPOObjective putTermsItem(String key, InnerEnum termsItem) { + if (this.terms == null) { + this.terms = new java.util.HashMap(); + } + this.terms.put(key, termsItem); + return this; + } + + /** + * Get terms + * @return terms + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_TERMS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.Map getTerms() { + return terms; + } + + + @JsonProperty(JSON_PROPERTY_TERMS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTerms(java.util.Map terms) { + this.terms = terms; + } + + + /** + * Return true if this FPOObjective object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FPOObjective fpOObjective = (FPOObjective) o; + return Objects.equals(this.active, fpOObjective.active) && + Objects.equals(this.terms, fpOObjective.terms); + } + + @Override + public int hashCode() { + return Objects.hash(active, terms); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FPOObjective {\n"); + sb.append(" active: ").append(toIndentedString(active)).append("\n"); + sb.append(" terms: ").append(toIndentedString(terms)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParameters.java index 8279c918..8c3f41de 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParameters.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParameters.java @@ -23,9 +23,9 @@ import com.fasterxml.jackson.annotation.JsonTypeName; import com.fasterxml.jackson.annotation.JsonValue; import factset.analyticsapi.engines.models.FPOAccount; +import factset.analyticsapi.engines.models.FPOOptimizerStrategy; import factset.analyticsapi.engines.models.Optimization; import factset.analyticsapi.engines.models.OptimizerOutputTypes; -import factset.analyticsapi.engines.models.OptimizerStrategy; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.Serializable; @@ -50,7 +50,7 @@ public class FPOOptimizationParameters implements Serializable { private FPOAccount account; public static final String JSON_PROPERTY_STRATEGY = "strategy"; - private OptimizerStrategy strategy; + private FPOOptimizerStrategy strategy; public static final String JSON_PROPERTY_OPTIMIZATION = "optimization"; private Optimization optimization; @@ -58,6 +58,8 @@ public class FPOOptimizationParameters implements Serializable { public static final String JSON_PROPERTY_OUTPUT_TYPES = "outputTypes"; private OptimizerOutputTypes outputTypes; + public FPOOptimizationParameters() { + } public FPOOptimizationParameters account(FPOAccount account) { this.account = account; @@ -78,12 +80,14 @@ public FPOAccount getAccount() { } + @JsonProperty(JSON_PROPERTY_ACCOUNT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccount(FPOAccount account) { this.account = account; } - public FPOOptimizationParameters strategy(OptimizerStrategy strategy) { + public FPOOptimizationParameters strategy(FPOOptimizerStrategy strategy) { this.strategy = strategy; return this; } @@ -92,16 +96,19 @@ public FPOOptimizationParameters strategy(OptimizerStrategy strategy) { * Get strategy * @return strategy **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_STRATEGY) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public OptimizerStrategy getStrategy() { + public FPOOptimizerStrategy getStrategy() { return strategy; } - public void setStrategy(OptimizerStrategy strategy) { + @JsonProperty(JSON_PROPERTY_STRATEGY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setStrategy(FPOOptimizerStrategy strategy) { this.strategy = strategy; } @@ -125,6 +132,8 @@ public Optimization getOptimization() { } + @JsonProperty(JSON_PROPERTY_OPTIMIZATION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOptimization(Optimization optimization) { this.optimization = optimization; } @@ -139,6 +148,7 @@ public FPOOptimizationParameters outputTypes(OptimizerOutputTypes outputTypes) { * Get outputTypes * @return outputTypes **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_OUTPUT_TYPES) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -148,6 +158,8 @@ public OptimizerOutputTypes getOutputTypes() { } + @JsonProperty(JSON_PROPERTY_OUTPUT_TYPES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setOutputTypes(OptimizerOutputTypes outputTypes) { this.outputTypes = outputTypes; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParametersRoot.java index 1593b778..86f06dad 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParametersRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizationParametersRoot.java @@ -47,6 +47,8 @@ public class FPOOptimizationParametersRoot implements Serializable { public static final String JSON_PROPERTY_META = "meta"; private Object meta; + public FPOOptimizationParametersRoot() { + } public FPOOptimizationParametersRoot data(FPOOptimizationParameters data) { this.data = data; @@ -67,6 +69,8 @@ public FPOOptimizationParameters getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(FPOOptimizationParameters data) { this.data = data; } @@ -91,6 +95,8 @@ public Object getMeta() { } + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMeta(Object meta) { this.meta = meta; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerStrategy.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategy.java similarity index 70% rename from auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerStrategy.java rename to auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategy.java index 537e0940..9a7b3a6a 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerStrategy.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategy.java @@ -22,7 +22,7 @@ import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonTypeName; import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.OptimizerStrategyOverrides; +import factset.analyticsapi.engines.models.FPOOptimizerStrategyOverrides; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.Serializable; @@ -31,72 +31,79 @@ /** - * OptimizerStrategy + * FPOOptimizerStrategy */ @JsonPropertyOrder({ - OptimizerStrategy.JSON_PROPERTY_ID, - OptimizerStrategy.JSON_PROPERTY_OVERRIDES + FPOOptimizerStrategy.JSON_PROPERTY_OVERRIDES, + FPOOptimizerStrategy.JSON_PROPERTY_ID }) @javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class OptimizerStrategy implements Serializable { +public class FPOOptimizerStrategy implements Serializable { private static final long serialVersionUID = 1L; + public static final String JSON_PROPERTY_OVERRIDES = "overrides"; + private FPOOptimizerStrategyOverrides overrides; + public static final String JSON_PROPERTY_ID = "id"; private String id; - public static final String JSON_PROPERTY_OVERRIDES = "overrides"; - private OptimizerStrategyOverrides overrides; - + public FPOOptimizerStrategy() { + } - public OptimizerStrategy id(String id) { - this.id = id; + public FPOOptimizerStrategy overrides(FPOOptimizerStrategyOverrides overrides) { + this.overrides = overrides; return this; } /** - * OptimizerStrategy document path - * @return id + * Get overrides + * @return overrides **/ - @ApiModelProperty(required = true, value = "OptimizerStrategy document path") - @JsonProperty(JSON_PROPERTY_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_OVERRIDES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public String getId() { - return id; + public FPOOptimizerStrategyOverrides getOverrides() { + return overrides; } - public void setId(String id) { - this.id = id; + @JsonProperty(JSON_PROPERTY_OVERRIDES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setOverrides(FPOOptimizerStrategyOverrides overrides) { + this.overrides = overrides; } - public OptimizerStrategy overrides(OptimizerStrategyOverrides overrides) { - this.overrides = overrides; + public FPOOptimizerStrategy id(String id) { + this.id = id; return this; } /** - * Get overrides - * @return overrides + * OptimizerStrategy document path + * @return id **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_OVERRIDES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "OptimizerStrategy document path") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) - public OptimizerStrategyOverrides getOverrides() { - return overrides; + public String getId() { + return id; } - public void setOverrides(OptimizerStrategyOverrides overrides) { - this.overrides = overrides; + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setId(String id) { + this.id = id; } /** - * Return true if this OptimizerStrategy object is equal to o. + * Return true if this FPOOptimizerStrategy object is equal to o. */ @Override public boolean equals(Object o) { @@ -106,22 +113,22 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - OptimizerStrategy optimizerStrategy = (OptimizerStrategy) o; - return Objects.equals(this.id, optimizerStrategy.id) && - Objects.equals(this.overrides, optimizerStrategy.overrides); + FPOOptimizerStrategy fpOOptimizerStrategy = (FPOOptimizerStrategy) o; + return Objects.equals(this.overrides, fpOOptimizerStrategy.overrides) && + Objects.equals(this.id, fpOOptimizerStrategy.id); } @Override public int hashCode() { - return Objects.hash(id, overrides); + return Objects.hash(overrides, id); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class OptimizerStrategy {\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append("class FPOOptimizerStrategy {\n"); sb.append(" overrides: ").append(toIndentedString(overrides)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerStrategyOverrides.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategyOverrides.java similarity index 66% rename from auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerStrategyOverrides.java rename to auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategyOverrides.java index 19b30785..a74998bf 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerStrategyOverrides.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FPOOptimizerStrategyOverrides.java @@ -22,6 +22,7 @@ import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonTypeName; import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.FPOObjective; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.Serializable; @@ -30,20 +31,20 @@ /** - * OptimizerStrategyOverrides + * FPOOptimizerStrategyOverrides */ @JsonPropertyOrder({ - OptimizerStrategyOverrides.JSON_PROPERTY_TAX, - OptimizerStrategyOverrides.JSON_PROPERTY_CONSTRAINTS, - OptimizerStrategyOverrides.JSON_PROPERTY_ALPHA, - OptimizerStrategyOverrides.JSON_PROPERTY_TRANSACTION_COST + FPOOptimizerStrategyOverrides.JSON_PROPERTY_OBJECTIVE, + FPOOptimizerStrategyOverrides.JSON_PROPERTY_CONSTRAINTS, + FPOOptimizerStrategyOverrides.JSON_PROPERTY_ALPHA, + FPOOptimizerStrategyOverrides.JSON_PROPERTY_TRANSACTION_COST }) @javax.annotation.Generated(value = "CustomJavaClientCodegen") -public class OptimizerStrategyOverrides implements Serializable { +public class FPOOptimizerStrategyOverrides implements Serializable { private static final long serialVersionUID = 1L; - public static final String JSON_PROPERTY_TAX = "tax"; - private String tax; + public static final String JSON_PROPERTY_OBJECTIVE = "objective"; + private FPOObjective objective; /** * Gets or Sets inner @@ -89,37 +90,41 @@ public static InnerEnum fromValue(String value) { public static final String JSON_PROPERTY_TRANSACTION_COST = "transactionCost"; private String transactionCost; + public FPOOptimizerStrategyOverrides() { + } - public OptimizerStrategyOverrides tax(String tax) { - this.tax = tax; + public FPOOptimizerStrategyOverrides objective(FPOObjective objective) { + this.objective = objective; return this; } /** - * Tax - * @return tax + * Get objective + * @return objective **/ @javax.annotation.Nullable - @ApiModelProperty(value = "Tax") - @JsonProperty(JSON_PROPERTY_TAX) + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_OBJECTIVE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public String getTax() { - return tax; + public FPOObjective getObjective() { + return objective; } - public void setTax(String tax) { - this.tax = tax; + @JsonProperty(JSON_PROPERTY_OBJECTIVE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setObjective(FPOObjective objective) { + this.objective = objective; } - public OptimizerStrategyOverrides constraints(java.util.Map constraints) { + public FPOOptimizerStrategyOverrides constraints(java.util.Map constraints) { this.constraints = constraints; return this; } - public OptimizerStrategyOverrides putConstraintsItem(String key, InnerEnum constraintsItem) { + public FPOOptimizerStrategyOverrides putConstraintsItem(String key, InnerEnum constraintsItem) { if (this.constraints == null) { this.constraints = new java.util.HashMap(); } @@ -141,12 +146,14 @@ public java.util.Map getConstraints() { } + @JsonProperty(JSON_PROPERTY_CONSTRAINTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setConstraints(java.util.Map constraints) { this.constraints = constraints; } - public OptimizerStrategyOverrides alpha(String alpha) { + public FPOOptimizerStrategyOverrides alpha(String alpha) { this.alpha = alpha; return this; } @@ -165,12 +172,14 @@ public String getAlpha() { } + @JsonProperty(JSON_PROPERTY_ALPHA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAlpha(String alpha) { this.alpha = alpha; } - public OptimizerStrategyOverrides transactionCost(String transactionCost) { + public FPOOptimizerStrategyOverrides transactionCost(String transactionCost) { this.transactionCost = transactionCost; return this; } @@ -189,13 +198,15 @@ public String getTransactionCost() { } + @JsonProperty(JSON_PROPERTY_TRANSACTION_COST) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransactionCost(String transactionCost) { this.transactionCost = transactionCost; } /** - * Return true if this OptimizerStrategyOverrides object is equal to o. + * Return true if this FPOOptimizerStrategyOverrides object is equal to o. */ @Override public boolean equals(Object o) { @@ -205,23 +216,23 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - OptimizerStrategyOverrides optimizerStrategyOverrides = (OptimizerStrategyOverrides) o; - return Objects.equals(this.tax, optimizerStrategyOverrides.tax) && - Objects.equals(this.constraints, optimizerStrategyOverrides.constraints) && - Objects.equals(this.alpha, optimizerStrategyOverrides.alpha) && - Objects.equals(this.transactionCost, optimizerStrategyOverrides.transactionCost); + FPOOptimizerStrategyOverrides fpOOptimizerStrategyOverrides = (FPOOptimizerStrategyOverrides) o; + return Objects.equals(this.objective, fpOOptimizerStrategyOverrides.objective) && + Objects.equals(this.constraints, fpOOptimizerStrategyOverrides.constraints) && + Objects.equals(this.alpha, fpOOptimizerStrategyOverrides.alpha) && + Objects.equals(this.transactionCost, fpOOptimizerStrategyOverrides.transactionCost); } @Override public int hashCode() { - return Objects.hash(tax, constraints, alpha, transactionCost); + return Objects.hash(objective, constraints, alpha, transactionCost); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class OptimizerStrategyOverrides {\n"); - sb.append(" tax: ").append(toIndentedString(tax)).append("\n"); + sb.append("class FPOOptimizerStrategyOverrides {\n"); + sb.append(" objective: ").append(toIndentedString(objective)).append("\n"); sb.append(" constraints: ").append(toIndentedString(constraints)).append("\n"); sb.append(" alpha: ").append(toIndentedString(alpha)).append("\n"); sb.append(" transactionCost: ").append(toIndentedString(transactionCost)).append("\n"); diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Frequency.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Frequency.java index dd052150..ef95d884 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Frequency.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Frequency.java @@ -42,6 +42,8 @@ public class Frequency implements Serializable { public static final String JSON_PROPERTY_NAME = "name"; private String name; + public Frequency() { + } public Frequency name(String name) { this.name = name; @@ -62,6 +64,8 @@ public String getName() { } + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FrequencyRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FrequencyRoot.java index 7e641595..0ffe5976 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FrequencyRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/FrequencyRoot.java @@ -25,6 +25,10 @@ import factset.analyticsapi.engines.models.Frequency; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; import java.io.Serializable; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import factset.analyticsapi.engines.JSON; @@ -45,8 +49,10 @@ public class FrequencyRoot implements Serializable { private java.util.Map data = new java.util.HashMap(); public static final String JSON_PROPERTY_META = "meta"; - private Object meta; + private JsonNullable meta = JsonNullable.of(null); + public FrequencyRoot() { + } public FrequencyRoot data(java.util.Map data) { this.data = data; @@ -62,6 +68,7 @@ public FrequencyRoot putDataItem(String key, Frequency dataItem) { * Get data * @return data **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -71,13 +78,15 @@ public java.util.Map getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setData(java.util.Map data) { this.data = data; } public FrequencyRoot meta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); return this; } @@ -87,16 +96,26 @@ public FrequencyRoot meta(Object meta) { **/ @javax.annotation.Nullable @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + @JsonProperty(JSON_PROPERTY_META) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Object getMeta() { + public JsonNullable getMeta_JsonNullable() { return meta; } - + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } public void setMeta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); } @@ -113,12 +132,23 @@ public boolean equals(Object o) { } FrequencyRoot frequencyRoot = (FrequencyRoot) o; return Objects.equals(this.data, frequencyRoot.data) && - Objects.equals(this.meta, frequencyRoot.meta); + equalsNullable(this.meta, frequencyRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); } @Override public int hashCode() { - return Objects.hash(data, meta); + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; } @Override diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Group.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Group.java index 117272a3..54dd5137 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Group.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Group.java @@ -50,6 +50,8 @@ public class Group implements Serializable { public static final String JSON_PROPERTY_CATEGORY = "category"; private String category; + public Group() { + } public Group name(String name) { this.name = name; @@ -70,6 +72,8 @@ public String getName() { } + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } @@ -94,6 +98,8 @@ public String getDirectory() { } + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDirectory(String directory) { this.directory = directory; } @@ -118,6 +124,8 @@ public String getCategory() { } + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCategory(String category) { this.category = category; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/GroupRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/GroupRoot.java index 8b968b2a..08ab37be 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/GroupRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/GroupRoot.java @@ -25,6 +25,10 @@ import factset.analyticsapi.engines.models.Group; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; import java.io.Serializable; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import factset.analyticsapi.engines.JSON; @@ -45,8 +49,10 @@ public class GroupRoot implements Serializable { private java.util.Map data = new java.util.HashMap(); public static final String JSON_PROPERTY_META = "meta"; - private Object meta; + private JsonNullable meta = JsonNullable.of(null); + public GroupRoot() { + } public GroupRoot data(java.util.Map data) { this.data = data; @@ -62,6 +68,7 @@ public GroupRoot putDataItem(String key, Group dataItem) { * Get data * @return data **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -71,13 +78,15 @@ public java.util.Map getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setData(java.util.Map data) { this.data = data; } public GroupRoot meta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); return this; } @@ -87,16 +96,26 @@ public GroupRoot meta(Object meta) { **/ @javax.annotation.Nullable @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + @JsonProperty(JSON_PROPERTY_META) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Object getMeta() { + public JsonNullable getMeta_JsonNullable() { return meta; } - + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } public void setMeta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); } @@ -113,12 +132,23 @@ public boolean equals(Object o) { } GroupRoot groupRoot = (GroupRoot) o; return Objects.equals(this.data, groupRoot.data) && - Objects.equals(this.meta, groupRoot.meta); + equalsNullable(this.meta, groupRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); } @Override public int hashCode() { - return Objects.hash(data, meta); + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; } @Override diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplate.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplate.java new file mode 100644 index 00000000..1375e3bb --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplate.java @@ -0,0 +1,308 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.TemplateContentTypes; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * LinkedPATemplate + */ +@JsonPropertyOrder({ + LinkedPATemplate.JSON_PROPERTY_DIRECTORY, + LinkedPATemplate.JSON_PROPERTY_SNAPSHOT, + LinkedPATemplate.JSON_PROPERTY_CONTENT, + LinkedPATemplate.JSON_PROPERTY_ID, + LinkedPATemplate.JSON_PROPERTY_DESCRIPTION, + LinkedPATemplate.JSON_PROPERTY_NAME, + LinkedPATemplate.JSON_PROPERTY_PARENT_COMPONENT_ID +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPATemplate implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DIRECTORY = "directory"; + private String directory; + + public static final String JSON_PROPERTY_SNAPSHOT = "snapshot"; + private Boolean snapshot; + + public static final String JSON_PROPERTY_CONTENT = "content"; + private TemplateContentTypes content; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_PARENT_COMPONENT_ID = "parentComponentId"; + private String parentComponentId; + + public LinkedPATemplate() { + } + + public LinkedPATemplate directory(String directory) { + this.directory = directory; + return this; + } + + /** + * Template directory. + * @return directory + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template directory.") + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDirectory() { + return directory; + } + + + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDirectory(String directory) { + this.directory = directory; + } + + + public LinkedPATemplate snapshot(Boolean snapshot) { + this.snapshot = snapshot; + return this; + } + + /** + * snapshot. + * @return snapshot + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "snapshot.") + @JsonProperty(JSON_PROPERTY_SNAPSHOT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getSnapshot() { + return snapshot; + } + + + @JsonProperty(JSON_PROPERTY_SNAPSHOT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSnapshot(Boolean snapshot) { + this.snapshot = snapshot; + } + + + public LinkedPATemplate content(TemplateContentTypes content) { + this.content = content; + return this; + } + + /** + * Get content + * @return content + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_CONTENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public TemplateContentTypes getContent() { + return content; + } + + + @JsonProperty(JSON_PROPERTY_CONTENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setContent(TemplateContentTypes content) { + this.content = content; + } + + + public LinkedPATemplate id(String id) { + this.id = id; + return this; + } + + /** + * Template id. + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template id.") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setId(String id) { + this.id = id; + } + + + public LinkedPATemplate description(String description) { + this.description = description; + return this; + } + + /** + * Template description. + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template description.") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDescription(String description) { + this.description = description; + } + + + public LinkedPATemplate name(String name) { + this.name = name; + return this; + } + + /** + * Template name. + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template name.") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setName(String name) { + this.name = name; + } + + + public LinkedPATemplate parentComponentId(String parentComponentId) { + this.parentComponentId = parentComponentId; + return this; + } + + /** + * Template parent tile. + * @return parentComponentId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template parent tile.") + @JsonProperty(JSON_PROPERTY_PARENT_COMPONENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getParentComponentId() { + return parentComponentId; + } + + + @JsonProperty(JSON_PROPERTY_PARENT_COMPONENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setParentComponentId(String parentComponentId) { + this.parentComponentId = parentComponentId; + } + + + /** + * Return true if this LinkedPATemplate object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LinkedPATemplate linkedPATemplate = (LinkedPATemplate) o; + return Objects.equals(this.directory, linkedPATemplate.directory) && + Objects.equals(this.snapshot, linkedPATemplate.snapshot) && + Objects.equals(this.content, linkedPATemplate.content) && + Objects.equals(this.id, linkedPATemplate.id) && + Objects.equals(this.description, linkedPATemplate.description) && + Objects.equals(this.name, linkedPATemplate.name) && + Objects.equals(this.parentComponentId, linkedPATemplate.parentComponentId); + } + + @Override + public int hashCode() { + return Objects.hash(directory, snapshot, content, id, description, name, parentComponentId); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LinkedPATemplate {\n"); + sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); + sb.append(" snapshot: ").append(toIndentedString(snapshot)).append("\n"); + sb.append(" content: ").append(toIndentedString(content)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" parentComponentId: ").append(toIndentedString(parentComponentId)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParameters.java new file mode 100644 index 00000000..0ddcfb64 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParameters.java @@ -0,0 +1,212 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.TemplateContentTypes; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * LinkedPATemplateParameters + */ +@JsonPropertyOrder({ + LinkedPATemplateParameters.JSON_PROPERTY_DIRECTORY, + LinkedPATemplateParameters.JSON_PROPERTY_PARENT_COMPONENT_ID, + LinkedPATemplateParameters.JSON_PROPERTY_DESCRIPTION, + LinkedPATemplateParameters.JSON_PROPERTY_CONTENT +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPATemplateParameters implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DIRECTORY = "directory"; + private String directory; + + public static final String JSON_PROPERTY_PARENT_COMPONENT_ID = "parentComponentId"; + private String parentComponentId; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_CONTENT = "content"; + private TemplateContentTypes content; + + public LinkedPATemplateParameters() { + } + + public LinkedPATemplateParameters directory(String directory) { + this.directory = directory; + return this; + } + + /** + * The directory to create a linked PA template + * @return directory + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "The directory to create a linked PA template") + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getDirectory() { + return directory; + } + + + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setDirectory(String directory) { + this.directory = directory; + } + + + public LinkedPATemplateParameters parentComponentId(String parentComponentId) { + this.parentComponentId = parentComponentId; + return this; + } + + /** + * Parent component id + * @return parentComponentId + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "Parent component id") + @JsonProperty(JSON_PROPERTY_PARENT_COMPONENT_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getParentComponentId() { + return parentComponentId; + } + + + @JsonProperty(JSON_PROPERTY_PARENT_COMPONENT_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setParentComponentId(String parentComponentId) { + this.parentComponentId = parentComponentId; + } + + + public LinkedPATemplateParameters description(String description) { + this.description = description; + return this; + } + + /** + * Template description + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template description") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDescription(String description) { + this.description = description; + } + + + public LinkedPATemplateParameters content(TemplateContentTypes content) { + this.content = content; + return this; + } + + /** + * Get content + * @return content + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_CONTENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public TemplateContentTypes getContent() { + return content; + } + + + @JsonProperty(JSON_PROPERTY_CONTENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setContent(TemplateContentTypes content) { + this.content = content; + } + + + /** + * Return true if this LinkedPATemplateParameters object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LinkedPATemplateParameters linkedPATemplateParameters = (LinkedPATemplateParameters) o; + return Objects.equals(this.directory, linkedPATemplateParameters.directory) && + Objects.equals(this.parentComponentId, linkedPATemplateParameters.parentComponentId) && + Objects.equals(this.description, linkedPATemplateParameters.description) && + Objects.equals(this.content, linkedPATemplateParameters.content); + } + + @Override + public int hashCode() { + return Objects.hash(directory, parentComponentId, description, content); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LinkedPATemplateParameters {\n"); + sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); + sb.append(" parentComponentId: ").append(toIndentedString(parentComponentId)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" content: ").append(toIndentedString(content)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParametersRoot.java new file mode 100644 index 00000000..b1196dec --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateParametersRoot.java @@ -0,0 +1,171 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.LinkedPATemplateParameters; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * LinkedPATemplateParametersRoot + */ +@JsonPropertyOrder({ + LinkedPATemplateParametersRoot.JSON_PROPERTY_DATA, + LinkedPATemplateParametersRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPATemplateParametersRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private LinkedPATemplateParameters data; + + public static final String JSON_PROPERTY_META = "meta"; + private JsonNullable meta = JsonNullable.of(null); + + public LinkedPATemplateParametersRoot() { + } + + public LinkedPATemplateParametersRoot data(LinkedPATemplateParameters data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public LinkedPATemplateParameters getData() { + return data; + } + + + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setData(LinkedPATemplateParameters data) { + this.data = data; + } + + + public LinkedPATemplateParametersRoot meta(Object meta) { + this.meta = JsonNullable.of(meta); + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public JsonNullable getMeta_JsonNullable() { + return meta; + } + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } + + public void setMeta(Object meta) { + this.meta = JsonNullable.of(meta); + } + + + /** + * Return true if this LinkedPATemplateParametersRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LinkedPATemplateParametersRoot linkedPATemplateParametersRoot = (LinkedPATemplateParametersRoot) o; + return Objects.equals(this.data, linkedPATemplateParametersRoot.data) && + equalsNullable(this.meta, linkedPATemplateParametersRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + } + + @Override + public int hashCode() { + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LinkedPATemplateParametersRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummary.java new file mode 100644 index 00000000..68127e1a --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummary.java @@ -0,0 +1,211 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * LinkedPATemplatePostSummary + */ +@JsonPropertyOrder({ + LinkedPATemplatePostSummary.JSON_PROPERTY_ID, + LinkedPATemplatePostSummary.JSON_PROPERTY_DESCRIPTION, + LinkedPATemplatePostSummary.JSON_PROPERTY_NAME, + LinkedPATemplatePostSummary.JSON_PROPERTY_PARENT_COMPONENT_ID +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPATemplatePostSummary implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_PARENT_COMPONENT_ID = "parentComponentId"; + private String parentComponentId; + + public LinkedPATemplatePostSummary() { + } + + public LinkedPATemplatePostSummary id(String id) { + this.id = id; + return this; + } + + /** + * Template id. + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template id.") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setId(String id) { + this.id = id; + } + + + public LinkedPATemplatePostSummary description(String description) { + this.description = description; + return this; + } + + /** + * Template description. + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template description.") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDescription(String description) { + this.description = description; + } + + + public LinkedPATemplatePostSummary name(String name) { + this.name = name; + return this; + } + + /** + * Template name. + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template name.") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setName(String name) { + this.name = name; + } + + + public LinkedPATemplatePostSummary parentComponentId(String parentComponentId) { + this.parentComponentId = parentComponentId; + return this; + } + + /** + * Template parent tile. + * @return parentComponentId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template parent tile.") + @JsonProperty(JSON_PROPERTY_PARENT_COMPONENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getParentComponentId() { + return parentComponentId; + } + + + @JsonProperty(JSON_PROPERTY_PARENT_COMPONENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setParentComponentId(String parentComponentId) { + this.parentComponentId = parentComponentId; + } + + + /** + * Return true if this LinkedPATemplatePostSummary object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LinkedPATemplatePostSummary linkedPATemplatePostSummary = (LinkedPATemplatePostSummary) o; + return Objects.equals(this.id, linkedPATemplatePostSummary.id) && + Objects.equals(this.description, linkedPATemplatePostSummary.description) && + Objects.equals(this.name, linkedPATemplatePostSummary.name) && + Objects.equals(this.parentComponentId, linkedPATemplatePostSummary.parentComponentId); + } + + @Override + public int hashCode() { + return Objects.hash(id, description, name, parentComponentId); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LinkedPATemplatePostSummary {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" parentComponentId: ").append(toIndentedString(parentComponentId)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummaryRoot.java new file mode 100644 index 00000000..28e21cc3 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplatePostSummaryRoot.java @@ -0,0 +1,171 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.LinkedPATemplatePostSummary; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * LinkedPATemplatePostSummaryRoot + */ +@JsonPropertyOrder({ + LinkedPATemplatePostSummaryRoot.JSON_PROPERTY_DATA, + LinkedPATemplatePostSummaryRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPATemplatePostSummaryRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private LinkedPATemplatePostSummary data; + + public static final String JSON_PROPERTY_META = "meta"; + private JsonNullable meta = JsonNullable.of(null); + + public LinkedPATemplatePostSummaryRoot() { + } + + public LinkedPATemplatePostSummaryRoot data(LinkedPATemplatePostSummary data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public LinkedPATemplatePostSummary getData() { + return data; + } + + + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setData(LinkedPATemplatePostSummary data) { + this.data = data; + } + + + public LinkedPATemplatePostSummaryRoot meta(Object meta) { + this.meta = JsonNullable.of(meta); + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public JsonNullable getMeta_JsonNullable() { + return meta; + } + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } + + public void setMeta(Object meta) { + this.meta = JsonNullable.of(meta); + } + + + /** + * Return true if this LinkedPATemplatePostSummaryRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LinkedPATemplatePostSummaryRoot linkedPATemplatePostSummaryRoot = (LinkedPATemplatePostSummaryRoot) o; + return Objects.equals(this.data, linkedPATemplatePostSummaryRoot.data) && + equalsNullable(this.meta, linkedPATemplatePostSummaryRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + } + + @Override + public int hashCode() { + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LinkedPATemplatePostSummaryRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateRoot.java new file mode 100644 index 00000000..c5b32562 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateRoot.java @@ -0,0 +1,171 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.LinkedPATemplate; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * LinkedPATemplateRoot + */ +@JsonPropertyOrder({ + LinkedPATemplateRoot.JSON_PROPERTY_DATA, + LinkedPATemplateRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPATemplateRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private LinkedPATemplate data; + + public static final String JSON_PROPERTY_META = "meta"; + private JsonNullable meta = JsonNullable.of(null); + + public LinkedPATemplateRoot() { + } + + public LinkedPATemplateRoot data(LinkedPATemplate data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public LinkedPATemplate getData() { + return data; + } + + + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setData(LinkedPATemplate data) { + this.data = data; + } + + + public LinkedPATemplateRoot meta(Object meta) { + this.meta = JsonNullable.of(meta); + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public JsonNullable getMeta_JsonNullable() { + return meta; + } + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } + + public void setMeta(Object meta) { + this.meta = JsonNullable.of(meta); + } + + + /** + * Return true if this LinkedPATemplateRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LinkedPATemplateRoot linkedPATemplateRoot = (LinkedPATemplateRoot) o; + return Objects.equals(this.data, linkedPATemplateRoot.data) && + equalsNullable(this.meta, linkedPATemplateRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + } + + @Override + public int hashCode() { + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LinkedPATemplateRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummary.java new file mode 100644 index 00000000..b468e1af --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummary.java @@ -0,0 +1,179 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * LinkedPATemplateSummary + */ +@JsonPropertyOrder({ + LinkedPATemplateSummary.JSON_PROPERTY_DESCRIPTION, + LinkedPATemplateSummary.JSON_PROPERTY_NAME, + LinkedPATemplateSummary.JSON_PROPERTY_PARENT_COMPONENT_ID +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPATemplateSummary implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_PARENT_COMPONENT_ID = "parentComponentId"; + private String parentComponentId; + + public LinkedPATemplateSummary() { + } + + public LinkedPATemplateSummary description(String description) { + this.description = description; + return this; + } + + /** + * Template description. + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template description.") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDescription(String description) { + this.description = description; + } + + + public LinkedPATemplateSummary name(String name) { + this.name = name; + return this; + } + + /** + * Template name. + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template name.") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setName(String name) { + this.name = name; + } + + + public LinkedPATemplateSummary parentComponentId(String parentComponentId) { + this.parentComponentId = parentComponentId; + return this; + } + + /** + * Template parent tile. + * @return parentComponentId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template parent tile.") + @JsonProperty(JSON_PROPERTY_PARENT_COMPONENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getParentComponentId() { + return parentComponentId; + } + + + @JsonProperty(JSON_PROPERTY_PARENT_COMPONENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setParentComponentId(String parentComponentId) { + this.parentComponentId = parentComponentId; + } + + + /** + * Return true if this LinkedPATemplateSummary object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LinkedPATemplateSummary linkedPATemplateSummary = (LinkedPATemplateSummary) o; + return Objects.equals(this.description, linkedPATemplateSummary.description) && + Objects.equals(this.name, linkedPATemplateSummary.name) && + Objects.equals(this.parentComponentId, linkedPATemplateSummary.parentComponentId); + } + + @Override + public int hashCode() { + return Objects.hash(description, name, parentComponentId); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LinkedPATemplateSummary {\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" parentComponentId: ").append(toIndentedString(parentComponentId)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummaryRoot.java new file mode 100644 index 00000000..a66f23a9 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateSummaryRoot.java @@ -0,0 +1,176 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.LinkedPATemplateSummary; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * LinkedPATemplateSummaryRoot + */ +@JsonPropertyOrder({ + LinkedPATemplateSummaryRoot.JSON_PROPERTY_DATA, + LinkedPATemplateSummaryRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPATemplateSummaryRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private java.util.Map data = new java.util.HashMap(); + + public static final String JSON_PROPERTY_META = "meta"; + private JsonNullable meta = JsonNullable.of(null); + + public LinkedPATemplateSummaryRoot() { + } + + public LinkedPATemplateSummaryRoot data(java.util.Map data) { + this.data = data; + return this; + } + + public LinkedPATemplateSummaryRoot putDataItem(String key, LinkedPATemplateSummary dataItem) { + this.data.put(key, dataItem); + return this; + } + + /** + * Get data + * @return data + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public java.util.Map getData() { + return data; + } + + + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setData(java.util.Map data) { + this.data = data; + } + + + public LinkedPATemplateSummaryRoot meta(Object meta) { + this.meta = JsonNullable.of(meta); + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public JsonNullable getMeta_JsonNullable() { + return meta; + } + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } + + public void setMeta(Object meta) { + this.meta = JsonNullable.of(meta); + } + + + /** + * Return true if this LinkedPATemplateSummaryRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LinkedPATemplateSummaryRoot linkedPATemplateSummaryRoot = (LinkedPATemplateSummaryRoot) o; + return Objects.equals(this.data, linkedPATemplateSummaryRoot.data) && + equalsNullable(this.meta, linkedPATemplateSummaryRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + } + + @Override + public int hashCode() { + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LinkedPATemplateSummaryRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParameters.java new file mode 100644 index 00000000..a7072a77 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParameters.java @@ -0,0 +1,180 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.TemplateContentTypes; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * LinkedPATemplateUpdateParameters + */ +@JsonPropertyOrder({ + LinkedPATemplateUpdateParameters.JSON_PROPERTY_PARENT_COMPONENT_ID, + LinkedPATemplateUpdateParameters.JSON_PROPERTY_DESCRIPTION, + LinkedPATemplateUpdateParameters.JSON_PROPERTY_CONTENT +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPATemplateUpdateParameters implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_PARENT_COMPONENT_ID = "parentComponentId"; + private String parentComponentId; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_CONTENT = "content"; + private TemplateContentTypes content; + + public LinkedPATemplateUpdateParameters() { + } + + public LinkedPATemplateUpdateParameters parentComponentId(String parentComponentId) { + this.parentComponentId = parentComponentId; + return this; + } + + /** + * Parent component id + * @return parentComponentId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Parent component id") + @JsonProperty(JSON_PROPERTY_PARENT_COMPONENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getParentComponentId() { + return parentComponentId; + } + + + @JsonProperty(JSON_PROPERTY_PARENT_COMPONENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setParentComponentId(String parentComponentId) { + this.parentComponentId = parentComponentId; + } + + + public LinkedPATemplateUpdateParameters description(String description) { + this.description = description; + return this; + } + + /** + * Template description + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template description") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDescription(String description) { + this.description = description; + } + + + public LinkedPATemplateUpdateParameters content(TemplateContentTypes content) { + this.content = content; + return this; + } + + /** + * Get content + * @return content + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_CONTENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public TemplateContentTypes getContent() { + return content; + } + + + @JsonProperty(JSON_PROPERTY_CONTENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setContent(TemplateContentTypes content) { + this.content = content; + } + + + /** + * Return true if this LinkedPATemplateUpdateParameters object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LinkedPATemplateUpdateParameters linkedPATemplateUpdateParameters = (LinkedPATemplateUpdateParameters) o; + return Objects.equals(this.parentComponentId, linkedPATemplateUpdateParameters.parentComponentId) && + Objects.equals(this.description, linkedPATemplateUpdateParameters.description) && + Objects.equals(this.content, linkedPATemplateUpdateParameters.content); + } + + @Override + public int hashCode() { + return Objects.hash(parentComponentId, description, content); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LinkedPATemplateUpdateParameters {\n"); + sb.append(" parentComponentId: ").append(toIndentedString(parentComponentId)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" content: ").append(toIndentedString(content)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParametersRoot.java new file mode 100644 index 00000000..9eecd20d --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/LinkedPATemplateUpdateParametersRoot.java @@ -0,0 +1,171 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.LinkedPATemplateUpdateParameters; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * LinkedPATemplateUpdateParametersRoot + */ +@JsonPropertyOrder({ + LinkedPATemplateUpdateParametersRoot.JSON_PROPERTY_DATA, + LinkedPATemplateUpdateParametersRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class LinkedPATemplateUpdateParametersRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private LinkedPATemplateUpdateParameters data; + + public static final String JSON_PROPERTY_META = "meta"; + private JsonNullable meta = JsonNullable.of(null); + + public LinkedPATemplateUpdateParametersRoot() { + } + + public LinkedPATemplateUpdateParametersRoot data(LinkedPATemplateUpdateParameters data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public LinkedPATemplateUpdateParameters getData() { + return data; + } + + + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setData(LinkedPATemplateUpdateParameters data) { + this.data = data; + } + + + public LinkedPATemplateUpdateParametersRoot meta(Object meta) { + this.meta = JsonNullable.of(meta); + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public JsonNullable getMeta_JsonNullable() { + return meta; + } + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } + + public void setMeta(Object meta) { + this.meta = JsonNullable.of(meta); + } + + + /** + * Return true if this LinkedPATemplateUpdateParametersRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LinkedPATemplateUpdateParametersRoot linkedPATemplateUpdateParametersRoot = (LinkedPATemplateUpdateParametersRoot) o; + return Objects.equals(this.data, linkedPATemplateUpdateParametersRoot.data) && + equalsNullable(this.meta, linkedPATemplateUpdateParametersRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + } + + @Override + public int hashCode() { + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LinkedPATemplateUpdateParametersRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/NPOOptimizationParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/NPOOptimizationParameters.java index f12eae5d..a58f3cee 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/NPOOptimizationParameters.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/NPOOptimizationParameters.java @@ -58,6 +58,8 @@ public class NPOOptimizationParameters implements Serializable { public static final String JSON_PROPERTY_OUTPUT_TYPES = "outputTypes"; private OptimizerOutputTypes outputTypes; + public NPOOptimizationParameters() { + } public NPOOptimizationParameters strategy(NPOOptimizerStrategy strategy) { this.strategy = strategy; @@ -68,6 +70,7 @@ public NPOOptimizationParameters strategy(NPOOptimizerStrategy strategy) { * Get strategy * @return strategy **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_STRATEGY) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -77,6 +80,8 @@ public NPOOptimizerStrategy getStrategy() { } + @JsonProperty(JSON_PROPERTY_STRATEGY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setStrategy(NPOOptimizerStrategy strategy) { this.strategy = strategy; } @@ -101,6 +106,8 @@ public OptimizerAccount getAccount() { } + @JsonProperty(JSON_PROPERTY_ACCOUNT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccount(OptimizerAccount account) { this.account = account; } @@ -125,6 +132,8 @@ public Optimization getOptimization() { } + @JsonProperty(JSON_PROPERTY_OPTIMIZATION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOptimization(Optimization optimization) { this.optimization = optimization; } @@ -139,6 +148,7 @@ public NPOOptimizationParameters outputTypes(OptimizerOutputTypes outputTypes) { * Get outputTypes * @return outputTypes **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_OUTPUT_TYPES) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -148,6 +158,8 @@ public OptimizerOutputTypes getOutputTypes() { } + @JsonProperty(JSON_PROPERTY_OUTPUT_TYPES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setOutputTypes(OptimizerOutputTypes outputTypes) { this.outputTypes = outputTypes; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/NPOOptimizationParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/NPOOptimizationParametersRoot.java index 4885ac1e..2593a3eb 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/NPOOptimizationParametersRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/NPOOptimizationParametersRoot.java @@ -47,6 +47,8 @@ public class NPOOptimizationParametersRoot implements Serializable { public static final String JSON_PROPERTY_META = "meta"; private Object meta; + public NPOOptimizationParametersRoot() { + } public NPOOptimizationParametersRoot data(NPOOptimizationParameters data) { this.data = data; @@ -67,6 +69,8 @@ public NPOOptimizationParameters getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(NPOOptimizationParameters data) { this.data = data; } @@ -91,6 +95,8 @@ public Object getMeta() { } + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMeta(Object meta) { this.meta = meta; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/NPOOptimizerStrategy.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/NPOOptimizerStrategy.java index 4eb19615..72ebb7d8 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/NPOOptimizerStrategy.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/NPOOptimizerStrategy.java @@ -47,6 +47,8 @@ public class NPOOptimizerStrategy implements Serializable { public static final String JSON_PROPERTY_ID = "id"; private String id; + public NPOOptimizerStrategy() { + } public NPOOptimizerStrategy overrides(NPOOptimizerStrategyOverrides overrides) { this.overrides = overrides; @@ -67,6 +69,8 @@ public NPOOptimizerStrategyOverrides getOverrides() { } + @JsonProperty(JSON_PROPERTY_OVERRIDES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOverrides(NPOOptimizerStrategyOverrides overrides) { this.overrides = overrides; } @@ -81,6 +85,7 @@ public NPOOptimizerStrategy id(String id) { * OptimizerStrategy document path * @return id **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "OptimizerStrategy document path") @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -90,6 +95,8 @@ public String getId() { } + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setId(String id) { this.id = id; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/NPOOptimizerStrategyOverrides.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/NPOOptimizerStrategyOverrides.java index 8317e128..b9de658c 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/NPOOptimizerStrategyOverrides.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/NPOOptimizerStrategyOverrides.java @@ -59,6 +59,8 @@ public class NPOOptimizerStrategyOverrides implements Serializable { public static final String JSON_PROPERTY_ALPHA = "alpha"; private String alpha; + public NPOOptimizerStrategyOverrides() { + } public NPOOptimizerStrategyOverrides objective(java.util.Map objective) { this.objective = objective; @@ -80,13 +82,15 @@ public NPOOptimizerStrategyOverrides putObjectiveItem(String key, Object objecti @javax.annotation.Nullable @ApiModelProperty(value = "Objective parameters") @JsonProperty(JSON_PROPERTY_OBJECTIVE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) public java.util.Map getObjective() { return objective; } + @JsonProperty(JSON_PROPERTY_OBJECTIVE) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) public void setObjective(java.util.Map objective) { this.objective = objective; } @@ -119,6 +123,8 @@ public java.util.List getConstraints() { } + @JsonProperty(JSON_PROPERTY_CONSTRAINTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setConstraints(java.util.List constraints) { this.constraints = constraints; } @@ -143,6 +149,8 @@ public String getTax() { } + @JsonProperty(JSON_PROPERTY_TAX) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTax(String tax) { this.tax = tax; } @@ -167,6 +175,8 @@ public String getTransactionCost() { } + @JsonProperty(JSON_PROPERTY_TRANSACTION_COST) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransactionCost(String transactionCost) { this.transactionCost = transactionCost; } @@ -191,6 +201,8 @@ public String getAlpha() { } + @JsonProperty(JSON_PROPERTY_ALPHA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAlpha(String alpha) { this.alpha = alpha; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ObjectRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ObjectRoot.java index 87bf8922..6a8b551c 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ObjectRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ObjectRoot.java @@ -24,6 +24,10 @@ import com.fasterxml.jackson.annotation.JsonValue; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; import java.io.Serializable; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import factset.analyticsapi.engines.JSON; @@ -41,11 +45,13 @@ public class ObjectRoot implements Serializable { private static final long serialVersionUID = 1L; public static final String JSON_PROPERTY_DATA = "data"; - private Object data; + private Object data = null; public static final String JSON_PROPERTY_META = "meta"; - private Object meta; + private JsonNullable meta = JsonNullable.of(null); + public ObjectRoot() { + } public ObjectRoot data(Object data) { this.data = data; @@ -56,6 +62,7 @@ public ObjectRoot data(Object data) { * Get data * @return data **/ + @javax.annotation.Nullable @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -65,13 +72,15 @@ public Object getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setData(Object data) { this.data = data; } public ObjectRoot meta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); return this; } @@ -81,16 +90,26 @@ public ObjectRoot meta(Object meta) { **/ @javax.annotation.Nullable @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + @JsonProperty(JSON_PROPERTY_META) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Object getMeta() { + public JsonNullable getMeta_JsonNullable() { return meta; } - + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } public void setMeta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); } @@ -107,12 +126,23 @@ public boolean equals(Object o) { } ObjectRoot objectRoot = (ObjectRoot) o; return Objects.equals(this.data, objectRoot.data) && - Objects.equals(this.meta, objectRoot.meta); + equalsNullable(this.meta, objectRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); } @Override public int hashCode() { - return Objects.hash(data, meta); + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; } @Override diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OneOfQuantDates.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OneOfQuantDates.java new file mode 100644 index 00000000..9cfb900c --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OneOfQuantDates.java @@ -0,0 +1,340 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonSubTypes; +import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.QuantDateList; +import factset.analyticsapi.engines.models.QuantFdsDate; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + +import com.fasterxml.jackson.core.type.TypeReference; + +import javax.ws.rs.core.GenericType; +import javax.ws.rs.core.Response; +import java.io.IOException; +import java.util.logging.Level; +import java.util.logging.Logger; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashSet; + +import com.fasterxml.jackson.core.JsonGenerator; +import com.fasterxml.jackson.core.JsonParser; +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.core.JsonToken; +import com.fasterxml.jackson.core.type.TypeReference; +import com.fasterxml.jackson.databind.DeserializationContext; +import com.fasterxml.jackson.databind.JsonMappingException; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.MapperFeature; +import com.fasterxml.jackson.databind.SerializerProvider; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.fasterxml.jackson.databind.annotation.JsonSerialize; +import com.fasterxml.jackson.databind.deser.std.StdDeserializer; +import com.fasterxml.jackson.databind.ser.std.StdSerializer; +import factset.analyticsapi.engines.JSON; + +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +@JsonDeserialize(using = OneOfQuantDates.OneOfQuantDatesDeserializer.class) +@JsonSerialize(using = OneOfQuantDates.OneOfQuantDatesSerializer.class) +public class OneOfQuantDates extends AbstractOpenApiSchema, Serializable { + private static final Logger log = Logger.getLogger(OneOfQuantDates.class.getName()); + + public static class OneOfQuantDatesSerializer extends StdSerializer { + public OneOfQuantDatesSerializer(Class t) { + super(t); + } + + public OneOfQuantDatesSerializer() { + this(null); + } + + @Override + public void serialize(OneOfQuantDates value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonProcessingException { + jgen.writeObject(value.getActualInstance()); + } + } + + public static class OneOfQuantDatesDeserializer extends StdDeserializer { + public OneOfQuantDatesDeserializer() { + this(OneOfQuantDates.class); + } + + public OneOfQuantDatesDeserializer(Class vc) { + super(vc); + } + + @Override + public OneOfQuantDates deserialize(JsonParser jp, DeserializationContext ctxt) throws IOException, JsonProcessingException { + JsonNode tree = jp.readValueAsTree(); + Object deserialized = null; + OneOfQuantDates newOneOfQuantDates = new OneOfQuantDates(); + Map result2 = tree.traverse(jp.getCodec()).readValueAs(new TypeReference>() {}); + String discriminatorValue = (String)result2.get("source"); + switch (discriminatorValue) { + case "DateList": + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantDateList.class); + newOneOfQuantDates.setActualInstance(deserialized); + return newOneOfQuantDates; + case "FdsDate": + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantFdsDate.class); + newOneOfQuantDates.setActualInstance(deserialized); + return newOneOfQuantDates; + case "QuantDateList": + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantDateList.class); + newOneOfQuantDates.setActualInstance(deserialized); + return newOneOfQuantDates; + case "QuantFdsDate": + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantFdsDate.class); + newOneOfQuantDates.setActualInstance(deserialized); + return newOneOfQuantDates; + default: + log.log(Level.WARNING, String.format("Failed to lookup discriminator value `%s` for OneOfQuantDates. Possible values: DateList FdsDate QuantDateList QuantFdsDate", discriminatorValue)); + } + + boolean typeCoercion = ctxt.isEnabled(MapperFeature.ALLOW_COERCION_OF_SCALARS); + int match = 0; + JsonToken token = tree.traverse(jp.getCodec()).nextToken(); + // deserialize QuantDateList + try { + boolean attemptParsing = true; + // ensure that we respect type coercion as set on the client ObjectMapper + if (QuantDateList.class.equals(Integer.class) || QuantDateList.class.equals(Long.class) || QuantDateList.class.equals(Float.class) || QuantDateList.class.equals(Double.class) || QuantDateList.class.equals(Boolean.class) || QuantDateList.class.equals(String.class)) { + attemptParsing = typeCoercion; + if (!attemptParsing) { + attemptParsing |= ((QuantDateList.class.equals(Integer.class) || QuantDateList.class.equals(Long.class)) && token == JsonToken.VALUE_NUMBER_INT); + attemptParsing |= ((QuantDateList.class.equals(Float.class) || QuantDateList.class.equals(Double.class)) && token == JsonToken.VALUE_NUMBER_FLOAT); + attemptParsing |= (QuantDateList.class.equals(Boolean.class) && (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE)); + attemptParsing |= (QuantDateList.class.equals(String.class) && token == JsonToken.VALUE_STRING); + } + } + if (attemptParsing) { + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantDateList.class); + // TODO: there is no validation against JSON schema constraints + // (min, max, enum, pattern...), this does not perform a strict JSON + // validation, which means the 'match' count may be higher than it should be. + match++; + log.log(Level.FINER, "Input data matches schema 'QuantDateList'"); + } + } catch (Exception e) { + // deserialization failed, continue + log.log(Level.FINER, "Input data does not match schema 'QuantDateList'", e); + } + + // deserialize QuantFdsDate + try { + boolean attemptParsing = true; + // ensure that we respect type coercion as set on the client ObjectMapper + if (QuantFdsDate.class.equals(Integer.class) || QuantFdsDate.class.equals(Long.class) || QuantFdsDate.class.equals(Float.class) || QuantFdsDate.class.equals(Double.class) || QuantFdsDate.class.equals(Boolean.class) || QuantFdsDate.class.equals(String.class)) { + attemptParsing = typeCoercion; + if (!attemptParsing) { + attemptParsing |= ((QuantFdsDate.class.equals(Integer.class) || QuantFdsDate.class.equals(Long.class)) && token == JsonToken.VALUE_NUMBER_INT); + attemptParsing |= ((QuantFdsDate.class.equals(Float.class) || QuantFdsDate.class.equals(Double.class)) && token == JsonToken.VALUE_NUMBER_FLOAT); + attemptParsing |= (QuantFdsDate.class.equals(Boolean.class) && (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE)); + attemptParsing |= (QuantFdsDate.class.equals(String.class) && token == JsonToken.VALUE_STRING); + } + } + if (attemptParsing) { + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantFdsDate.class); + // TODO: there is no validation against JSON schema constraints + // (min, max, enum, pattern...), this does not perform a strict JSON + // validation, which means the 'match' count may be higher than it should be. + match++; + log.log(Level.FINER, "Input data matches schema 'QuantFdsDate'"); + } + } catch (Exception e) { + // deserialization failed, continue + log.log(Level.FINER, "Input data does not match schema 'QuantFdsDate'", e); + } + + if (match == 1) { + OneOfQuantDates ret = new OneOfQuantDates(); + ret.setActualInstance(deserialized); + return ret; + } + throw new IOException(String.format("Failed deserialization for OneOfQuantDates: %d classes match result, expected 1", match)); + } + + /** + * Handle deserialization of the 'null' value. + */ + @Override + public OneOfQuantDates getNullValue(DeserializationContext ctxt) throws JsonMappingException { + throw new JsonMappingException(ctxt.getParser(), "OneOfQuantDates cannot be null"); + } + } + + // store a list of schema names defined in oneOf + public static final Map schemas = new HashMap(); + + public OneOfQuantDates() { + super("oneOf", Boolean.FALSE); + } + /** + * A container for additional, undeclared properties. + * This is a holder for any undeclared properties as specified with + * the 'additionalProperties' keyword in the OAS document. + */ + private Map additionalProperties; + + /** + * Set the additional (undeclared) property with the specified name and value. + * If the property does not already exist, create it otherwise replace it. + */ + @JsonAnySetter + public OneOfQuantDates putAdditionalProperty(String key, Object value) { + if (this.additionalProperties == null) { + this.additionalProperties = new HashMap(); + } + this.additionalProperties.put(key, value); + return this; + } + + /** + * Return the additional (undeclared) property. + */ + @JsonAnyGetter + public Map getAdditionalProperties() { + return additionalProperties; + } + + /** + * Return the additional (undeclared) property with the specified name. + */ + public Object getAdditionalProperty(String key) { + if (this.additionalProperties == null) { + return null; + } + return this.additionalProperties.get(key); + } + + /** + * Return true if this OneOfQuantDates object is equal to o. + */ + @Override + public boolean equals(Object o) { + return super.equals(o) && Objects.equals(this.additionalProperties, ((OneOfQuantDates)o).additionalProperties); + } + + @Override + public int hashCode() { + return Objects.hash(getActualInstance(), isNullable(), getSchemaType(), additionalProperties); + } + public OneOfQuantDates(QuantDateList o) { + super("oneOf", Boolean.FALSE); + setActualInstance(o); + } + + public OneOfQuantDates(QuantFdsDate o) { + super("oneOf", Boolean.FALSE); + setActualInstance(o); + } + + static { + schemas.put("QuantDateList", new GenericType() { + }); + schemas.put("QuantFdsDate", new GenericType() { + }); + JSON.registerDescendants(OneOfQuantDates.class, Collections.unmodifiableMap(schemas)); + // Initialize and register the discriminator mappings. + Map> mappings = new HashMap>(); + mappings.put("DateList", QuantDateList.class); + mappings.put("FdsDate", QuantFdsDate.class); + mappings.put("QuantDateList", QuantDateList.class); + mappings.put("QuantFdsDate", QuantFdsDate.class); + mappings.put("OneOfQuantDates", OneOfQuantDates.class); + JSON.registerDiscriminator(OneOfQuantDates.class, "source", mappings); + } + + @Override + public Map getSchemas() { + return OneOfQuantDates.schemas; + } + + /** + * Set the instance that matches the oneOf child schema, check + * the instance parameter is valid against the oneOf child schemas: + * QuantDateList, QuantFdsDate + * + * It could be an instance of the 'oneOf' schemas. + * The oneOf child schemas may themselves be a composed schema (allOf, anyOf, oneOf). + */ + @Override + public void setActualInstance(Object instance) { + if (JSON.isInstanceOf(QuantDateList.class, instance, new HashSet>())) { + super.setActualInstance(instance); + return; + } + + if (JSON.isInstanceOf(QuantFdsDate.class, instance, new HashSet>())) { + super.setActualInstance(instance); + return; + } + + throw new RuntimeException("Invalid instance type. Must be QuantDateList, QuantFdsDate"); + } + + /** + * Get the actual instance, which can be the following: + * QuantDateList, QuantFdsDate + * + * @return The actual instance (QuantDateList, QuantFdsDate) + */ + @Override + public Object getActualInstance() { + return super.getActualInstance(); + } + + /** + * Get the actual instance of `QuantDateList`. If the actual instance is not `QuantDateList`, + * the ClassCastException will be thrown. + * + * @return The actual instance of `QuantDateList` + * @throws ClassCastException if the instance is not `QuantDateList` + */ + public QuantDateList getQuantDateList() throws ClassCastException { + return (QuantDateList)super.getActualInstance(); + } + + /** + * Get the actual instance of `QuantFdsDate`. If the actual instance is not `QuantFdsDate`, + * the ClassCastException will be thrown. + * + * @return The actual instance of `QuantFdsDate` + * @throws ClassCastException if the instance is not `QuantFdsDate` + */ + public QuantFdsDate getQuantFdsDate() throws ClassCastException { + return (QuantFdsDate)super.getActualInstance(); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OneOfQuantFormulasArray.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OneOfQuantFormulasArray.java new file mode 100644 index 00000000..73a9d0d2 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OneOfQuantFormulasArray.java @@ -0,0 +1,460 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonSubTypes; +import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.QuantAllUniversalScreenParameters; +import factset.analyticsapi.engines.models.QuantFqlExpression; +import factset.analyticsapi.engines.models.QuantScreeningExpression; +import factset.analyticsapi.engines.models.QuantUniversalScreenParameter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + +import com.fasterxml.jackson.core.type.TypeReference; + +import javax.ws.rs.core.GenericType; +import javax.ws.rs.core.Response; +import java.io.IOException; +import java.util.logging.Level; +import java.util.logging.Logger; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashSet; + +import com.fasterxml.jackson.core.JsonGenerator; +import com.fasterxml.jackson.core.JsonParser; +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.core.JsonToken; +import com.fasterxml.jackson.core.type.TypeReference; +import com.fasterxml.jackson.databind.DeserializationContext; +import com.fasterxml.jackson.databind.JsonMappingException; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.MapperFeature; +import com.fasterxml.jackson.databind.SerializerProvider; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.fasterxml.jackson.databind.annotation.JsonSerialize; +import com.fasterxml.jackson.databind.deser.std.StdDeserializer; +import com.fasterxml.jackson.databind.ser.std.StdSerializer; +import factset.analyticsapi.engines.JSON; + +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +@JsonDeserialize(using = OneOfQuantFormulasArray.OneOfQuantFormulasArrayDeserializer.class) +@JsonSerialize(using = OneOfQuantFormulasArray.OneOfQuantFormulasArraySerializer.class) +public class OneOfQuantFormulasArray extends AbstractOpenApiSchema, Serializable { + private static final Logger log = Logger.getLogger(OneOfQuantFormulasArray.class.getName()); + + public static class OneOfQuantFormulasArraySerializer extends StdSerializer { + public OneOfQuantFormulasArraySerializer(Class t) { + super(t); + } + + public OneOfQuantFormulasArraySerializer() { + this(null); + } + + @Override + public void serialize(OneOfQuantFormulasArray value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonProcessingException { + jgen.writeObject(value.getActualInstance()); + } + } + + public static class OneOfQuantFormulasArrayDeserializer extends StdDeserializer { + public OneOfQuantFormulasArrayDeserializer() { + this(OneOfQuantFormulasArray.class); + } + + public OneOfQuantFormulasArrayDeserializer(Class vc) { + super(vc); + } + + @Override + public OneOfQuantFormulasArray deserialize(JsonParser jp, DeserializationContext ctxt) throws IOException, JsonProcessingException { + JsonNode tree = jp.readValueAsTree(); + Object deserialized = null; + OneOfQuantFormulasArray newOneOfQuantFormulasArray = new OneOfQuantFormulasArray(); + Map result2 = tree.traverse(jp.getCodec()).readValueAs(new TypeReference>() {}); + String discriminatorValue = (String)result2.get("source"); + switch (discriminatorValue) { + case "AllUniversalScreenParameters": + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantAllUniversalScreenParameters.class); + newOneOfQuantFormulasArray.setActualInstance(deserialized); + return newOneOfQuantFormulasArray; + case "FqlExpression": + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantFqlExpression.class); + newOneOfQuantFormulasArray.setActualInstance(deserialized); + return newOneOfQuantFormulasArray; + case "QuantAllUniversalScreenParameters": + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantAllUniversalScreenParameters.class); + newOneOfQuantFormulasArray.setActualInstance(deserialized); + return newOneOfQuantFormulasArray; + case "QuantFqlExpression": + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantFqlExpression.class); + newOneOfQuantFormulasArray.setActualInstance(deserialized); + return newOneOfQuantFormulasArray; + case "QuantScreeningExpression": + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantScreeningExpression.class); + newOneOfQuantFormulasArray.setActualInstance(deserialized); + return newOneOfQuantFormulasArray; + case "QuantUniversalScreenParameter": + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantUniversalScreenParameter.class); + newOneOfQuantFormulasArray.setActualInstance(deserialized); + return newOneOfQuantFormulasArray; + case "ScreeningExpression": + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantScreeningExpression.class); + newOneOfQuantFormulasArray.setActualInstance(deserialized); + return newOneOfQuantFormulasArray; + case "UniversalScreenParameter": + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantUniversalScreenParameter.class); + newOneOfQuantFormulasArray.setActualInstance(deserialized); + return newOneOfQuantFormulasArray; + default: + log.log(Level.WARNING, String.format("Failed to lookup discriminator value `%s` for OneOfQuantFormulasArray. Possible values: AllUniversalScreenParameters FqlExpression QuantAllUniversalScreenParameters QuantFqlExpression QuantScreeningExpression QuantUniversalScreenParameter ScreeningExpression UniversalScreenParameter", discriminatorValue)); + } + + boolean typeCoercion = ctxt.isEnabled(MapperFeature.ALLOW_COERCION_OF_SCALARS); + int match = 0; + JsonToken token = tree.traverse(jp.getCodec()).nextToken(); + // deserialize QuantAllUniversalScreenParameters + try { + boolean attemptParsing = true; + // ensure that we respect type coercion as set on the client ObjectMapper + if (QuantAllUniversalScreenParameters.class.equals(Integer.class) || QuantAllUniversalScreenParameters.class.equals(Long.class) || QuantAllUniversalScreenParameters.class.equals(Float.class) || QuantAllUniversalScreenParameters.class.equals(Double.class) || QuantAllUniversalScreenParameters.class.equals(Boolean.class) || QuantAllUniversalScreenParameters.class.equals(String.class)) { + attemptParsing = typeCoercion; + if (!attemptParsing) { + attemptParsing |= ((QuantAllUniversalScreenParameters.class.equals(Integer.class) || QuantAllUniversalScreenParameters.class.equals(Long.class)) && token == JsonToken.VALUE_NUMBER_INT); + attemptParsing |= ((QuantAllUniversalScreenParameters.class.equals(Float.class) || QuantAllUniversalScreenParameters.class.equals(Double.class)) && token == JsonToken.VALUE_NUMBER_FLOAT); + attemptParsing |= (QuantAllUniversalScreenParameters.class.equals(Boolean.class) && (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE)); + attemptParsing |= (QuantAllUniversalScreenParameters.class.equals(String.class) && token == JsonToken.VALUE_STRING); + } + } + if (attemptParsing) { + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantAllUniversalScreenParameters.class); + // TODO: there is no validation against JSON schema constraints + // (min, max, enum, pattern...), this does not perform a strict JSON + // validation, which means the 'match' count may be higher than it should be. + match++; + log.log(Level.FINER, "Input data matches schema 'QuantAllUniversalScreenParameters'"); + } + } catch (Exception e) { + // deserialization failed, continue + log.log(Level.FINER, "Input data does not match schema 'QuantAllUniversalScreenParameters'", e); + } + + // deserialize QuantFqlExpression + try { + boolean attemptParsing = true; + // ensure that we respect type coercion as set on the client ObjectMapper + if (QuantFqlExpression.class.equals(Integer.class) || QuantFqlExpression.class.equals(Long.class) || QuantFqlExpression.class.equals(Float.class) || QuantFqlExpression.class.equals(Double.class) || QuantFqlExpression.class.equals(Boolean.class) || QuantFqlExpression.class.equals(String.class)) { + attemptParsing = typeCoercion; + if (!attemptParsing) { + attemptParsing |= ((QuantFqlExpression.class.equals(Integer.class) || QuantFqlExpression.class.equals(Long.class)) && token == JsonToken.VALUE_NUMBER_INT); + attemptParsing |= ((QuantFqlExpression.class.equals(Float.class) || QuantFqlExpression.class.equals(Double.class)) && token == JsonToken.VALUE_NUMBER_FLOAT); + attemptParsing |= (QuantFqlExpression.class.equals(Boolean.class) && (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE)); + attemptParsing |= (QuantFqlExpression.class.equals(String.class) && token == JsonToken.VALUE_STRING); + } + } + if (attemptParsing) { + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantFqlExpression.class); + // TODO: there is no validation against JSON schema constraints + // (min, max, enum, pattern...), this does not perform a strict JSON + // validation, which means the 'match' count may be higher than it should be. + match++; + log.log(Level.FINER, "Input data matches schema 'QuantFqlExpression'"); + } + } catch (Exception e) { + // deserialization failed, continue + log.log(Level.FINER, "Input data does not match schema 'QuantFqlExpression'", e); + } + + // deserialize QuantScreeningExpression + try { + boolean attemptParsing = true; + // ensure that we respect type coercion as set on the client ObjectMapper + if (QuantScreeningExpression.class.equals(Integer.class) || QuantScreeningExpression.class.equals(Long.class) || QuantScreeningExpression.class.equals(Float.class) || QuantScreeningExpression.class.equals(Double.class) || QuantScreeningExpression.class.equals(Boolean.class) || QuantScreeningExpression.class.equals(String.class)) { + attemptParsing = typeCoercion; + if (!attemptParsing) { + attemptParsing |= ((QuantScreeningExpression.class.equals(Integer.class) || QuantScreeningExpression.class.equals(Long.class)) && token == JsonToken.VALUE_NUMBER_INT); + attemptParsing |= ((QuantScreeningExpression.class.equals(Float.class) || QuantScreeningExpression.class.equals(Double.class)) && token == JsonToken.VALUE_NUMBER_FLOAT); + attemptParsing |= (QuantScreeningExpression.class.equals(Boolean.class) && (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE)); + attemptParsing |= (QuantScreeningExpression.class.equals(String.class) && token == JsonToken.VALUE_STRING); + } + } + if (attemptParsing) { + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantScreeningExpression.class); + // TODO: there is no validation against JSON schema constraints + // (min, max, enum, pattern...), this does not perform a strict JSON + // validation, which means the 'match' count may be higher than it should be. + match++; + log.log(Level.FINER, "Input data matches schema 'QuantScreeningExpression'"); + } + } catch (Exception e) { + // deserialization failed, continue + log.log(Level.FINER, "Input data does not match schema 'QuantScreeningExpression'", e); + } + + // deserialize QuantUniversalScreenParameter + try { + boolean attemptParsing = true; + // ensure that we respect type coercion as set on the client ObjectMapper + if (QuantUniversalScreenParameter.class.equals(Integer.class) || QuantUniversalScreenParameter.class.equals(Long.class) || QuantUniversalScreenParameter.class.equals(Float.class) || QuantUniversalScreenParameter.class.equals(Double.class) || QuantUniversalScreenParameter.class.equals(Boolean.class) || QuantUniversalScreenParameter.class.equals(String.class)) { + attemptParsing = typeCoercion; + if (!attemptParsing) { + attemptParsing |= ((QuantUniversalScreenParameter.class.equals(Integer.class) || QuantUniversalScreenParameter.class.equals(Long.class)) && token == JsonToken.VALUE_NUMBER_INT); + attemptParsing |= ((QuantUniversalScreenParameter.class.equals(Float.class) || QuantUniversalScreenParameter.class.equals(Double.class)) && token == JsonToken.VALUE_NUMBER_FLOAT); + attemptParsing |= (QuantUniversalScreenParameter.class.equals(Boolean.class) && (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE)); + attemptParsing |= (QuantUniversalScreenParameter.class.equals(String.class) && token == JsonToken.VALUE_STRING); + } + } + if (attemptParsing) { + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantUniversalScreenParameter.class); + // TODO: there is no validation against JSON schema constraints + // (min, max, enum, pattern...), this does not perform a strict JSON + // validation, which means the 'match' count may be higher than it should be. + match++; + log.log(Level.FINER, "Input data matches schema 'QuantUniversalScreenParameter'"); + } + } catch (Exception e) { + // deserialization failed, continue + log.log(Level.FINER, "Input data does not match schema 'QuantUniversalScreenParameter'", e); + } + + if (match == 1) { + OneOfQuantFormulasArray ret = new OneOfQuantFormulasArray(); + ret.setActualInstance(deserialized); + return ret; + } + throw new IOException(String.format("Failed deserialization for OneOfQuantFormulasArray: %d classes match result, expected 1", match)); + } + + /** + * Handle deserialization of the 'null' value. + */ + @Override + public OneOfQuantFormulasArray getNullValue(DeserializationContext ctxt) throws JsonMappingException { + throw new JsonMappingException(ctxt.getParser(), "OneOfQuantFormulasArray cannot be null"); + } + } + + // store a list of schema names defined in oneOf + public static final Map schemas = new HashMap(); + + public OneOfQuantFormulasArray() { + super("oneOf", Boolean.FALSE); + } + /** + * A container for additional, undeclared properties. + * This is a holder for any undeclared properties as specified with + * the 'additionalProperties' keyword in the OAS document. + */ + private Map additionalProperties; + + /** + * Set the additional (undeclared) property with the specified name and value. + * If the property does not already exist, create it otherwise replace it. + */ + @JsonAnySetter + public OneOfQuantFormulasArray putAdditionalProperty(String key, Object value) { + if (this.additionalProperties == null) { + this.additionalProperties = new HashMap(); + } + this.additionalProperties.put(key, value); + return this; + } + + /** + * Return the additional (undeclared) property. + */ + @JsonAnyGetter + public Map getAdditionalProperties() { + return additionalProperties; + } + + /** + * Return the additional (undeclared) property with the specified name. + */ + public Object getAdditionalProperty(String key) { + if (this.additionalProperties == null) { + return null; + } + return this.additionalProperties.get(key); + } + + /** + * Return true if this OneOfQuantFormulasArray object is equal to o. + */ + @Override + public boolean equals(Object o) { + return super.equals(o) && Objects.equals(this.additionalProperties, ((OneOfQuantFormulasArray)o).additionalProperties); + } + + @Override + public int hashCode() { + return Objects.hash(getActualInstance(), isNullable(), getSchemaType(), additionalProperties); + } + public OneOfQuantFormulasArray(QuantAllUniversalScreenParameters o) { + super("oneOf", Boolean.FALSE); + setActualInstance(o); + } + + public OneOfQuantFormulasArray(QuantFqlExpression o) { + super("oneOf", Boolean.FALSE); + setActualInstance(o); + } + + public OneOfQuantFormulasArray(QuantScreeningExpression o) { + super("oneOf", Boolean.FALSE); + setActualInstance(o); + } + + public OneOfQuantFormulasArray(QuantUniversalScreenParameter o) { + super("oneOf", Boolean.FALSE); + setActualInstance(o); + } + + static { + schemas.put("QuantAllUniversalScreenParameters", new GenericType() { + }); + schemas.put("QuantFqlExpression", new GenericType() { + }); + schemas.put("QuantScreeningExpression", new GenericType() { + }); + schemas.put("QuantUniversalScreenParameter", new GenericType() { + }); + JSON.registerDescendants(OneOfQuantFormulasArray.class, Collections.unmodifiableMap(schemas)); + // Initialize and register the discriminator mappings. + Map> mappings = new HashMap>(); + mappings.put("AllUniversalScreenParameters", QuantAllUniversalScreenParameters.class); + mappings.put("FqlExpression", QuantFqlExpression.class); + mappings.put("QuantAllUniversalScreenParameters", QuantAllUniversalScreenParameters.class); + mappings.put("QuantFqlExpression", QuantFqlExpression.class); + mappings.put("QuantScreeningExpression", QuantScreeningExpression.class); + mappings.put("QuantUniversalScreenParameter", QuantUniversalScreenParameter.class); + mappings.put("ScreeningExpression", QuantScreeningExpression.class); + mappings.put("UniversalScreenParameter", QuantUniversalScreenParameter.class); + mappings.put("OneOfQuantFormulasArray", OneOfQuantFormulasArray.class); + JSON.registerDiscriminator(OneOfQuantFormulasArray.class, "source", mappings); + } + + @Override + public Map getSchemas() { + return OneOfQuantFormulasArray.schemas; + } + + /** + * Set the instance that matches the oneOf child schema, check + * the instance parameter is valid against the oneOf child schemas: + * QuantAllUniversalScreenParameters, QuantFqlExpression, QuantScreeningExpression, QuantUniversalScreenParameter + * + * It could be an instance of the 'oneOf' schemas. + * The oneOf child schemas may themselves be a composed schema (allOf, anyOf, oneOf). + */ + @Override + public void setActualInstance(Object instance) { + if (JSON.isInstanceOf(QuantAllUniversalScreenParameters.class, instance, new HashSet>())) { + super.setActualInstance(instance); + return; + } + + if (JSON.isInstanceOf(QuantFqlExpression.class, instance, new HashSet>())) { + super.setActualInstance(instance); + return; + } + + if (JSON.isInstanceOf(QuantScreeningExpression.class, instance, new HashSet>())) { + super.setActualInstance(instance); + return; + } + + if (JSON.isInstanceOf(QuantUniversalScreenParameter.class, instance, new HashSet>())) { + super.setActualInstance(instance); + return; + } + + throw new RuntimeException("Invalid instance type. Must be QuantAllUniversalScreenParameters, QuantFqlExpression, QuantScreeningExpression, QuantUniversalScreenParameter"); + } + + /** + * Get the actual instance, which can be the following: + * QuantAllUniversalScreenParameters, QuantFqlExpression, QuantScreeningExpression, QuantUniversalScreenParameter + * + * @return The actual instance (QuantAllUniversalScreenParameters, QuantFqlExpression, QuantScreeningExpression, QuantUniversalScreenParameter) + */ + @Override + public Object getActualInstance() { + return super.getActualInstance(); + } + + /** + * Get the actual instance of `QuantAllUniversalScreenParameters`. If the actual instance is not `QuantAllUniversalScreenParameters`, + * the ClassCastException will be thrown. + * + * @return The actual instance of `QuantAllUniversalScreenParameters` + * @throws ClassCastException if the instance is not `QuantAllUniversalScreenParameters` + */ + public QuantAllUniversalScreenParameters getQuantAllUniversalScreenParameters() throws ClassCastException { + return (QuantAllUniversalScreenParameters)super.getActualInstance(); + } + + /** + * Get the actual instance of `QuantFqlExpression`. If the actual instance is not `QuantFqlExpression`, + * the ClassCastException will be thrown. + * + * @return The actual instance of `QuantFqlExpression` + * @throws ClassCastException if the instance is not `QuantFqlExpression` + */ + public QuantFqlExpression getQuantFqlExpression() throws ClassCastException { + return (QuantFqlExpression)super.getActualInstance(); + } + + /** + * Get the actual instance of `QuantScreeningExpression`. If the actual instance is not `QuantScreeningExpression`, + * the ClassCastException will be thrown. + * + * @return The actual instance of `QuantScreeningExpression` + * @throws ClassCastException if the instance is not `QuantScreeningExpression` + */ + public QuantScreeningExpression getQuantScreeningExpression() throws ClassCastException { + return (QuantScreeningExpression)super.getActualInstance(); + } + + /** + * Get the actual instance of `QuantUniversalScreenParameter`. If the actual instance is not `QuantUniversalScreenParameter`, + * the ClassCastException will be thrown. + * + * @return The actual instance of `QuantUniversalScreenParameter` + * @throws ClassCastException if the instance is not `QuantUniversalScreenParameter` + */ + public QuantUniversalScreenParameter getQuantUniversalScreenParameter() throws ClassCastException { + return (QuantUniversalScreenParameter)super.getActualInstance(); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OneOfQuantUniverse.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OneOfQuantUniverse.java new file mode 100644 index 00000000..ad829310 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OneOfQuantUniverse.java @@ -0,0 +1,400 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonSubTypes; +import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.QuantIdentifierUniverse; +import factset.analyticsapi.engines.models.QuantScreeningExpressionUniverse; +import factset.analyticsapi.engines.models.QuantUniversalScreenUniverse; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + +import com.fasterxml.jackson.core.type.TypeReference; + +import javax.ws.rs.core.GenericType; +import javax.ws.rs.core.Response; +import java.io.IOException; +import java.util.logging.Level; +import java.util.logging.Logger; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashSet; + +import com.fasterxml.jackson.core.JsonGenerator; +import com.fasterxml.jackson.core.JsonParser; +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.core.JsonToken; +import com.fasterxml.jackson.core.type.TypeReference; +import com.fasterxml.jackson.databind.DeserializationContext; +import com.fasterxml.jackson.databind.JsonMappingException; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.MapperFeature; +import com.fasterxml.jackson.databind.SerializerProvider; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.fasterxml.jackson.databind.annotation.JsonSerialize; +import com.fasterxml.jackson.databind.deser.std.StdDeserializer; +import com.fasterxml.jackson.databind.ser.std.StdSerializer; +import factset.analyticsapi.engines.JSON; + +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +@JsonDeserialize(using = OneOfQuantUniverse.OneOfQuantUniverseDeserializer.class) +@JsonSerialize(using = OneOfQuantUniverse.OneOfQuantUniverseSerializer.class) +public class OneOfQuantUniverse extends AbstractOpenApiSchema, Serializable { + private static final Logger log = Logger.getLogger(OneOfQuantUniverse.class.getName()); + + public static class OneOfQuantUniverseSerializer extends StdSerializer { + public OneOfQuantUniverseSerializer(Class t) { + super(t); + } + + public OneOfQuantUniverseSerializer() { + this(null); + } + + @Override + public void serialize(OneOfQuantUniverse value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonProcessingException { + jgen.writeObject(value.getActualInstance()); + } + } + + public static class OneOfQuantUniverseDeserializer extends StdDeserializer { + public OneOfQuantUniverseDeserializer() { + this(OneOfQuantUniverse.class); + } + + public OneOfQuantUniverseDeserializer(Class vc) { + super(vc); + } + + @Override + public OneOfQuantUniverse deserialize(JsonParser jp, DeserializationContext ctxt) throws IOException, JsonProcessingException { + JsonNode tree = jp.readValueAsTree(); + Object deserialized = null; + OneOfQuantUniverse newOneOfQuantUniverse = new OneOfQuantUniverse(); + Map result2 = tree.traverse(jp.getCodec()).readValueAs(new TypeReference>() {}); + String discriminatorValue = (String)result2.get("source"); + switch (discriminatorValue) { + case "IdentifierUniverse": + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantIdentifierUniverse.class); + newOneOfQuantUniverse.setActualInstance(deserialized); + return newOneOfQuantUniverse; + case "QuantIdentifierUniverse": + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantIdentifierUniverse.class); + newOneOfQuantUniverse.setActualInstance(deserialized); + return newOneOfQuantUniverse; + case "QuantScreeningExpressionUniverse": + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantScreeningExpressionUniverse.class); + newOneOfQuantUniverse.setActualInstance(deserialized); + return newOneOfQuantUniverse; + case "QuantUniversalScreenUniverse": + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantUniversalScreenUniverse.class); + newOneOfQuantUniverse.setActualInstance(deserialized); + return newOneOfQuantUniverse; + case "ScreeningExpressionUniverse": + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantScreeningExpressionUniverse.class); + newOneOfQuantUniverse.setActualInstance(deserialized); + return newOneOfQuantUniverse; + case "UniversalScreenUniverse": + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantUniversalScreenUniverse.class); + newOneOfQuantUniverse.setActualInstance(deserialized); + return newOneOfQuantUniverse; + default: + log.log(Level.WARNING, String.format("Failed to lookup discriminator value `%s` for OneOfQuantUniverse. Possible values: IdentifierUniverse QuantIdentifierUniverse QuantScreeningExpressionUniverse QuantUniversalScreenUniverse ScreeningExpressionUniverse UniversalScreenUniverse", discriminatorValue)); + } + + boolean typeCoercion = ctxt.isEnabled(MapperFeature.ALLOW_COERCION_OF_SCALARS); + int match = 0; + JsonToken token = tree.traverse(jp.getCodec()).nextToken(); + // deserialize QuantIdentifierUniverse + try { + boolean attemptParsing = true; + // ensure that we respect type coercion as set on the client ObjectMapper + if (QuantIdentifierUniverse.class.equals(Integer.class) || QuantIdentifierUniverse.class.equals(Long.class) || QuantIdentifierUniverse.class.equals(Float.class) || QuantIdentifierUniverse.class.equals(Double.class) || QuantIdentifierUniverse.class.equals(Boolean.class) || QuantIdentifierUniverse.class.equals(String.class)) { + attemptParsing = typeCoercion; + if (!attemptParsing) { + attemptParsing |= ((QuantIdentifierUniverse.class.equals(Integer.class) || QuantIdentifierUniverse.class.equals(Long.class)) && token == JsonToken.VALUE_NUMBER_INT); + attemptParsing |= ((QuantIdentifierUniverse.class.equals(Float.class) || QuantIdentifierUniverse.class.equals(Double.class)) && token == JsonToken.VALUE_NUMBER_FLOAT); + attemptParsing |= (QuantIdentifierUniverse.class.equals(Boolean.class) && (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE)); + attemptParsing |= (QuantIdentifierUniverse.class.equals(String.class) && token == JsonToken.VALUE_STRING); + } + } + if (attemptParsing) { + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantIdentifierUniverse.class); + // TODO: there is no validation against JSON schema constraints + // (min, max, enum, pattern...), this does not perform a strict JSON + // validation, which means the 'match' count may be higher than it should be. + match++; + log.log(Level.FINER, "Input data matches schema 'QuantIdentifierUniverse'"); + } + } catch (Exception e) { + // deserialization failed, continue + log.log(Level.FINER, "Input data does not match schema 'QuantIdentifierUniverse'", e); + } + + // deserialize QuantScreeningExpressionUniverse + try { + boolean attemptParsing = true; + // ensure that we respect type coercion as set on the client ObjectMapper + if (QuantScreeningExpressionUniverse.class.equals(Integer.class) || QuantScreeningExpressionUniverse.class.equals(Long.class) || QuantScreeningExpressionUniverse.class.equals(Float.class) || QuantScreeningExpressionUniverse.class.equals(Double.class) || QuantScreeningExpressionUniverse.class.equals(Boolean.class) || QuantScreeningExpressionUniverse.class.equals(String.class)) { + attemptParsing = typeCoercion; + if (!attemptParsing) { + attemptParsing |= ((QuantScreeningExpressionUniverse.class.equals(Integer.class) || QuantScreeningExpressionUniverse.class.equals(Long.class)) && token == JsonToken.VALUE_NUMBER_INT); + attemptParsing |= ((QuantScreeningExpressionUniverse.class.equals(Float.class) || QuantScreeningExpressionUniverse.class.equals(Double.class)) && token == JsonToken.VALUE_NUMBER_FLOAT); + attemptParsing |= (QuantScreeningExpressionUniverse.class.equals(Boolean.class) && (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE)); + attemptParsing |= (QuantScreeningExpressionUniverse.class.equals(String.class) && token == JsonToken.VALUE_STRING); + } + } + if (attemptParsing) { + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantScreeningExpressionUniverse.class); + // TODO: there is no validation against JSON schema constraints + // (min, max, enum, pattern...), this does not perform a strict JSON + // validation, which means the 'match' count may be higher than it should be. + match++; + log.log(Level.FINER, "Input data matches schema 'QuantScreeningExpressionUniverse'"); + } + } catch (Exception e) { + // deserialization failed, continue + log.log(Level.FINER, "Input data does not match schema 'QuantScreeningExpressionUniverse'", e); + } + + // deserialize QuantUniversalScreenUniverse + try { + boolean attemptParsing = true; + // ensure that we respect type coercion as set on the client ObjectMapper + if (QuantUniversalScreenUniverse.class.equals(Integer.class) || QuantUniversalScreenUniverse.class.equals(Long.class) || QuantUniversalScreenUniverse.class.equals(Float.class) || QuantUniversalScreenUniverse.class.equals(Double.class) || QuantUniversalScreenUniverse.class.equals(Boolean.class) || QuantUniversalScreenUniverse.class.equals(String.class)) { + attemptParsing = typeCoercion; + if (!attemptParsing) { + attemptParsing |= ((QuantUniversalScreenUniverse.class.equals(Integer.class) || QuantUniversalScreenUniverse.class.equals(Long.class)) && token == JsonToken.VALUE_NUMBER_INT); + attemptParsing |= ((QuantUniversalScreenUniverse.class.equals(Float.class) || QuantUniversalScreenUniverse.class.equals(Double.class)) && token == JsonToken.VALUE_NUMBER_FLOAT); + attemptParsing |= (QuantUniversalScreenUniverse.class.equals(Boolean.class) && (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE)); + attemptParsing |= (QuantUniversalScreenUniverse.class.equals(String.class) && token == JsonToken.VALUE_STRING); + } + } + if (attemptParsing) { + deserialized = tree.traverse(jp.getCodec()).readValueAs(QuantUniversalScreenUniverse.class); + // TODO: there is no validation against JSON schema constraints + // (min, max, enum, pattern...), this does not perform a strict JSON + // validation, which means the 'match' count may be higher than it should be. + match++; + log.log(Level.FINER, "Input data matches schema 'QuantUniversalScreenUniverse'"); + } + } catch (Exception e) { + // deserialization failed, continue + log.log(Level.FINER, "Input data does not match schema 'QuantUniversalScreenUniverse'", e); + } + + if (match == 1) { + OneOfQuantUniverse ret = new OneOfQuantUniverse(); + ret.setActualInstance(deserialized); + return ret; + } + throw new IOException(String.format("Failed deserialization for OneOfQuantUniverse: %d classes match result, expected 1", match)); + } + + /** + * Handle deserialization of the 'null' value. + */ + @Override + public OneOfQuantUniverse getNullValue(DeserializationContext ctxt) throws JsonMappingException { + throw new JsonMappingException(ctxt.getParser(), "OneOfQuantUniverse cannot be null"); + } + } + + // store a list of schema names defined in oneOf + public static final Map schemas = new HashMap(); + + public OneOfQuantUniverse() { + super("oneOf", Boolean.FALSE); + } + /** + * A container for additional, undeclared properties. + * This is a holder for any undeclared properties as specified with + * the 'additionalProperties' keyword in the OAS document. + */ + private Map additionalProperties; + + /** + * Set the additional (undeclared) property with the specified name and value. + * If the property does not already exist, create it otherwise replace it. + */ + @JsonAnySetter + public OneOfQuantUniverse putAdditionalProperty(String key, Object value) { + if (this.additionalProperties == null) { + this.additionalProperties = new HashMap(); + } + this.additionalProperties.put(key, value); + return this; + } + + /** + * Return the additional (undeclared) property. + */ + @JsonAnyGetter + public Map getAdditionalProperties() { + return additionalProperties; + } + + /** + * Return the additional (undeclared) property with the specified name. + */ + public Object getAdditionalProperty(String key) { + if (this.additionalProperties == null) { + return null; + } + return this.additionalProperties.get(key); + } + + /** + * Return true if this OneOfQuantUniverse object is equal to o. + */ + @Override + public boolean equals(Object o) { + return super.equals(o) && Objects.equals(this.additionalProperties, ((OneOfQuantUniverse)o).additionalProperties); + } + + @Override + public int hashCode() { + return Objects.hash(getActualInstance(), isNullable(), getSchemaType(), additionalProperties); + } + public OneOfQuantUniverse(QuantIdentifierUniverse o) { + super("oneOf", Boolean.FALSE); + setActualInstance(o); + } + + public OneOfQuantUniverse(QuantScreeningExpressionUniverse o) { + super("oneOf", Boolean.FALSE); + setActualInstance(o); + } + + public OneOfQuantUniverse(QuantUniversalScreenUniverse o) { + super("oneOf", Boolean.FALSE); + setActualInstance(o); + } + + static { + schemas.put("QuantIdentifierUniverse", new GenericType() { + }); + schemas.put("QuantScreeningExpressionUniverse", new GenericType() { + }); + schemas.put("QuantUniversalScreenUniverse", new GenericType() { + }); + JSON.registerDescendants(OneOfQuantUniverse.class, Collections.unmodifiableMap(schemas)); + // Initialize and register the discriminator mappings. + Map> mappings = new HashMap>(); + mappings.put("IdentifierUniverse", QuantIdentifierUniverse.class); + mappings.put("QuantIdentifierUniverse", QuantIdentifierUniverse.class); + mappings.put("QuantScreeningExpressionUniverse", QuantScreeningExpressionUniverse.class); + mappings.put("QuantUniversalScreenUniverse", QuantUniversalScreenUniverse.class); + mappings.put("ScreeningExpressionUniverse", QuantScreeningExpressionUniverse.class); + mappings.put("UniversalScreenUniverse", QuantUniversalScreenUniverse.class); + mappings.put("OneOfQuantUniverse", OneOfQuantUniverse.class); + JSON.registerDiscriminator(OneOfQuantUniverse.class, "source", mappings); + } + + @Override + public Map getSchemas() { + return OneOfQuantUniverse.schemas; + } + + /** + * Set the instance that matches the oneOf child schema, check + * the instance parameter is valid against the oneOf child schemas: + * QuantIdentifierUniverse, QuantScreeningExpressionUniverse, QuantUniversalScreenUniverse + * + * It could be an instance of the 'oneOf' schemas. + * The oneOf child schemas may themselves be a composed schema (allOf, anyOf, oneOf). + */ + @Override + public void setActualInstance(Object instance) { + if (JSON.isInstanceOf(QuantIdentifierUniverse.class, instance, new HashSet>())) { + super.setActualInstance(instance); + return; + } + + if (JSON.isInstanceOf(QuantScreeningExpressionUniverse.class, instance, new HashSet>())) { + super.setActualInstance(instance); + return; + } + + if (JSON.isInstanceOf(QuantUniversalScreenUniverse.class, instance, new HashSet>())) { + super.setActualInstance(instance); + return; + } + + throw new RuntimeException("Invalid instance type. Must be QuantIdentifierUniverse, QuantScreeningExpressionUniverse, QuantUniversalScreenUniverse"); + } + + /** + * Get the actual instance, which can be the following: + * QuantIdentifierUniverse, QuantScreeningExpressionUniverse, QuantUniversalScreenUniverse + * + * @return The actual instance (QuantIdentifierUniverse, QuantScreeningExpressionUniverse, QuantUniversalScreenUniverse) + */ + @Override + public Object getActualInstance() { + return super.getActualInstance(); + } + + /** + * Get the actual instance of `QuantIdentifierUniverse`. If the actual instance is not `QuantIdentifierUniverse`, + * the ClassCastException will be thrown. + * + * @return The actual instance of `QuantIdentifierUniverse` + * @throws ClassCastException if the instance is not `QuantIdentifierUniverse` + */ + public QuantIdentifierUniverse getQuantIdentifierUniverse() throws ClassCastException { + return (QuantIdentifierUniverse)super.getActualInstance(); + } + + /** + * Get the actual instance of `QuantScreeningExpressionUniverse`. If the actual instance is not `QuantScreeningExpressionUniverse`, + * the ClassCastException will be thrown. + * + * @return The actual instance of `QuantScreeningExpressionUniverse` + * @throws ClassCastException if the instance is not `QuantScreeningExpressionUniverse` + */ + public QuantScreeningExpressionUniverse getQuantScreeningExpressionUniverse() throws ClassCastException { + return (QuantScreeningExpressionUniverse)super.getActualInstance(); + } + + /** + * Get the actual instance of `QuantUniversalScreenUniverse`. If the actual instance is not `QuantUniversalScreenUniverse`, + * the ClassCastException will be thrown. + * + * @return The actual instance of `QuantUniversalScreenUniverse` + * @throws ClassCastException if the instance is not `QuantUniversalScreenUniverse` + */ + public QuantUniversalScreenUniverse getQuantUniversalScreenUniverse() throws ClassCastException { + return (QuantUniversalScreenUniverse)super.getActualInstance(); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimalPortfolio.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimalPortfolio.java index 6f2eea49..6df19647 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimalPortfolio.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimalPortfolio.java @@ -132,6 +132,8 @@ public static IfOfdbDateExistsEnum fromValue(String value) { public static final String JSON_PROPERTY_IF_OFDB_DATE_EXISTS = "ifOfdbDateExists"; private IfOfdbDateExistsEnum ifOfdbDateExists; + public OptimalPortfolio() { + } public OptimalPortfolio acctName(String acctName) { this.acctName = acctName; @@ -152,6 +154,8 @@ public String getAcctName() { } + @JsonProperty(JSON_PROPERTY_ACCT_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcctName(String acctName) { this.acctName = acctName; } @@ -176,6 +180,8 @@ public Boolean getExcludeZero() { } + @JsonProperty(JSON_PROPERTY_EXCLUDE_ZERO) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExcludeZero(Boolean excludeZero) { this.excludeZero = excludeZero; } @@ -200,6 +206,8 @@ public String getArchiveDate() { } + @JsonProperty(JSON_PROPERTY_ARCHIVE_DATE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setArchiveDate(String archiveDate) { this.archiveDate = archiveDate; } @@ -224,6 +232,8 @@ public IfAcctExistsEnum getIfAcctExists() { } + @JsonProperty(JSON_PROPERTY_IF_ACCT_EXISTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIfAcctExists(IfAcctExistsEnum ifAcctExists) { this.ifAcctExists = ifAcctExists; } @@ -248,6 +258,8 @@ public IfOfdbDateExistsEnum getIfOfdbDateExists() { } + @JsonProperty(JSON_PROPERTY_IF_OFDB_DATE_EXISTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIfOfdbDateExists(IfOfdbDateExistsEnum ifOfdbDateExists) { this.ifOfdbDateExists = ifOfdbDateExists; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Optimization.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Optimization.java index 5d7c5d75..40b4c3bc 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Optimization.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/Optimization.java @@ -50,6 +50,8 @@ public class Optimization implements Serializable { public static final String JSON_PROPERTY_CASHFLOW = "cashflow"; private String cashflow; + public Optimization() { + } public Optimization riskModelDate(String riskModelDate) { this.riskModelDate = riskModelDate; @@ -70,6 +72,8 @@ public String getRiskModelDate() { } + @JsonProperty(JSON_PROPERTY_RISK_MODEL_DATE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskModelDate(String riskModelDate) { this.riskModelDate = riskModelDate; } @@ -94,6 +98,8 @@ public String getBacktestDate() { } + @JsonProperty(JSON_PROPERTY_BACKTEST_DATE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBacktestDate(String backtestDate) { this.backtestDate = backtestDate; } @@ -118,6 +124,8 @@ public String getCashflow() { } + @JsonProperty(JSON_PROPERTY_CASHFLOW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCashflow(String cashflow) { this.cashflow = cashflow; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerAccount.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerAccount.java index 8c5321ef..2fecbe87 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerAccount.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerAccount.java @@ -47,6 +47,8 @@ public class OptimizerAccount implements Serializable { public static final String JSON_PROPERTY_OVERRIDES = "overrides"; private OptimizerAccountOverrides overrides; + public OptimizerAccount() { + } public OptimizerAccount id(String id) { this.id = id; @@ -67,6 +69,8 @@ public String getId() { } + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { this.id = id; } @@ -91,6 +95,8 @@ public OptimizerAccountOverrides getOverrides() { } + @JsonProperty(JSON_PROPERTY_OVERRIDES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOverrides(OptimizerAccountOverrides overrides) { this.overrides = overrides; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerAccountOverrides.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerAccountOverrides.java index de58b11c..22e115a7 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerAccountOverrides.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerAccountOverrides.java @@ -54,6 +54,8 @@ public class OptimizerAccountOverrides implements Serializable { public static final String JSON_PROPERTY_CURRENCY = "currency"; private String currency; + public OptimizerAccountOverrides() { + } public OptimizerAccountOverrides portfolio(String portfolio) { this.portfolio = portfolio; @@ -74,6 +76,8 @@ public String getPortfolio() { } + @JsonProperty(JSON_PROPERTY_PORTFOLIO) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPortfolio(String portfolio) { this.portfolio = portfolio; } @@ -98,6 +102,8 @@ public String getBenchmark() { } + @JsonProperty(JSON_PROPERTY_BENCHMARK) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBenchmark(String benchmark) { this.benchmark = benchmark; } @@ -122,6 +128,8 @@ public String getRiskModelId() { } + @JsonProperty(JSON_PROPERTY_RISK_MODEL_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskModelId(String riskModelId) { this.riskModelId = riskModelId; } @@ -146,6 +154,8 @@ public String getCurrency() { } + @JsonProperty(JSON_PROPERTY_CURRENCY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { this.currency = currency; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerOptimalHoldings.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerOptimalHoldings.java index b3e8c4fa..efa60051 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerOptimalHoldings.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerOptimalHoldings.java @@ -101,6 +101,8 @@ public static IdentifierTypeEnum fromValue(String value) { public static final String JSON_PROPERTY_EXCLUDE_ZERO = "excludeZero"; private Boolean excludeZero; + public OptimizerOptimalHoldings() { + } public OptimizerOptimalHoldings identifierType(IdentifierTypeEnum identifierType) { this.identifierType = identifierType; @@ -121,6 +123,8 @@ public IdentifierTypeEnum getIdentifierType() { } + @JsonProperty(JSON_PROPERTY_IDENTIFIER_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIdentifierType(IdentifierTypeEnum identifierType) { this.identifierType = identifierType; } @@ -145,6 +149,8 @@ public Boolean getIncludeCash() { } + @JsonProperty(JSON_PROPERTY_INCLUDE_CASH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIncludeCash(Boolean includeCash) { this.includeCash = includeCash; } @@ -169,6 +175,8 @@ public Boolean getExcludeZero() { } + @JsonProperty(JSON_PROPERTY_EXCLUDE_ZERO) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExcludeZero(Boolean excludeZero) { this.excludeZero = excludeZero; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerOutputTypes.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerOutputTypes.java index f92ace11..1fc84696 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerOutputTypes.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerOutputTypes.java @@ -57,6 +57,8 @@ public class OptimizerOutputTypes implements Serializable { public static final String JSON_PROPERTY_STATS = "stats"; private Object stats; + public OptimizerOutputTypes() { + } public OptimizerOutputTypes trades(OptimizerTradesList trades) { this.trades = trades; @@ -77,6 +79,8 @@ public OptimizerTradesList getTrades() { } + @JsonProperty(JSON_PROPERTY_TRADES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTrades(OptimizerTradesList trades) { this.trades = trades; } @@ -101,6 +105,8 @@ public OptimizerOptimalHoldings getOptimal() { } + @JsonProperty(JSON_PROPERTY_OPTIMAL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOptimal(OptimizerOptimalHoldings optimal) { this.optimal = optimal; } @@ -125,6 +131,8 @@ public OptimalPortfolio getAccount() { } + @JsonProperty(JSON_PROPERTY_ACCOUNT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccount(OptimalPortfolio account) { this.account = account; } @@ -149,6 +157,8 @@ public Object getStats() { } + @JsonProperty(JSON_PROPERTY_STATS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStats(Object stats) { this.stats = stats; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerTradesList.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerTradesList.java index 5807a76f..32f6d4f1 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerTradesList.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/OptimizerTradesList.java @@ -97,6 +97,8 @@ public static IdentifierTypeEnum fromValue(String value) { public static final String JSON_PROPERTY_INCLUDE_CASH = "includeCash"; private Boolean includeCash; + public OptimizerTradesList() { + } public OptimizerTradesList identifierType(IdentifierTypeEnum identifierType) { this.identifierType = identifierType; @@ -117,6 +119,8 @@ public IdentifierTypeEnum getIdentifierType() { } + @JsonProperty(JSON_PROPERTY_IDENTIFIER_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIdentifierType(IdentifierTypeEnum identifierType) { this.identifierType = identifierType; } @@ -141,6 +145,8 @@ public Boolean getIncludeCash() { } + @JsonProperty(JSON_PROPERTY_INCLUDE_CASH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIncludeCash(Boolean includeCash) { this.includeCash = includeCash; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationColumn.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationColumn.java index 890cadf5..59169179 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationColumn.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationColumn.java @@ -46,6 +46,8 @@ public class PACalculationColumn implements Serializable { public static final String JSON_PROPERTY_STATISTICS = "statistics"; private java.util.List statistics = null; + public PACalculationColumn() { + } public PACalculationColumn id(String id) { this.id = id; @@ -66,6 +68,8 @@ public String getId() { } + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { this.id = id; } @@ -98,6 +102,8 @@ public java.util.List getStatistics() { } + @JsonProperty(JSON_PROPERTY_STATISTICS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatistics(java.util.List statistics) { this.statistics = statistics; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationGroup.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationGroup.java index 675abae2..09b7da92 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationGroup.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationGroup.java @@ -42,6 +42,8 @@ public class PACalculationGroup implements Serializable { public static final String JSON_PROPERTY_ID = "id"; private String id; + public PACalculationGroup() { + } public PACalculationGroup id(String id) { this.id = id; @@ -62,6 +64,8 @@ public String getId() { } + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { this.id = id; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParameters.java index b79f4faf..ecec0502 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParameters.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParameters.java @@ -74,6 +74,8 @@ public class PACalculationParameters implements Serializable { public static final String JSON_PROPERTY_COMPONENTDETAIL = "componentdetail"; private String componentdetail; + public PACalculationParameters() { + } public PACalculationParameters componentid(String componentid) { this.componentid = componentid; @@ -84,6 +86,7 @@ public PACalculationParameters componentid(String componentid) { * The PA Engine component identifier to analyze. * @return componentid **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "The PA Engine component identifier to analyze.") @JsonProperty(JSON_PROPERTY_COMPONENTID) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -93,6 +96,8 @@ public String getComponentid() { } + @JsonProperty(JSON_PROPERTY_COMPONENTID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setComponentid(String componentid) { this.componentid = componentid; } @@ -125,6 +130,8 @@ public java.util.List getAccounts() { } + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccounts(java.util.List accounts) { this.accounts = accounts; } @@ -157,6 +164,8 @@ public java.util.List getBenchmarks() { } + @JsonProperty(JSON_PROPERTY_BENCHMARKS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBenchmarks(java.util.List benchmarks) { this.benchmarks = benchmarks; } @@ -181,6 +190,8 @@ public PADateParameters getDates() { } + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDates(PADateParameters dates) { this.dates = dates; } @@ -213,6 +224,8 @@ public java.util.List getGroups() { } + @JsonProperty(JSON_PROPERTY_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGroups(java.util.List groups) { this.groups = groups; } @@ -237,6 +250,8 @@ public String getCurrencyisocode() { } + @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrencyisocode(String currencyisocode) { this.currencyisocode = currencyisocode; } @@ -269,6 +284,8 @@ public java.util.List getColumns() { } + @JsonProperty(JSON_PROPERTY_COLUMNS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setColumns(java.util.List columns) { this.columns = columns; } @@ -280,11 +297,11 @@ public PACalculationParameters componentdetail(String componentdetail) { } /** - * Component detail type for the PA component. It can be GROUPS or TOTALS. + * Component detail type for the PA component. It can be GROUPS or TOTALS or SECURITIES. * @return componentdetail **/ @javax.annotation.Nullable - @ApiModelProperty(value = "Component detail type for the PA component. It can be GROUPS or TOTALS.") + @ApiModelProperty(value = "Component detail type for the PA component. It can be GROUPS or TOTALS or SECURITIES.") @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -293,6 +310,8 @@ public String getComponentdetail() { } + @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setComponentdetail(String componentdetail) { this.componentdetail = componentdetail; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParametersRoot.java index 97650143..71374d92 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParametersRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PACalculationParametersRoot.java @@ -48,6 +48,8 @@ public class PACalculationParametersRoot implements Serializable { public static final String JSON_PROPERTY_META = "meta"; private CalculationMeta meta; + public PACalculationParametersRoot() { + } public PACalculationParametersRoot data(java.util.Map data) { this.data = data; @@ -76,6 +78,8 @@ public java.util.Map getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(java.util.Map data) { this.data = data; } @@ -100,6 +104,8 @@ public CalculationMeta getMeta() { } + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMeta(CalculationMeta meta) { this.meta = meta; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponent.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponent.java index 12c03e4f..a10c70de 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponent.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponent.java @@ -41,6 +41,7 @@ PAComponent.JSON_PROPERTY_CURRENCYISOCODE, PAComponent.JSON_PROPERTY_DATES, PAComponent.JSON_PROPERTY_SNAPSHOT, + PAComponent.JSON_PROPERTY_PATH, PAComponent.JSON_PROPERTY_NAME, PAComponent.JSON_PROPERTY_CATEGORY }) @@ -66,12 +67,17 @@ public class PAComponent implements Serializable { public static final String JSON_PROPERTY_SNAPSHOT = "snapshot"; private Boolean snapshot; + public static final String JSON_PROPERTY_PATH = "path"; + private String path; + public static final String JSON_PROPERTY_NAME = "name"; private String name; public static final String JSON_PROPERTY_CATEGORY = "category"; private String category; + public PAComponent() { + } public PAComponent id(String id) { this.id = id; @@ -92,6 +98,8 @@ public String getId() { } + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { this.id = id; } @@ -124,6 +132,8 @@ public java.util.List getAccounts() { } + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccounts(java.util.List accounts) { this.accounts = accounts; } @@ -156,6 +166,8 @@ public java.util.List getBenchmarks() { } + @JsonProperty(JSON_PROPERTY_BENCHMARKS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBenchmarks(java.util.List benchmarks) { this.benchmarks = benchmarks; } @@ -180,6 +192,8 @@ public String getCurrencyisocode() { } + @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrencyisocode(String currencyisocode) { this.currencyisocode = currencyisocode; } @@ -204,6 +218,8 @@ public PADateParameters getDates() { } + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDates(PADateParameters dates) { this.dates = dates; } @@ -228,11 +244,39 @@ public Boolean getSnapshot() { } + @JsonProperty(JSON_PROPERTY_SNAPSHOT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSnapshot(Boolean snapshot) { this.snapshot = snapshot; } + public PAComponent path(String path) { + this.path = path; + return this; + } + + /** + * The path to the document + * @return path + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The path to the document") + @JsonProperty(JSON_PROPERTY_PATH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getPath() { + return path; + } + + + @JsonProperty(JSON_PROPERTY_PATH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setPath(String path) { + this.path = path; + } + + public PAComponent name(String name) { this.name = name; return this; @@ -252,6 +296,8 @@ public String getName() { } + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } @@ -276,6 +322,8 @@ public String getCategory() { } + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCategory(String category) { this.category = category; } @@ -299,13 +347,14 @@ public boolean equals(Object o) { Objects.equals(this.currencyisocode, paComponent.currencyisocode) && Objects.equals(this.dates, paComponent.dates) && Objects.equals(this.snapshot, paComponent.snapshot) && + Objects.equals(this.path, paComponent.path) && Objects.equals(this.name, paComponent.name) && Objects.equals(this.category, paComponent.category); } @Override public int hashCode() { - return Objects.hash(id, accounts, benchmarks, currencyisocode, dates, snapshot, name, category); + return Objects.hash(id, accounts, benchmarks, currencyisocode, dates, snapshot, path, name, category); } @Override @@ -318,6 +367,7 @@ public String toString() { sb.append(" currencyisocode: ").append(toIndentedString(currencyisocode)).append("\n"); sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); sb.append(" snapshot: ").append(toIndentedString(snapshot)).append("\n"); + sb.append(" path: ").append(toIndentedString(path)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" category: ").append(toIndentedString(category)).append("\n"); sb.append("}"); diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentData.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentData.java new file mode 100644 index 00000000..3305f80e --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentData.java @@ -0,0 +1,343 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PACalculationColumn; +import factset.analyticsapi.engines.models.PACalculationGroup; +import factset.analyticsapi.engines.models.PADateParameters; +import factset.analyticsapi.engines.models.PAIdentifier; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * PAComponentData + */ +@JsonPropertyOrder({ + PAComponentData.JSON_PROPERTY_ACCOUNTS, + PAComponentData.JSON_PROPERTY_BENCHMARKS, + PAComponentData.JSON_PROPERTY_GROUPS, + PAComponentData.JSON_PROPERTY_COLUMNS, + PAComponentData.JSON_PROPERTY_DATES, + PAComponentData.JSON_PROPERTY_CURRENCYISOCODE, + PAComponentData.JSON_PROPERTY_COMPONENTDETAIL +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class PAComponentData implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; + private java.util.List accounts = null; + + public static final String JSON_PROPERTY_BENCHMARKS = "benchmarks"; + private java.util.List benchmarks = null; + + public static final String JSON_PROPERTY_GROUPS = "groups"; + private java.util.List groups = null; + + public static final String JSON_PROPERTY_COLUMNS = "columns"; + private java.util.List columns = null; + + public static final String JSON_PROPERTY_DATES = "dates"; + private PADateParameters dates; + + public static final String JSON_PROPERTY_CURRENCYISOCODE = "currencyisocode"; + private String currencyisocode; + + public static final String JSON_PROPERTY_COMPONENTDETAIL = "componentdetail"; + private String componentdetail; + + public PAComponentData() { + } + + public PAComponentData accounts(java.util.List accounts) { + this.accounts = accounts; + return this; + } + + public PAComponentData addAccountsItem(PAIdentifier accountsItem) { + if (this.accounts == null) { + this.accounts = new java.util.ArrayList(); + } + this.accounts.add(accountsItem); + return this; + } + + /** + * List of accounts. + * @return accounts + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of accounts.") + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getAccounts() { + return accounts; + } + + + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAccounts(java.util.List accounts) { + this.accounts = accounts; + } + + + public PAComponentData benchmarks(java.util.List benchmarks) { + this.benchmarks = benchmarks; + return this; + } + + public PAComponentData addBenchmarksItem(PAIdentifier benchmarksItem) { + if (this.benchmarks == null) { + this.benchmarks = new java.util.ArrayList(); + } + this.benchmarks.add(benchmarksItem); + return this; + } + + /** + * List of benchmarks. + * @return benchmarks + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of benchmarks.") + @JsonProperty(JSON_PROPERTY_BENCHMARKS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getBenchmarks() { + return benchmarks; + } + + + @JsonProperty(JSON_PROPERTY_BENCHMARKS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setBenchmarks(java.util.List benchmarks) { + this.benchmarks = benchmarks; + } + + + public PAComponentData groups(java.util.List groups) { + this.groups = groups; + return this; + } + + public PAComponentData addGroupsItem(PACalculationGroup groupsItem) { + if (this.groups == null) { + this.groups = new java.util.ArrayList(); + } + this.groups.add(groupsItem); + return this; + } + + /** + * List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document. + * @return groups + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document.") + @JsonProperty(JSON_PROPERTY_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getGroups() { + return groups; + } + + + @JsonProperty(JSON_PROPERTY_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroups(java.util.List groups) { + this.groups = groups; + } + + + public PAComponentData columns(java.util.List columns) { + this.columns = columns; + return this; + } + + public PAComponentData addColumnsItem(PACalculationColumn columnsItem) { + if (this.columns == null) { + this.columns = new java.util.ArrayList(); + } + this.columns.add(columnsItem); + return this; + } + + /** + * List of columns for the PA calculation. This will take precedence over the columns saved in the PA document. + * @return columns + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of columns for the PA calculation. This will take precedence over the columns saved in the PA document.") + @JsonProperty(JSON_PROPERTY_COLUMNS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getColumns() { + return columns; + } + + + @JsonProperty(JSON_PROPERTY_COLUMNS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setColumns(java.util.List columns) { + this.columns = columns; + } + + + public PAComponentData dates(PADateParameters dates) { + this.dates = dates; + return this; + } + + /** + * Get dates + * @return dates + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PADateParameters getDates() { + return dates; + } + + + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDates(PADateParameters dates) { + this.dates = dates; + } + + + public PAComponentData currencyisocode(String currencyisocode) { + this.currencyisocode = currencyisocode; + return this; + } + + /** + * Currency ISO code for calculation. + * @return currencyisocode + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Currency ISO code for calculation.") + @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCurrencyisocode() { + return currencyisocode; + } + + + @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCurrencyisocode(String currencyisocode) { + this.currencyisocode = currencyisocode; + } + + + public PAComponentData componentdetail(String componentdetail) { + this.componentdetail = componentdetail; + return this; + } + + /** + * PA Storage type. It can be GROUPS or TOTALS or SECURITIES. + * @return componentdetail + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "PA Storage type. It can be GROUPS or TOTALS or SECURITIES.") + @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getComponentdetail() { + return componentdetail; + } + + + @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setComponentdetail(String componentdetail) { + this.componentdetail = componentdetail; + } + + + /** + * Return true if this PAComponentData object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PAComponentData paComponentData = (PAComponentData) o; + return Objects.equals(this.accounts, paComponentData.accounts) && + Objects.equals(this.benchmarks, paComponentData.benchmarks) && + Objects.equals(this.groups, paComponentData.groups) && + Objects.equals(this.columns, paComponentData.columns) && + Objects.equals(this.dates, paComponentData.dates) && + Objects.equals(this.currencyisocode, paComponentData.currencyisocode) && + Objects.equals(this.componentdetail, paComponentData.componentdetail); + } + + @Override + public int hashCode() { + return Objects.hash(accounts, benchmarks, groups, columns, dates, currencyisocode, componentdetail); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PAComponentData {\n"); + sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); + sb.append(" benchmarks: ").append(toIndentedString(benchmarks)).append("\n"); + sb.append(" groups: ").append(toIndentedString(groups)).append("\n"); + sb.append(" columns: ").append(toIndentedString(columns)).append("\n"); + sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); + sb.append(" currencyisocode: ").append(toIndentedString(currencyisocode)).append("\n"); + sb.append(" componentdetail: ").append(toIndentedString(componentdetail)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentRoot.java index fbdaabcc..ee21702c 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAComponentRoot.java @@ -25,6 +25,10 @@ import factset.analyticsapi.engines.models.PAComponent; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; import java.io.Serializable; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import factset.analyticsapi.engines.JSON; @@ -45,8 +49,10 @@ public class PAComponentRoot implements Serializable { private PAComponent data; public static final String JSON_PROPERTY_META = "meta"; - private Object meta; + private JsonNullable meta = JsonNullable.of(null); + public PAComponentRoot() { + } public PAComponentRoot data(PAComponent data) { this.data = data; @@ -57,6 +63,7 @@ public PAComponentRoot data(PAComponent data) { * Get data * @return data **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -66,13 +73,15 @@ public PAComponent getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setData(PAComponent data) { this.data = data; } public PAComponentRoot meta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); return this; } @@ -82,16 +91,26 @@ public PAComponentRoot meta(Object meta) { **/ @javax.annotation.Nullable @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + @JsonProperty(JSON_PROPERTY_META) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Object getMeta() { + public JsonNullable getMeta_JsonNullable() { return meta; } - + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } public void setMeta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); } @@ -108,12 +127,23 @@ public boolean equals(Object o) { } PAComponentRoot paComponentRoot = (PAComponentRoot) o; return Objects.equals(this.data, paComponentRoot.data) && - Objects.equals(this.meta, paComponentRoot.meta); + equalsNullable(this.meta, paComponentRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); } @Override public int hashCode() { - return Objects.hash(data, meta); + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; } @Override diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PADateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PADateParameters.java index 374d69eb..67d34bfa 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PADateParameters.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PADateParameters.java @@ -51,6 +51,8 @@ public class PADateParameters implements Serializable { public static final String JSON_PROPERTY_FREQUENCY = "frequency"; private String frequency; + public PADateParameters() { + } public PADateParameters startdate(String startdate) { this.startdate = startdate; @@ -71,6 +73,8 @@ public String getStartdate() { } + @JsonProperty(JSON_PROPERTY_STARTDATE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStartdate(String startdate) { this.startdate = startdate; } @@ -85,6 +89,7 @@ public PADateParameters enddate(String enddate) { * Calculation's end date. * @return enddate **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "Calculation's end date.") @JsonProperty(JSON_PROPERTY_ENDDATE) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -94,6 +99,8 @@ public String getEnddate() { } + @JsonProperty(JSON_PROPERTY_ENDDATE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setEnddate(String enddate) { this.enddate = enddate; } @@ -108,6 +115,7 @@ public PADateParameters frequency(String frequency) { * Calculation's frequency. * @return frequency **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "Calculation's frequency.") @JsonProperty(JSON_PROPERTY_FREQUENCY) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -117,6 +125,8 @@ public String getFrequency() { } + @JsonProperty(JSON_PROPERTY_FREQUENCY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFrequency(String frequency) { this.frequency = frequency; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAIdentifier.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAIdentifier.java index 15189d07..2ab6465e 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAIdentifier.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PAIdentifier.java @@ -46,6 +46,8 @@ public class PAIdentifier implements Serializable { public static final String JSON_PROPERTY_HOLDINGSMODE = "holdingsmode"; private String holdingsmode; + public PAIdentifier() { + } public PAIdentifier id(String id) { this.id = id; @@ -56,6 +58,7 @@ public PAIdentifier id(String id) { * User's FactSet account path OR benchmark. * @return id **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "User's FactSet account path OR benchmark.") @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -65,6 +68,8 @@ public String getId() { } + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setId(String id) { this.id = id; } @@ -89,6 +94,8 @@ public String getHoldingsmode() { } + @JsonProperty(JSON_PROPERTY_HOLDINGSMODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHoldingsmode(String holdingsmode) { this.holdingsmode = holdingsmode; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PaDoc.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PaDoc.java index f865ced3..12a31df2 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PaDoc.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PaDoc.java @@ -42,6 +42,8 @@ public class PaDoc implements Serializable { public static final String JSON_PROPERTY_ID = "id"; private String id; + public PaDoc() { + } public PaDoc id(String id) { this.id = id; @@ -52,6 +54,7 @@ public PaDoc id(String id) { * PA document path * @return id **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "PA document path") @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -61,6 +64,8 @@ public String getId() { } + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setId(String id) { this.id = id; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PubCalculationParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PubCalculationParameters.java index 11093c2c..0f966387 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PubCalculationParameters.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PubCalculationParameters.java @@ -52,6 +52,8 @@ public class PubCalculationParameters implements Serializable { public static final String JSON_PROPERTY_DATES = "dates"; private PubDateParameters dates; + public PubCalculationParameters() { + } public PubCalculationParameters document(String document) { this.document = document; @@ -62,6 +64,7 @@ public PubCalculationParameters document(String document) { * The Publisher Engine document to analyze. * @return document **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "The Publisher Engine document to analyze.") @JsonProperty(JSON_PROPERTY_DOCUMENT) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -71,6 +74,8 @@ public String getDocument() { } + @JsonProperty(JSON_PROPERTY_DOCUMENT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setDocument(String document) { this.document = document; } @@ -85,6 +90,7 @@ public PubCalculationParameters account(PubIdentifier account) { * Get account * @return account **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_ACCOUNT) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -94,6 +100,8 @@ public PubIdentifier getAccount() { } + @JsonProperty(JSON_PROPERTY_ACCOUNT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAccount(PubIdentifier account) { this.account = account; } @@ -108,6 +116,7 @@ public PubCalculationParameters dates(PubDateParameters dates) { * Get dates * @return dates **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_DATES) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -117,6 +126,8 @@ public PubDateParameters getDates() { } + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setDates(PubDateParameters dates) { this.dates = dates; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PubCalculationParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PubCalculationParametersRoot.java index ab7f1850..780389d1 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PubCalculationParametersRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PubCalculationParametersRoot.java @@ -47,6 +47,8 @@ public class PubCalculationParametersRoot implements Serializable { public static final String JSON_PROPERTY_META = "meta"; private Object meta; + public PubCalculationParametersRoot() { + } public PubCalculationParametersRoot data(java.util.Map data) { this.data = data; @@ -75,6 +77,8 @@ public java.util.Map getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(java.util.Map data) { this.data = data; } @@ -99,6 +103,8 @@ public Object getMeta() { } + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMeta(Object meta) { this.meta = meta; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PubDateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PubDateParameters.java index 4729c38c..3857f7f1 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PubDateParameters.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PubDateParameters.java @@ -47,6 +47,8 @@ public class PubDateParameters implements Serializable { public static final String JSON_PROPERTY_ENDDATE = "enddate"; private String enddate; + public PubDateParameters() { + } public PubDateParameters startdate(String startdate) { this.startdate = startdate; @@ -67,6 +69,8 @@ public String getStartdate() { } + @JsonProperty(JSON_PROPERTY_STARTDATE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStartdate(String startdate) { this.startdate = startdate; } @@ -81,6 +85,7 @@ public PubDateParameters enddate(String enddate) { * Calculation's end date or as of date. * @return enddate **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "Calculation's end date or as of date.") @JsonProperty(JSON_PROPERTY_ENDDATE) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -90,6 +95,8 @@ public String getEnddate() { } + @JsonProperty(JSON_PROPERTY_ENDDATE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setEnddate(String enddate) { this.enddate = enddate; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PubIdentifier.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PubIdentifier.java index d1c103a1..1a90e32a 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PubIdentifier.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/PubIdentifier.java @@ -46,6 +46,8 @@ public class PubIdentifier implements Serializable { public static final String JSON_PROPERTY_HOLDINGSMODE = "holdingsmode"; private String holdingsmode; + public PubIdentifier() { + } public PubIdentifier id(String id) { this.id = id; @@ -56,6 +58,7 @@ public PubIdentifier id(String id) { * User's FactSet account path OR benchmark. * @return id **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "User's FactSet account path OR benchmark.") @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -65,6 +68,8 @@ public String getId() { } + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setId(String id) { this.id = id; } @@ -89,6 +94,8 @@ public String getHoldingsmode() { } + @JsonProperty(JSON_PROPERTY_HOLDINGSMODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHoldingsmode(String holdingsmode) { this.holdingsmode = holdingsmode; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantAllUniversalScreenParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantAllUniversalScreenParameters.java new file mode 100644 index 00000000..f6f3d7fe --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantAllUniversalScreenParameters.java @@ -0,0 +1,155 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.QuantFormula; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * QuantAllUniversalScreenParameters + */ +@JsonPropertyOrder({ + QuantAllUniversalScreenParameters.JSON_PROPERTY_SOURCE +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class QuantAllUniversalScreenParameters implements Serializable { + private static final long serialVersionUID = 1L; + + /** + * Gets or Sets source + */ + public enum SourceEnum { + SCREENINGEXPRESSION("ScreeningExpression"), + + FQLEXPRESSION("FqlExpression"), + + UNIVERSALSCREENPARAMETER("UniversalScreenParameter"), + + ALLUNIVERSALSCREENPARAMETERS("AllUniversalScreenParameters"); + + private String value; + + SourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static SourceEnum fromValue(String value) { + for (SourceEnum b : SourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_SOURCE = "source"; + private SourceEnum source; + + public QuantAllUniversalScreenParameters() { + } + + public QuantAllUniversalScreenParameters source(SourceEnum source) { + this.source = source; + return this; + } + + /** + * Get source + * @return source + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public SourceEnum getSource() { + return source; + } + + + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSource(SourceEnum source) { + this.source = source; + } + + + /** + * Return true if this QuantAllUniversalScreenParameters object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + QuantAllUniversalScreenParameters quantAllUniversalScreenParameters = (QuantAllUniversalScreenParameters) o; + return Objects.equals(this.source, quantAllUniversalScreenParameters.source); + } + + @Override + public int hashCode() { + return Objects.hash(source); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class QuantAllUniversalScreenParameters {\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantCalculationMeta.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantCalculationMeta.java index f805308b..8832f1ac 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantCalculationMeta.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantCalculationMeta.java @@ -220,6 +220,8 @@ public static FormatEnum fromValue(String value) { public static final String JSON_PROPERTY_FORMAT = "format"; private FormatEnum format = FormatEnum.JSONSTACH; + public QuantCalculationMeta() { + } public QuantCalculationMeta allowArrayData(Boolean allowArrayData) { this.allowArrayData = allowArrayData; @@ -240,6 +242,8 @@ public Boolean getAllowArrayData() { } + @JsonProperty(JSON_PROPERTY_ALLOW_ARRAY_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowArrayData(Boolean allowArrayData) { this.allowArrayData = allowArrayData; } @@ -253,7 +257,9 @@ public QuantCalculationMeta contentorganization(ContentorganizationEnum contento /** * Get contentorganization * @return contentorganization + * @deprecated **/ + @Deprecated @javax.annotation.Nullable @ApiModelProperty(value = "") @JsonProperty(JSON_PROPERTY_CONTENTORGANIZATION) @@ -264,6 +270,8 @@ public ContentorganizationEnum getContentorganization() { } + @JsonProperty(JSON_PROPERTY_CONTENTORGANIZATION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContentorganization(ContentorganizationEnum contentorganization) { this.contentorganization = contentorganization; } @@ -288,6 +296,8 @@ public StachContentOrganizationEnum getStachContentOrganization() { } + @JsonProperty(JSON_PROPERTY_STACH_CONTENT_ORGANIZATION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStachContentOrganization(StachContentOrganizationEnum stachContentOrganization) { this.stachContentOrganization = stachContentOrganization; } @@ -301,7 +311,9 @@ public QuantCalculationMeta contenttype(ContenttypeEnum contenttype) { /** * Get contenttype * @return contenttype + * @deprecated **/ + @Deprecated @javax.annotation.Nullable @ApiModelProperty(value = "") @JsonProperty(JSON_PROPERTY_CONTENTTYPE) @@ -312,6 +324,8 @@ public ContenttypeEnum getContenttype() { } + @JsonProperty(JSON_PROPERTY_CONTENTTYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContenttype(ContenttypeEnum contenttype) { this.contenttype = contenttype; } @@ -336,6 +350,8 @@ public FormatEnum getFormat() { } + @JsonProperty(JSON_PROPERTY_FORMAT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFormat(FormatEnum format) { this.format = format; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantCalculationParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantCalculationParameters.java index 3238b92d..87d8b431 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantCalculationParameters.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantCalculationParameters.java @@ -22,14 +22,9 @@ import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonTypeName; import com.fasterxml.jackson.annotation.JsonValue; -import factset.analyticsapi.engines.models.QuantDateList; -import factset.analyticsapi.engines.models.QuantFdsDate; -import factset.analyticsapi.engines.models.QuantFqlExpression; -import factset.analyticsapi.engines.models.QuantIdentifierUniverse; -import factset.analyticsapi.engines.models.QuantScreeningExpression; -import factset.analyticsapi.engines.models.QuantScreeningExpressionUniverse; -import factset.analyticsapi.engines.models.QuantUniversalScreenParameter; -import factset.analyticsapi.engines.models.QuantUniversalScreenUniverse; +import factset.analyticsapi.engines.models.OneOfQuantDates; +import factset.analyticsapi.engines.models.OneOfQuantFormulasArray; +import factset.analyticsapi.engines.models.OneOfQuantUniverse; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.Serializable; @@ -41,293 +36,109 @@ * QuantCalculationParameters */ @JsonPropertyOrder({ - QuantCalculationParameters.JSON_PROPERTY_SCREENING_EXPRESSION_UNIVERSE, - QuantCalculationParameters.JSON_PROPERTY_UNIVERSAL_SCREEN_UNIVERSE, - QuantCalculationParameters.JSON_PROPERTY_IDENTIFIER_UNIVERSE, - QuantCalculationParameters.JSON_PROPERTY_FDS_DATE, - QuantCalculationParameters.JSON_PROPERTY_DATE_LIST, - QuantCalculationParameters.JSON_PROPERTY_SCREENING_EXPRESSION, - QuantCalculationParameters.JSON_PROPERTY_FQL_EXPRESSION, - QuantCalculationParameters.JSON_PROPERTY_UNIVERSAL_SCREEN_PARAMETER, - QuantCalculationParameters.JSON_PROPERTY_ALL_UNIVERSAL_SCREEN_PARAMETERS + QuantCalculationParameters.JSON_PROPERTY_UNIVERSE, + QuantCalculationParameters.JSON_PROPERTY_DATES, + QuantCalculationParameters.JSON_PROPERTY_FORMULAS }) @javax.annotation.Generated(value = "CustomJavaClientCodegen") public class QuantCalculationParameters implements Serializable { private static final long serialVersionUID = 1L; - public static final String JSON_PROPERTY_SCREENING_EXPRESSION_UNIVERSE = "screeningExpressionUniverse"; - private QuantScreeningExpressionUniverse screeningExpressionUniverse; + public static final String JSON_PROPERTY_UNIVERSE = "universe"; + private OneOfQuantUniverse universe; - public static final String JSON_PROPERTY_UNIVERSAL_SCREEN_UNIVERSE = "universalScreenUniverse"; - private QuantUniversalScreenUniverse universalScreenUniverse; + public static final String JSON_PROPERTY_DATES = "dates"; + private OneOfQuantDates dates; - public static final String JSON_PROPERTY_IDENTIFIER_UNIVERSE = "identifierUniverse"; - private QuantIdentifierUniverse identifierUniverse; + public static final String JSON_PROPERTY_FORMULAS = "formulas"; + private java.util.List formulas = null; - public static final String JSON_PROPERTY_FDS_DATE = "fdsDate"; - private QuantFdsDate fdsDate; - - public static final String JSON_PROPERTY_DATE_LIST = "dateList"; - private QuantDateList dateList; - - public static final String JSON_PROPERTY_SCREENING_EXPRESSION = "screeningExpression"; - private java.util.List screeningExpression = null; - - public static final String JSON_PROPERTY_FQL_EXPRESSION = "fqlExpression"; - private java.util.List fqlExpression = null; - - public static final String JSON_PROPERTY_UNIVERSAL_SCREEN_PARAMETER = "universalScreenParameter"; - private java.util.List universalScreenParameter = null; - - public static final String JSON_PROPERTY_ALL_UNIVERSAL_SCREEN_PARAMETERS = "allUniversalScreenParameters"; - private java.util.List allUniversalScreenParameters = null; - - - public QuantCalculationParameters screeningExpressionUniverse(QuantScreeningExpressionUniverse screeningExpressionUniverse) { - this.screeningExpressionUniverse = screeningExpressionUniverse; - return this; - } - - /** - * Get screeningExpressionUniverse - * @return screeningExpressionUniverse - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_SCREENING_EXPRESSION_UNIVERSE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public QuantScreeningExpressionUniverse getScreeningExpressionUniverse() { - return screeningExpressionUniverse; - } - - - public void setScreeningExpressionUniverse(QuantScreeningExpressionUniverse screeningExpressionUniverse) { - this.screeningExpressionUniverse = screeningExpressionUniverse; - } - - - public QuantCalculationParameters universalScreenUniverse(QuantUniversalScreenUniverse universalScreenUniverse) { - this.universalScreenUniverse = universalScreenUniverse; - return this; - } - - /** - * Get universalScreenUniverse - * @return universalScreenUniverse - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_UNIVERSAL_SCREEN_UNIVERSE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public QuantUniversalScreenUniverse getUniversalScreenUniverse() { - return universalScreenUniverse; - } - - - public void setUniversalScreenUniverse(QuantUniversalScreenUniverse universalScreenUniverse) { - this.universalScreenUniverse = universalScreenUniverse; - } - - - public QuantCalculationParameters identifierUniverse(QuantIdentifierUniverse identifierUniverse) { - this.identifierUniverse = identifierUniverse; - return this; - } - - /** - * Get identifierUniverse - * @return identifierUniverse - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_IDENTIFIER_UNIVERSE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public QuantIdentifierUniverse getIdentifierUniverse() { - return identifierUniverse; + public QuantCalculationParameters() { } - - public void setIdentifierUniverse(QuantIdentifierUniverse identifierUniverse) { - this.identifierUniverse = identifierUniverse; - } - - - public QuantCalculationParameters fdsDate(QuantFdsDate fdsDate) { - this.fdsDate = fdsDate; + public QuantCalculationParameters universe(OneOfQuantUniverse universe) { + this.universe = universe; return this; } /** - * Get fdsDate - * @return fdsDate + * Get universe + * @return universe **/ @javax.annotation.Nullable @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_FDS_DATE) + @JsonProperty(JSON_PROPERTY_UNIVERSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public QuantFdsDate getFdsDate() { - return fdsDate; - } - - - public void setFdsDate(QuantFdsDate fdsDate) { - this.fdsDate = fdsDate; + public OneOfQuantUniverse getUniverse() { + return universe; } - public QuantCalculationParameters dateList(QuantDateList dateList) { - this.dateList = dateList; - return this; - } - - /** - * Get dateList - * @return dateList - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_DATE_LIST) + @JsonProperty(JSON_PROPERTY_UNIVERSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public QuantDateList getDateList() { - return dateList; - } - - - public void setDateList(QuantDateList dateList) { - this.dateList = dateList; + public void setUniverse(OneOfQuantUniverse universe) { + this.universe = universe; } - public QuantCalculationParameters screeningExpression(java.util.List screeningExpression) { - this.screeningExpression = screeningExpression; - return this; - } - - public QuantCalculationParameters addScreeningExpressionItem(QuantScreeningExpression screeningExpressionItem) { - if (this.screeningExpression == null) { - this.screeningExpression = new java.util.ArrayList(); - } - this.screeningExpression.add(screeningExpressionItem); + public QuantCalculationParameters dates(OneOfQuantDates dates) { + this.dates = dates; return this; } /** - * Get screeningExpression - * @return screeningExpression + * Get dates + * @return dates **/ @javax.annotation.Nullable @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_SCREENING_EXPRESSION) + @JsonProperty(JSON_PROPERTY_DATES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public java.util.List getScreeningExpression() { - return screeningExpression; + public OneOfQuantDates getDates() { + return dates; } - public void setScreeningExpression(java.util.List screeningExpression) { - this.screeningExpression = screeningExpression; - } - - - public QuantCalculationParameters fqlExpression(java.util.List fqlExpression) { - this.fqlExpression = fqlExpression; - return this; - } - - public QuantCalculationParameters addFqlExpressionItem(QuantFqlExpression fqlExpressionItem) { - if (this.fqlExpression == null) { - this.fqlExpression = new java.util.ArrayList(); - } - this.fqlExpression.add(fqlExpressionItem); - return this; - } - - /** - * Get fqlExpression - * @return fqlExpression - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_FQL_EXPRESSION) + @JsonProperty(JSON_PROPERTY_DATES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getFqlExpression() { - return fqlExpression; + public void setDates(OneOfQuantDates dates) { + this.dates = dates; } - public void setFqlExpression(java.util.List fqlExpression) { - this.fqlExpression = fqlExpression; - } - - - public QuantCalculationParameters universalScreenParameter(java.util.List universalScreenParameter) { - this.universalScreenParameter = universalScreenParameter; + public QuantCalculationParameters formulas(java.util.List formulas) { + this.formulas = formulas; return this; } - public QuantCalculationParameters addUniversalScreenParameterItem(QuantUniversalScreenParameter universalScreenParameterItem) { - if (this.universalScreenParameter == null) { - this.universalScreenParameter = new java.util.ArrayList(); + public QuantCalculationParameters addFormulasItem(OneOfQuantFormulasArray formulasItem) { + if (this.formulas == null) { + this.formulas = new java.util.ArrayList(); } - this.universalScreenParameter.add(universalScreenParameterItem); + this.formulas.add(formulasItem); return this; } /** - * Get universalScreenParameter - * @return universalScreenParameter + * Get formulas + * @return formulas **/ @javax.annotation.Nullable @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_UNIVERSAL_SCREEN_PARAMETER) + @JsonProperty(JSON_PROPERTY_FORMULAS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public java.util.List getUniversalScreenParameter() { - return universalScreenParameter; - } - - - public void setUniversalScreenParameter(java.util.List universalScreenParameter) { - this.universalScreenParameter = universalScreenParameter; - } - - - public QuantCalculationParameters allUniversalScreenParameters(java.util.List allUniversalScreenParameters) { - this.allUniversalScreenParameters = allUniversalScreenParameters; - return this; + public java.util.List getFormulas() { + return formulas; } - public QuantCalculationParameters addAllUniversalScreenParametersItem(Object allUniversalScreenParametersItem) { - if (this.allUniversalScreenParameters == null) { - this.allUniversalScreenParameters = new java.util.ArrayList(); - } - this.allUniversalScreenParameters.add(allUniversalScreenParametersItem); - return this; - } - /** - * Get allUniversalScreenParameters - * @return allUniversalScreenParameters - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "") - @JsonProperty(JSON_PROPERTY_ALL_UNIVERSAL_SCREEN_PARAMETERS) + @JsonProperty(JSON_PROPERTY_FORMULAS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public java.util.List getAllUniversalScreenParameters() { - return allUniversalScreenParameters; - } - - - public void setAllUniversalScreenParameters(java.util.List allUniversalScreenParameters) { - this.allUniversalScreenParameters = allUniversalScreenParameters; + public void setFormulas(java.util.List formulas) { + this.formulas = formulas; } @@ -343,35 +154,23 @@ public boolean equals(Object o) { return false; } QuantCalculationParameters quantCalculationParameters = (QuantCalculationParameters) o; - return Objects.equals(this.screeningExpressionUniverse, quantCalculationParameters.screeningExpressionUniverse) && - Objects.equals(this.universalScreenUniverse, quantCalculationParameters.universalScreenUniverse) && - Objects.equals(this.identifierUniverse, quantCalculationParameters.identifierUniverse) && - Objects.equals(this.fdsDate, quantCalculationParameters.fdsDate) && - Objects.equals(this.dateList, quantCalculationParameters.dateList) && - Objects.equals(this.screeningExpression, quantCalculationParameters.screeningExpression) && - Objects.equals(this.fqlExpression, quantCalculationParameters.fqlExpression) && - Objects.equals(this.universalScreenParameter, quantCalculationParameters.universalScreenParameter) && - Objects.equals(this.allUniversalScreenParameters, quantCalculationParameters.allUniversalScreenParameters); + return Objects.equals(this.universe, quantCalculationParameters.universe) && + Objects.equals(this.dates, quantCalculationParameters.dates) && + Objects.equals(this.formulas, quantCalculationParameters.formulas); } @Override public int hashCode() { - return Objects.hash(screeningExpressionUniverse, universalScreenUniverse, identifierUniverse, fdsDate, dateList, screeningExpression, fqlExpression, universalScreenParameter, allUniversalScreenParameters); + return Objects.hash(universe, dates, formulas); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class QuantCalculationParameters {\n"); - sb.append(" screeningExpressionUniverse: ").append(toIndentedString(screeningExpressionUniverse)).append("\n"); - sb.append(" universalScreenUniverse: ").append(toIndentedString(universalScreenUniverse)).append("\n"); - sb.append(" identifierUniverse: ").append(toIndentedString(identifierUniverse)).append("\n"); - sb.append(" fdsDate: ").append(toIndentedString(fdsDate)).append("\n"); - sb.append(" dateList: ").append(toIndentedString(dateList)).append("\n"); - sb.append(" screeningExpression: ").append(toIndentedString(screeningExpression)).append("\n"); - sb.append(" fqlExpression: ").append(toIndentedString(fqlExpression)).append("\n"); - sb.append(" universalScreenParameter: ").append(toIndentedString(universalScreenParameter)).append("\n"); - sb.append(" allUniversalScreenParameters: ").append(toIndentedString(allUniversalScreenParameters)).append("\n"); + sb.append(" universe: ").append(toIndentedString(universe)).append("\n"); + sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); + sb.append(" formulas: ").append(toIndentedString(formulas)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantCalculationParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantCalculationParametersRoot.java index d47090f4..8ebcddd0 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantCalculationParametersRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantCalculationParametersRoot.java @@ -48,6 +48,8 @@ public class QuantCalculationParametersRoot implements Serializable { public static final String JSON_PROPERTY_META = "meta"; private QuantCalculationMeta meta; + public QuantCalculationParametersRoot() { + } public QuantCalculationParametersRoot data(java.util.Map data) { this.data = data; @@ -76,6 +78,8 @@ public java.util.Map getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(java.util.Map data) { this.data = data; } @@ -100,6 +104,8 @@ public QuantCalculationMeta getMeta() { } + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMeta(QuantCalculationMeta meta) { this.meta = meta; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantDate.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantDate.java new file mode 100644 index 00000000..57b65886 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantDate.java @@ -0,0 +1,214 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * QuantDate + */ +@JsonPropertyOrder({ + QuantDate.JSON_PROPERTY_SOURCE, + QuantDate.JSON_PROPERTY_FREQUENCY, + QuantDate.JSON_PROPERTY_CALENDAR +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class QuantDate implements Serializable { + private static final long serialVersionUID = 1L; + + /** + * Gets or Sets source + */ + public enum SourceEnum { + FDSDATE("FdsDate"), + + DATELIST("DateList"); + + private String value; + + SourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static SourceEnum fromValue(String value) { + for (SourceEnum b : SourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_SOURCE = "source"; + private SourceEnum source; + + public static final String JSON_PROPERTY_FREQUENCY = "frequency"; + private String frequency; + + public static final String JSON_PROPERTY_CALENDAR = "calendar"; + private String calendar; + + public QuantDate() { + } + + public QuantDate source(SourceEnum source) { + this.source = source; + return this; + } + + /** + * Get source + * @return source + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public SourceEnum getSource() { + return source; + } + + + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSource(SourceEnum source) { + this.source = source; + } + + + public QuantDate frequency(String frequency) { + this.frequency = frequency; + return this; + } + + /** + * Get frequency + * @return frequency + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_FREQUENCY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getFrequency() { + return frequency; + } + + + @JsonProperty(JSON_PROPERTY_FREQUENCY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setFrequency(String frequency) { + this.frequency = frequency; + } + + + public QuantDate calendar(String calendar) { + this.calendar = calendar; + return this; + } + + /** + * Get calendar + * @return calendar + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_CALENDAR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getCalendar() { + return calendar; + } + + + @JsonProperty(JSON_PROPERTY_CALENDAR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setCalendar(String calendar) { + this.calendar = calendar; + } + + + /** + * Return true if this QuantDate object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + QuantDate quantDate = (QuantDate) o; + return Objects.equals(this.source, quantDate.source) && + Objects.equals(this.frequency, quantDate.frequency) && + Objects.equals(this.calendar, quantDate.calendar); + } + + @Override + public int hashCode() { + return Objects.hash(source, frequency, calendar); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class QuantDate {\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); + sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); + sb.append(" calendar: ").append(toIndentedString(calendar)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantDateList.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantDateList.java index 220028aa..71700d30 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantDateList.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantDateList.java @@ -22,6 +22,7 @@ import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonTypeName; import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.QuantDate; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.Serializable; @@ -34,6 +35,7 @@ */ @JsonPropertyOrder({ QuantDateList.JSON_PROPERTY_DATES, + QuantDateList.JSON_PROPERTY_SOURCE, QuantDateList.JSON_PROPERTY_FREQUENCY, QuantDateList.JSON_PROPERTY_CALENDAR }) @@ -44,12 +46,52 @@ public class QuantDateList implements Serializable { public static final String JSON_PROPERTY_DATES = "dates"; private java.util.List dates = null; + /** + * Gets or Sets source + */ + public enum SourceEnum { + FDSDATE("FdsDate"), + + DATELIST("DateList"); + + private String value; + + SourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static SourceEnum fromValue(String value) { + for (SourceEnum b : SourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_SOURCE = "source"; + private SourceEnum source; + public static final String JSON_PROPERTY_FREQUENCY = "frequency"; private String frequency; public static final String JSON_PROPERTY_CALENDAR = "calendar"; private String calendar; + public QuantDateList() { + } public QuantDateList dates(java.util.List dates) { this.dates = dates; @@ -78,11 +120,39 @@ public java.util.List getDates() { } + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDates(java.util.List dates) { this.dates = dates; } + public QuantDateList source(SourceEnum source) { + this.source = source; + return this; + } + + /** + * Get source + * @return source + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public SourceEnum getSource() { + return source; + } + + + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSource(SourceEnum source) { + this.source = source; + } + + public QuantDateList frequency(String frequency) { this.frequency = frequency; return this; @@ -92,6 +162,7 @@ public QuantDateList frequency(String frequency) { * Get frequency * @return frequency **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_FREQUENCY) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -101,6 +172,8 @@ public String getFrequency() { } + @JsonProperty(JSON_PROPERTY_FREQUENCY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFrequency(String frequency) { this.frequency = frequency; } @@ -115,6 +188,7 @@ public QuantDateList calendar(String calendar) { * Get calendar * @return calendar **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_CALENDAR) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -124,6 +198,8 @@ public String getCalendar() { } + @JsonProperty(JSON_PROPERTY_CALENDAR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCalendar(String calendar) { this.calendar = calendar; } @@ -142,13 +218,14 @@ public boolean equals(Object o) { } QuantDateList quantDateList = (QuantDateList) o; return Objects.equals(this.dates, quantDateList.dates) && + Objects.equals(this.source, quantDateList.source) && Objects.equals(this.frequency, quantDateList.frequency) && Objects.equals(this.calendar, quantDateList.calendar); } @Override public int hashCode() { - return Objects.hash(dates, frequency, calendar); + return Objects.hash(dates, source, frequency, calendar); } @Override @@ -156,6 +233,7 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class QuantDateList {\n"); sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); sb.append(" calendar: ").append(toIndentedString(calendar)).append("\n"); sb.append("}"); diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantDateListObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantDateListObsolete.java new file mode 100644 index 00000000..76e0218e --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantDateListObsolete.java @@ -0,0 +1,187 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * QuantDateListObsolete + */ +@JsonPropertyOrder({ + QuantDateListObsolete.JSON_PROPERTY_DATES, + QuantDateListObsolete.JSON_PROPERTY_FREQUENCY, + QuantDateListObsolete.JSON_PROPERTY_CALENDAR +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class QuantDateListObsolete implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATES = "dates"; + private java.util.List dates = null; + + public static final String JSON_PROPERTY_FREQUENCY = "frequency"; + private String frequency; + + public static final String JSON_PROPERTY_CALENDAR = "calendar"; + private String calendar; + + public QuantDateListObsolete() { + } + + public QuantDateListObsolete dates(java.util.List dates) { + this.dates = dates; + return this; + } + + public QuantDateListObsolete addDatesItem(String datesItem) { + if (this.dates == null) { + this.dates = new java.util.ArrayList(); + } + this.dates.add(datesItem); + return this; + } + + /** + * Get dates + * @return dates + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getDates() { + return dates; + } + + + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDates(java.util.List dates) { + this.dates = dates; + } + + + public QuantDateListObsolete frequency(String frequency) { + this.frequency = frequency; + return this; + } + + /** + * Get frequency + * @return frequency + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_FREQUENCY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getFrequency() { + return frequency; + } + + + @JsonProperty(JSON_PROPERTY_FREQUENCY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setFrequency(String frequency) { + this.frequency = frequency; + } + + + public QuantDateListObsolete calendar(String calendar) { + this.calendar = calendar; + return this; + } + + /** + * Get calendar + * @return calendar + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_CALENDAR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getCalendar() { + return calendar; + } + + + @JsonProperty(JSON_PROPERTY_CALENDAR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setCalendar(String calendar) { + this.calendar = calendar; + } + + + /** + * Return true if this QuantDateListObsolete object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + QuantDateListObsolete quantDateListObsolete = (QuantDateListObsolete) o; + return Objects.equals(this.dates, quantDateListObsolete.dates) && + Objects.equals(this.frequency, quantDateListObsolete.frequency) && + Objects.equals(this.calendar, quantDateListObsolete.calendar); + } + + @Override + public int hashCode() { + return Objects.hash(dates, frequency, calendar); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class QuantDateListObsolete {\n"); + sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); + sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); + sb.append(" calendar: ").append(toIndentedString(calendar)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFdsDate.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFdsDate.java index 8d0208a1..af445d81 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFdsDate.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFdsDate.java @@ -22,6 +22,7 @@ import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonTypeName; import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.QuantDate; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.Serializable; @@ -35,6 +36,7 @@ @JsonPropertyOrder({ QuantFdsDate.JSON_PROPERTY_START_DATE, QuantFdsDate.JSON_PROPERTY_END_DATE, + QuantFdsDate.JSON_PROPERTY_SOURCE, QuantFdsDate.JSON_PROPERTY_FREQUENCY, QuantFdsDate.JSON_PROPERTY_CALENDAR }) @@ -48,12 +50,52 @@ public class QuantFdsDate implements Serializable { public static final String JSON_PROPERTY_END_DATE = "endDate"; private String endDate; + /** + * Gets or Sets source + */ + public enum SourceEnum { + FDSDATE("FdsDate"), + + DATELIST("DateList"); + + private String value; + + SourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static SourceEnum fromValue(String value) { + for (SourceEnum b : SourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_SOURCE = "source"; + private SourceEnum source; + public static final String JSON_PROPERTY_FREQUENCY = "frequency"; private String frequency; public static final String JSON_PROPERTY_CALENDAR = "calendar"; private String calendar; + public QuantFdsDate() { + } public QuantFdsDate startDate(String startDate) { this.startDate = startDate; @@ -64,6 +106,7 @@ public QuantFdsDate startDate(String startDate) { * Get startDate * @return startDate **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_START_DATE) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -73,6 +116,8 @@ public String getStartDate() { } + @JsonProperty(JSON_PROPERTY_START_DATE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setStartDate(String startDate) { this.startDate = startDate; } @@ -87,6 +132,7 @@ public QuantFdsDate endDate(String endDate) { * Get endDate * @return endDate **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_END_DATE) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -96,11 +142,39 @@ public String getEndDate() { } + @JsonProperty(JSON_PROPERTY_END_DATE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setEndDate(String endDate) { this.endDate = endDate; } + public QuantFdsDate source(SourceEnum source) { + this.source = source; + return this; + } + + /** + * Get source + * @return source + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public SourceEnum getSource() { + return source; + } + + + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSource(SourceEnum source) { + this.source = source; + } + + public QuantFdsDate frequency(String frequency) { this.frequency = frequency; return this; @@ -110,6 +184,7 @@ public QuantFdsDate frequency(String frequency) { * Get frequency * @return frequency **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_FREQUENCY) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -119,6 +194,8 @@ public String getFrequency() { } + @JsonProperty(JSON_PROPERTY_FREQUENCY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFrequency(String frequency) { this.frequency = frequency; } @@ -133,6 +210,7 @@ public QuantFdsDate calendar(String calendar) { * Get calendar * @return calendar **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_CALENDAR) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -142,6 +220,8 @@ public String getCalendar() { } + @JsonProperty(JSON_PROPERTY_CALENDAR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCalendar(String calendar) { this.calendar = calendar; } @@ -161,13 +241,14 @@ public boolean equals(Object o) { QuantFdsDate quantFdsDate = (QuantFdsDate) o; return Objects.equals(this.startDate, quantFdsDate.startDate) && Objects.equals(this.endDate, quantFdsDate.endDate) && + Objects.equals(this.source, quantFdsDate.source) && Objects.equals(this.frequency, quantFdsDate.frequency) && Objects.equals(this.calendar, quantFdsDate.calendar); } @Override public int hashCode() { - return Objects.hash(startDate, endDate, frequency, calendar); + return Objects.hash(startDate, endDate, source, frequency, calendar); } @Override @@ -176,6 +257,7 @@ public String toString() { sb.append("class QuantFdsDate {\n"); sb.append(" startDate: ").append(toIndentedString(startDate)).append("\n"); sb.append(" endDate: ").append(toIndentedString(endDate)).append("\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); sb.append(" calendar: ").append(toIndentedString(calendar)).append("\n"); sb.append("}"); diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFdsDateObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFdsDateObsolete.java new file mode 100644 index 00000000..e92e5fb4 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFdsDateObsolete.java @@ -0,0 +1,211 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * QuantFdsDateObsolete + */ +@JsonPropertyOrder({ + QuantFdsDateObsolete.JSON_PROPERTY_START_DATE, + QuantFdsDateObsolete.JSON_PROPERTY_END_DATE, + QuantFdsDateObsolete.JSON_PROPERTY_FREQUENCY, + QuantFdsDateObsolete.JSON_PROPERTY_CALENDAR +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class QuantFdsDateObsolete implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_START_DATE = "startDate"; + private String startDate; + + public static final String JSON_PROPERTY_END_DATE = "endDate"; + private String endDate; + + public static final String JSON_PROPERTY_FREQUENCY = "frequency"; + private String frequency; + + public static final String JSON_PROPERTY_CALENDAR = "calendar"; + private String calendar; + + public QuantFdsDateObsolete() { + } + + public QuantFdsDateObsolete startDate(String startDate) { + this.startDate = startDate; + return this; + } + + /** + * Get startDate + * @return startDate + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_START_DATE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getStartDate() { + return startDate; + } + + + @JsonProperty(JSON_PROPERTY_START_DATE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setStartDate(String startDate) { + this.startDate = startDate; + } + + + public QuantFdsDateObsolete endDate(String endDate) { + this.endDate = endDate; + return this; + } + + /** + * Get endDate + * @return endDate + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_END_DATE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getEndDate() { + return endDate; + } + + + @JsonProperty(JSON_PROPERTY_END_DATE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setEndDate(String endDate) { + this.endDate = endDate; + } + + + public QuantFdsDateObsolete frequency(String frequency) { + this.frequency = frequency; + return this; + } + + /** + * Get frequency + * @return frequency + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_FREQUENCY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getFrequency() { + return frequency; + } + + + @JsonProperty(JSON_PROPERTY_FREQUENCY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setFrequency(String frequency) { + this.frequency = frequency; + } + + + public QuantFdsDateObsolete calendar(String calendar) { + this.calendar = calendar; + return this; + } + + /** + * Get calendar + * @return calendar + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_CALENDAR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getCalendar() { + return calendar; + } + + + @JsonProperty(JSON_PROPERTY_CALENDAR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setCalendar(String calendar) { + this.calendar = calendar; + } + + + /** + * Return true if this QuantFdsDateObsolete object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + QuantFdsDateObsolete quantFdsDateObsolete = (QuantFdsDateObsolete) o; + return Objects.equals(this.startDate, quantFdsDateObsolete.startDate) && + Objects.equals(this.endDate, quantFdsDateObsolete.endDate) && + Objects.equals(this.frequency, quantFdsDateObsolete.frequency) && + Objects.equals(this.calendar, quantFdsDateObsolete.calendar); + } + + @Override + public int hashCode() { + return Objects.hash(startDate, endDate, frequency, calendar); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class QuantFdsDateObsolete {\n"); + sb.append(" startDate: ").append(toIndentedString(startDate)).append("\n"); + sb.append(" endDate: ").append(toIndentedString(endDate)).append("\n"); + sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); + sb.append(" calendar: ").append(toIndentedString(calendar)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFormula.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFormula.java new file mode 100644 index 00000000..31a1ad50 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFormula.java @@ -0,0 +1,154 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * QuantFormula + */ +@JsonPropertyOrder({ + QuantFormula.JSON_PROPERTY_SOURCE +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class QuantFormula implements Serializable { + private static final long serialVersionUID = 1L; + + /** + * Gets or Sets source + */ + public enum SourceEnum { + SCREENINGEXPRESSION("ScreeningExpression"), + + FQLEXPRESSION("FqlExpression"), + + UNIVERSALSCREENPARAMETER("UniversalScreenParameter"), + + ALLUNIVERSALSCREENPARAMETERS("AllUniversalScreenParameters"); + + private String value; + + SourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static SourceEnum fromValue(String value) { + for (SourceEnum b : SourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_SOURCE = "source"; + private SourceEnum source; + + public QuantFormula() { + } + + public QuantFormula source(SourceEnum source) { + this.source = source; + return this; + } + + /** + * Get source + * @return source + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public SourceEnum getSource() { + return source; + } + + + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSource(SourceEnum source) { + this.source = source; + } + + + /** + * Return true if this QuantFormula object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + QuantFormula quantFormula = (QuantFormula) o; + return Objects.equals(this.source, quantFormula.source); + } + + @Override + public int hashCode() { + return Objects.hash(source); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class QuantFormula {\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFqlExpression.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFqlExpression.java index a6c1c842..f2715624 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFqlExpression.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFqlExpression.java @@ -22,6 +22,7 @@ import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonTypeName; import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.QuantFormula; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.Serializable; @@ -34,7 +35,8 @@ */ @JsonPropertyOrder({ QuantFqlExpression.JSON_PROPERTY_EXPR, - QuantFqlExpression.JSON_PROPERTY_NAME + QuantFqlExpression.JSON_PROPERTY_NAME, + QuantFqlExpression.JSON_PROPERTY_SOURCE }) @javax.annotation.Generated(value = "CustomJavaClientCodegen") public class QuantFqlExpression implements Serializable { @@ -46,6 +48,50 @@ public class QuantFqlExpression implements Serializable { public static final String JSON_PROPERTY_NAME = "name"; private String name; + /** + * Gets or Sets source + */ + public enum SourceEnum { + SCREENINGEXPRESSION("ScreeningExpression"), + + FQLEXPRESSION("FqlExpression"), + + UNIVERSALSCREENPARAMETER("UniversalScreenParameter"), + + ALLUNIVERSALSCREENPARAMETERS("AllUniversalScreenParameters"); + + private String value; + + SourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static SourceEnum fromValue(String value) { + for (SourceEnum b : SourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_SOURCE = "source"; + private SourceEnum source; + + public QuantFqlExpression() { + } public QuantFqlExpression expr(String expr) { this.expr = expr; @@ -56,6 +102,7 @@ public QuantFqlExpression expr(String expr) { * Get expr * @return expr **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_EXPR) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -65,6 +112,8 @@ public String getExpr() { } + @JsonProperty(JSON_PROPERTY_EXPR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setExpr(String expr) { this.expr = expr; } @@ -79,6 +128,7 @@ public QuantFqlExpression name(String name) { * Get name * @return name **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -88,11 +138,39 @@ public String getName() { } + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } + public QuantFqlExpression source(SourceEnum source) { + this.source = source; + return this; + } + + /** + * Get source + * @return source + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public SourceEnum getSource() { + return source; + } + + + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSource(SourceEnum source) { + this.source = source; + } + + /** * Return true if this QuantFqlExpression object is equal to o. */ @@ -106,12 +184,13 @@ public boolean equals(Object o) { } QuantFqlExpression quantFqlExpression = (QuantFqlExpression) o; return Objects.equals(this.expr, quantFqlExpression.expr) && - Objects.equals(this.name, quantFqlExpression.name); + Objects.equals(this.name, quantFqlExpression.name) && + Objects.equals(this.source, quantFqlExpression.source); } @Override public int hashCode() { - return Objects.hash(expr, name); + return Objects.hash(expr, name, source); } @Override @@ -120,6 +199,7 @@ public String toString() { sb.append("class QuantFqlExpression {\n"); sb.append(" expr: ").append(toIndentedString(expr)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFqlExpressionObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFqlExpressionObsolete.java new file mode 100644 index 00000000..ef51e814 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantFqlExpressionObsolete.java @@ -0,0 +1,147 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * QuantFqlExpressionObsolete + */ +@JsonPropertyOrder({ + QuantFqlExpressionObsolete.JSON_PROPERTY_EXPR, + QuantFqlExpressionObsolete.JSON_PROPERTY_NAME +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class QuantFqlExpressionObsolete implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_EXPR = "expr"; + private String expr; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public QuantFqlExpressionObsolete() { + } + + public QuantFqlExpressionObsolete expr(String expr) { + this.expr = expr; + return this; + } + + /** + * Get expr + * @return expr + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_EXPR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getExpr() { + return expr; + } + + + @JsonProperty(JSON_PROPERTY_EXPR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setExpr(String expr) { + this.expr = expr; + } + + + public QuantFqlExpressionObsolete name(String name) { + this.name = name; + return this; + } + + /** + * Get name + * @return name + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getName() { + return name; + } + + + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setName(String name) { + this.name = name; + } + + + /** + * Return true if this QuantFqlExpressionObsolete object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + QuantFqlExpressionObsolete quantFqlExpressionObsolete = (QuantFqlExpressionObsolete) o; + return Objects.equals(this.expr, quantFqlExpressionObsolete.expr) && + Objects.equals(this.name, quantFqlExpressionObsolete.name); + } + + @Override + public int hashCode() { + return Objects.hash(expr, name); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class QuantFqlExpressionObsolete {\n"); + sb.append(" expr: ").append(toIndentedString(expr)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantIdentifierUniverse.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantIdentifierUniverse.java index 61a583b5..ffe3ee94 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantIdentifierUniverse.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantIdentifierUniverse.java @@ -22,6 +22,7 @@ import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonTypeName; import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.QuantUniverse; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.Serializable; @@ -34,7 +35,8 @@ */ @JsonPropertyOrder({ QuantIdentifierUniverse.JSON_PROPERTY_UNIVERSE_TYPE, - QuantIdentifierUniverse.JSON_PROPERTY_IDENTIFIERS + QuantIdentifierUniverse.JSON_PROPERTY_IDENTIFIERS, + QuantIdentifierUniverse.JSON_PROPERTY_SOURCE }) @javax.annotation.Generated(value = "CustomJavaClientCodegen") public class QuantIdentifierUniverse implements Serializable { @@ -81,6 +83,48 @@ public static UniverseTypeEnum fromValue(String value) { public static final String JSON_PROPERTY_IDENTIFIERS = "identifiers"; private java.util.List identifiers = new java.util.ArrayList(); + /** + * Gets or Sets source + */ + public enum SourceEnum { + SCREENINGEXPRESSIONUNIVERSE("ScreeningExpressionUniverse"), + + UNIVERSALSCREENUNIVERSE("UniversalScreenUniverse"), + + IDENTIFIERUNIVERSE("IdentifierUniverse"); + + private String value; + + SourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static SourceEnum fromValue(String value) { + for (SourceEnum b : SourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_SOURCE = "source"; + private SourceEnum source; + + public QuantIdentifierUniverse() { + } public QuantIdentifierUniverse universeType(UniverseTypeEnum universeType) { this.universeType = universeType; @@ -91,6 +135,7 @@ public QuantIdentifierUniverse universeType(UniverseTypeEnum universeType) { * Get universeType * @return universeType **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_UNIVERSE_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -100,6 +145,8 @@ public UniverseTypeEnum getUniverseType() { } + @JsonProperty(JSON_PROPERTY_UNIVERSE_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setUniverseType(UniverseTypeEnum universeType) { this.universeType = universeType; } @@ -119,6 +166,7 @@ public QuantIdentifierUniverse addIdentifiersItem(String identifiersItem) { * Get identifiers * @return identifiers **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_IDENTIFIERS) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -128,11 +176,39 @@ public java.util.List getIdentifiers() { } + @JsonProperty(JSON_PROPERTY_IDENTIFIERS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIdentifiers(java.util.List identifiers) { this.identifiers = identifiers; } + public QuantIdentifierUniverse source(SourceEnum source) { + this.source = source; + return this; + } + + /** + * Get source + * @return source + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public SourceEnum getSource() { + return source; + } + + + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSource(SourceEnum source) { + this.source = source; + } + + /** * Return true if this QuantIdentifierUniverse object is equal to o. */ @@ -146,12 +222,13 @@ public boolean equals(Object o) { } QuantIdentifierUniverse quantIdentifierUniverse = (QuantIdentifierUniverse) o; return Objects.equals(this.universeType, quantIdentifierUniverse.universeType) && - Objects.equals(this.identifiers, quantIdentifierUniverse.identifiers); + Objects.equals(this.identifiers, quantIdentifierUniverse.identifiers) && + Objects.equals(this.source, quantIdentifierUniverse.source); } @Override public int hashCode() { - return Objects.hash(universeType, identifiers); + return Objects.hash(universeType, identifiers, source); } @Override @@ -160,6 +237,7 @@ public String toString() { sb.append("class QuantIdentifierUniverse {\n"); sb.append(" universeType: ").append(toIndentedString(universeType)).append("\n"); sb.append(" identifiers: ").append(toIndentedString(identifiers)).append("\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantIdentifierUniverseObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantIdentifierUniverseObsolete.java new file mode 100644 index 00000000..869a5030 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantIdentifierUniverseObsolete.java @@ -0,0 +1,256 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * QuantIdentifierUniverseObsolete + */ +@JsonPropertyOrder({ + QuantIdentifierUniverseObsolete.JSON_PROPERTY_UNIVERSE_TYPE, + QuantIdentifierUniverseObsolete.JSON_PROPERTY_IDENTIFIERS, + QuantIdentifierUniverseObsolete.JSON_PROPERTY_SOURCE +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class QuantIdentifierUniverseObsolete implements Serializable { + private static final long serialVersionUID = 1L; + + /** + * Gets or Sets universeType + */ + public enum UniverseTypeEnum { + EQUITY("Equity"), + + DEBT("Debt"); + + private String value; + + UniverseTypeEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static UniverseTypeEnum fromValue(String value) { + for (UniverseTypeEnum b : UniverseTypeEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_UNIVERSE_TYPE = "universeType"; + private UniverseTypeEnum universeType; + + public static final String JSON_PROPERTY_IDENTIFIERS = "identifiers"; + private java.util.List identifiers = new java.util.ArrayList(); + + /** + * Gets or Sets source + */ + public enum SourceEnum { + SCREENINGEXPRESSIONUNIVERSE("ScreeningExpressionUniverse"), + + UNIVERSALSCREENUNIVERSE("UniversalScreenUniverse"), + + IDENTIFIERUNIVERSE("IdentifierUniverse"); + + private String value; + + SourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static SourceEnum fromValue(String value) { + for (SourceEnum b : SourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_SOURCE = "source"; + private SourceEnum source; + + public QuantIdentifierUniverseObsolete() { + } + + public QuantIdentifierUniverseObsolete universeType(UniverseTypeEnum universeType) { + this.universeType = universeType; + return this; + } + + /** + * Get universeType + * @return universeType + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_UNIVERSE_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public UniverseTypeEnum getUniverseType() { + return universeType; + } + + + @JsonProperty(JSON_PROPERTY_UNIVERSE_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setUniverseType(UniverseTypeEnum universeType) { + this.universeType = universeType; + } + + + public QuantIdentifierUniverseObsolete identifiers(java.util.List identifiers) { + this.identifiers = identifiers; + return this; + } + + public QuantIdentifierUniverseObsolete addIdentifiersItem(String identifiersItem) { + this.identifiers.add(identifiersItem); + return this; + } + + /** + * Get identifiers + * @return identifiers + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_IDENTIFIERS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public java.util.List getIdentifiers() { + return identifiers; + } + + + @JsonProperty(JSON_PROPERTY_IDENTIFIERS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setIdentifiers(java.util.List identifiers) { + this.identifiers = identifiers; + } + + + public QuantIdentifierUniverseObsolete source(SourceEnum source) { + this.source = source; + return this; + } + + /** + * Get source + * @return source + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SourceEnum getSource() { + return source; + } + + + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSource(SourceEnum source) { + this.source = source; + } + + + /** + * Return true if this QuantIdentifierUniverseObsolete object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + QuantIdentifierUniverseObsolete quantIdentifierUniverseObsolete = (QuantIdentifierUniverseObsolete) o; + return Objects.equals(this.universeType, quantIdentifierUniverseObsolete.universeType) && + Objects.equals(this.identifiers, quantIdentifierUniverseObsolete.identifiers) && + Objects.equals(this.source, quantIdentifierUniverseObsolete.source); + } + + @Override + public int hashCode() { + return Objects.hash(universeType, identifiers, source); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class QuantIdentifierUniverseObsolete {\n"); + sb.append(" universeType: ").append(toIndentedString(universeType)).append("\n"); + sb.append(" identifiers: ").append(toIndentedString(identifiers)).append("\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpression.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpression.java index 95352fec..96b060d2 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpression.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpression.java @@ -22,6 +22,7 @@ import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonTypeName; import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.QuantFormula; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.Serializable; @@ -34,7 +35,8 @@ */ @JsonPropertyOrder({ QuantScreeningExpression.JSON_PROPERTY_EXPR, - QuantScreeningExpression.JSON_PROPERTY_NAME + QuantScreeningExpression.JSON_PROPERTY_NAME, + QuantScreeningExpression.JSON_PROPERTY_SOURCE }) @javax.annotation.Generated(value = "CustomJavaClientCodegen") public class QuantScreeningExpression implements Serializable { @@ -46,6 +48,50 @@ public class QuantScreeningExpression implements Serializable { public static final String JSON_PROPERTY_NAME = "name"; private String name; + /** + * Gets or Sets source + */ + public enum SourceEnum { + SCREENINGEXPRESSION("ScreeningExpression"), + + FQLEXPRESSION("FqlExpression"), + + UNIVERSALSCREENPARAMETER("UniversalScreenParameter"), + + ALLUNIVERSALSCREENPARAMETERS("AllUniversalScreenParameters"); + + private String value; + + SourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static SourceEnum fromValue(String value) { + for (SourceEnum b : SourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_SOURCE = "source"; + private SourceEnum source; + + public QuantScreeningExpression() { + } public QuantScreeningExpression expr(String expr) { this.expr = expr; @@ -56,6 +102,7 @@ public QuantScreeningExpression expr(String expr) { * Get expr * @return expr **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_EXPR) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -65,6 +112,8 @@ public String getExpr() { } + @JsonProperty(JSON_PROPERTY_EXPR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setExpr(String expr) { this.expr = expr; } @@ -79,6 +128,7 @@ public QuantScreeningExpression name(String name) { * Get name * @return name **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -88,11 +138,39 @@ public String getName() { } + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } + public QuantScreeningExpression source(SourceEnum source) { + this.source = source; + return this; + } + + /** + * Get source + * @return source + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public SourceEnum getSource() { + return source; + } + + + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSource(SourceEnum source) { + this.source = source; + } + + /** * Return true if this QuantScreeningExpression object is equal to o. */ @@ -106,12 +184,13 @@ public boolean equals(Object o) { } QuantScreeningExpression quantScreeningExpression = (QuantScreeningExpression) o; return Objects.equals(this.expr, quantScreeningExpression.expr) && - Objects.equals(this.name, quantScreeningExpression.name); + Objects.equals(this.name, quantScreeningExpression.name) && + Objects.equals(this.source, quantScreeningExpression.source); } @Override public int hashCode() { - return Objects.hash(expr, name); + return Objects.hash(expr, name, source); } @Override @@ -120,6 +199,7 @@ public String toString() { sb.append("class QuantScreeningExpression {\n"); sb.append(" expr: ").append(toIndentedString(expr)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionObsolete.java new file mode 100644 index 00000000..004e3c15 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionObsolete.java @@ -0,0 +1,147 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * QuantScreeningExpressionObsolete + */ +@JsonPropertyOrder({ + QuantScreeningExpressionObsolete.JSON_PROPERTY_EXPR, + QuantScreeningExpressionObsolete.JSON_PROPERTY_NAME +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class QuantScreeningExpressionObsolete implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_EXPR = "expr"; + private String expr; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public QuantScreeningExpressionObsolete() { + } + + public QuantScreeningExpressionObsolete expr(String expr) { + this.expr = expr; + return this; + } + + /** + * Get expr + * @return expr + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_EXPR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getExpr() { + return expr; + } + + + @JsonProperty(JSON_PROPERTY_EXPR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setExpr(String expr) { + this.expr = expr; + } + + + public QuantScreeningExpressionObsolete name(String name) { + this.name = name; + return this; + } + + /** + * Get name + * @return name + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getName() { + return name; + } + + + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setName(String name) { + this.name = name; + } + + + /** + * Return true if this QuantScreeningExpressionObsolete object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + QuantScreeningExpressionObsolete quantScreeningExpressionObsolete = (QuantScreeningExpressionObsolete) o; + return Objects.equals(this.expr, quantScreeningExpressionObsolete.expr) && + Objects.equals(this.name, quantScreeningExpressionObsolete.name); + } + + @Override + public int hashCode() { + return Objects.hash(expr, name); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class QuantScreeningExpressionObsolete {\n"); + sb.append(" expr: ").append(toIndentedString(expr)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionUniverse.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionUniverse.java index 8f0c5307..7e72e90b 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionUniverse.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionUniverse.java @@ -22,6 +22,7 @@ import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonTypeName; import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.QuantUniverse; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.Serializable; @@ -35,7 +36,8 @@ @JsonPropertyOrder({ QuantScreeningExpressionUniverse.JSON_PROPERTY_UNIVERSE_EXPR, QuantScreeningExpressionUniverse.JSON_PROPERTY_UNIVERSE_TYPE, - QuantScreeningExpressionUniverse.JSON_PROPERTY_SECURITY_EXPR + QuantScreeningExpressionUniverse.JSON_PROPERTY_SECURITY_EXPR, + QuantScreeningExpressionUniverse.JSON_PROPERTY_SOURCE }) @javax.annotation.Generated(value = "CustomJavaClientCodegen") public class QuantScreeningExpressionUniverse implements Serializable { @@ -85,6 +87,48 @@ public static UniverseTypeEnum fromValue(String value) { public static final String JSON_PROPERTY_SECURITY_EXPR = "securityExpr"; private String securityExpr; + /** + * Gets or Sets source + */ + public enum SourceEnum { + SCREENINGEXPRESSIONUNIVERSE("ScreeningExpressionUniverse"), + + UNIVERSALSCREENUNIVERSE("UniversalScreenUniverse"), + + IDENTIFIERUNIVERSE("IdentifierUniverse"); + + private String value; + + SourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static SourceEnum fromValue(String value) { + for (SourceEnum b : SourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_SOURCE = "source"; + private SourceEnum source; + + public QuantScreeningExpressionUniverse() { + } public QuantScreeningExpressionUniverse universeExpr(String universeExpr) { this.universeExpr = universeExpr; @@ -95,6 +139,7 @@ public QuantScreeningExpressionUniverse universeExpr(String universeExpr) { * Get universeExpr * @return universeExpr **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_UNIVERSE_EXPR) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -104,6 +149,8 @@ public String getUniverseExpr() { } + @JsonProperty(JSON_PROPERTY_UNIVERSE_EXPR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setUniverseExpr(String universeExpr) { this.universeExpr = universeExpr; } @@ -118,6 +165,7 @@ public QuantScreeningExpressionUniverse universeType(UniverseTypeEnum universeTy * Get universeType * @return universeType **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_UNIVERSE_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -127,6 +175,8 @@ public UniverseTypeEnum getUniverseType() { } + @JsonProperty(JSON_PROPERTY_UNIVERSE_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setUniverseType(UniverseTypeEnum universeType) { this.universeType = universeType; } @@ -151,11 +201,39 @@ public String getSecurityExpr() { } + @JsonProperty(JSON_PROPERTY_SECURITY_EXPR) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSecurityExpr(String securityExpr) { this.securityExpr = securityExpr; } + public QuantScreeningExpressionUniverse source(SourceEnum source) { + this.source = source; + return this; + } + + /** + * Get source + * @return source + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public SourceEnum getSource() { + return source; + } + + + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSource(SourceEnum source) { + this.source = source; + } + + /** * Return true if this QuantScreeningExpressionUniverse object is equal to o. */ @@ -170,12 +248,13 @@ public boolean equals(Object o) { QuantScreeningExpressionUniverse quantScreeningExpressionUniverse = (QuantScreeningExpressionUniverse) o; return Objects.equals(this.universeExpr, quantScreeningExpressionUniverse.universeExpr) && Objects.equals(this.universeType, quantScreeningExpressionUniverse.universeType) && - Objects.equals(this.securityExpr, quantScreeningExpressionUniverse.securityExpr); + Objects.equals(this.securityExpr, quantScreeningExpressionUniverse.securityExpr) && + Objects.equals(this.source, quantScreeningExpressionUniverse.source); } @Override public int hashCode() { - return Objects.hash(universeExpr, universeType, securityExpr); + return Objects.hash(universeExpr, universeType, securityExpr, source); } @Override @@ -185,6 +264,7 @@ public String toString() { sb.append(" universeExpr: ").append(toIndentedString(universeExpr)).append("\n"); sb.append(" universeType: ").append(toIndentedString(universeType)).append("\n"); sb.append(" securityExpr: ").append(toIndentedString(securityExpr)).append("\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionUniverseObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionUniverseObsolete.java new file mode 100644 index 00000000..5f061760 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantScreeningExpressionUniverseObsolete.java @@ -0,0 +1,283 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * QuantScreeningExpressionUniverseObsolete + */ +@JsonPropertyOrder({ + QuantScreeningExpressionUniverseObsolete.JSON_PROPERTY_UNIVERSE_EXPR, + QuantScreeningExpressionUniverseObsolete.JSON_PROPERTY_UNIVERSE_TYPE, + QuantScreeningExpressionUniverseObsolete.JSON_PROPERTY_SECURITY_EXPR, + QuantScreeningExpressionUniverseObsolete.JSON_PROPERTY_SOURCE +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class QuantScreeningExpressionUniverseObsolete implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_UNIVERSE_EXPR = "universeExpr"; + private String universeExpr; + + /** + * Gets or Sets universeType + */ + public enum UniverseTypeEnum { + EQUITY("Equity"), + + DEBT("Debt"); + + private String value; + + UniverseTypeEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static UniverseTypeEnum fromValue(String value) { + for (UniverseTypeEnum b : UniverseTypeEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_UNIVERSE_TYPE = "universeType"; + private UniverseTypeEnum universeType; + + public static final String JSON_PROPERTY_SECURITY_EXPR = "securityExpr"; + private String securityExpr; + + /** + * Gets or Sets source + */ + public enum SourceEnum { + SCREENINGEXPRESSIONUNIVERSE("ScreeningExpressionUniverse"), + + UNIVERSALSCREENUNIVERSE("UniversalScreenUniverse"), + + IDENTIFIERUNIVERSE("IdentifierUniverse"); + + private String value; + + SourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static SourceEnum fromValue(String value) { + for (SourceEnum b : SourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_SOURCE = "source"; + private SourceEnum source; + + public QuantScreeningExpressionUniverseObsolete() { + } + + public QuantScreeningExpressionUniverseObsolete universeExpr(String universeExpr) { + this.universeExpr = universeExpr; + return this; + } + + /** + * Get universeExpr + * @return universeExpr + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_UNIVERSE_EXPR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getUniverseExpr() { + return universeExpr; + } + + + @JsonProperty(JSON_PROPERTY_UNIVERSE_EXPR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setUniverseExpr(String universeExpr) { + this.universeExpr = universeExpr; + } + + + public QuantScreeningExpressionUniverseObsolete universeType(UniverseTypeEnum universeType) { + this.universeType = universeType; + return this; + } + + /** + * Get universeType + * @return universeType + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_UNIVERSE_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public UniverseTypeEnum getUniverseType() { + return universeType; + } + + + @JsonProperty(JSON_PROPERTY_UNIVERSE_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setUniverseType(UniverseTypeEnum universeType) { + this.universeType = universeType; + } + + + public QuantScreeningExpressionUniverseObsolete securityExpr(String securityExpr) { + this.securityExpr = securityExpr; + return this; + } + + /** + * Get securityExpr + * @return securityExpr + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_SECURITY_EXPR) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSecurityExpr() { + return securityExpr; + } + + + @JsonProperty(JSON_PROPERTY_SECURITY_EXPR) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSecurityExpr(String securityExpr) { + this.securityExpr = securityExpr; + } + + + public QuantScreeningExpressionUniverseObsolete source(SourceEnum source) { + this.source = source; + return this; + } + + /** + * Get source + * @return source + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SourceEnum getSource() { + return source; + } + + + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSource(SourceEnum source) { + this.source = source; + } + + + /** + * Return true if this QuantScreeningExpressionUniverseObsolete object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + QuantScreeningExpressionUniverseObsolete quantScreeningExpressionUniverseObsolete = (QuantScreeningExpressionUniverseObsolete) o; + return Objects.equals(this.universeExpr, quantScreeningExpressionUniverseObsolete.universeExpr) && + Objects.equals(this.universeType, quantScreeningExpressionUniverseObsolete.universeType) && + Objects.equals(this.securityExpr, quantScreeningExpressionUniverseObsolete.securityExpr) && + Objects.equals(this.source, quantScreeningExpressionUniverseObsolete.source); + } + + @Override + public int hashCode() { + return Objects.hash(universeExpr, universeType, securityExpr, source); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class QuantScreeningExpressionUniverseObsolete {\n"); + sb.append(" universeExpr: ").append(toIndentedString(universeExpr)).append("\n"); + sb.append(" universeType: ").append(toIndentedString(universeType)).append("\n"); + sb.append(" securityExpr: ").append(toIndentedString(securityExpr)).append("\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenParameter.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenParameter.java index 7ea7c6b3..a95295c8 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenParameter.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenParameter.java @@ -22,6 +22,7 @@ import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonTypeName; import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.QuantFormula; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.Serializable; @@ -34,7 +35,8 @@ */ @JsonPropertyOrder({ QuantUniversalScreenParameter.JSON_PROPERTY_REFERENCE_NAME, - QuantUniversalScreenParameter.JSON_PROPERTY_NAME + QuantUniversalScreenParameter.JSON_PROPERTY_NAME, + QuantUniversalScreenParameter.JSON_PROPERTY_SOURCE }) @javax.annotation.Generated(value = "CustomJavaClientCodegen") public class QuantUniversalScreenParameter implements Serializable { @@ -46,6 +48,50 @@ public class QuantUniversalScreenParameter implements Serializable { public static final String JSON_PROPERTY_NAME = "name"; private String name; + /** + * Gets or Sets source + */ + public enum SourceEnum { + SCREENINGEXPRESSION("ScreeningExpression"), + + FQLEXPRESSION("FqlExpression"), + + UNIVERSALSCREENPARAMETER("UniversalScreenParameter"), + + ALLUNIVERSALSCREENPARAMETERS("AllUniversalScreenParameters"); + + private String value; + + SourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static SourceEnum fromValue(String value) { + for (SourceEnum b : SourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_SOURCE = "source"; + private SourceEnum source; + + public QuantUniversalScreenParameter() { + } public QuantUniversalScreenParameter referenceName(String referenceName) { this.referenceName = referenceName; @@ -56,6 +102,7 @@ public QuantUniversalScreenParameter referenceName(String referenceName) { * Get referenceName * @return referenceName **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_REFERENCE_NAME) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -65,6 +112,8 @@ public String getReferenceName() { } + @JsonProperty(JSON_PROPERTY_REFERENCE_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setReferenceName(String referenceName) { this.referenceName = referenceName; } @@ -79,6 +128,7 @@ public QuantUniversalScreenParameter name(String name) { * Get name * @return name **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -88,11 +138,39 @@ public String getName() { } + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } + public QuantUniversalScreenParameter source(SourceEnum source) { + this.source = source; + return this; + } + + /** + * Get source + * @return source + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public SourceEnum getSource() { + return source; + } + + + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSource(SourceEnum source) { + this.source = source; + } + + /** * Return true if this QuantUniversalScreenParameter object is equal to o. */ @@ -106,12 +184,13 @@ public boolean equals(Object o) { } QuantUniversalScreenParameter quantUniversalScreenParameter = (QuantUniversalScreenParameter) o; return Objects.equals(this.referenceName, quantUniversalScreenParameter.referenceName) && - Objects.equals(this.name, quantUniversalScreenParameter.name); + Objects.equals(this.name, quantUniversalScreenParameter.name) && + Objects.equals(this.source, quantUniversalScreenParameter.source); } @Override public int hashCode() { - return Objects.hash(referenceName, name); + return Objects.hash(referenceName, name, source); } @Override @@ -120,6 +199,7 @@ public String toString() { sb.append("class QuantUniversalScreenParameter {\n"); sb.append(" referenceName: ").append(toIndentedString(referenceName)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenParameterObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenParameterObsolete.java new file mode 100644 index 00000000..1680c1aa --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenParameterObsolete.java @@ -0,0 +1,147 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * QuantUniversalScreenParameterObsolete + */ +@JsonPropertyOrder({ + QuantUniversalScreenParameterObsolete.JSON_PROPERTY_REFERENCE_NAME, + QuantUniversalScreenParameterObsolete.JSON_PROPERTY_NAME +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class QuantUniversalScreenParameterObsolete implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_REFERENCE_NAME = "referenceName"; + private String referenceName; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public QuantUniversalScreenParameterObsolete() { + } + + public QuantUniversalScreenParameterObsolete referenceName(String referenceName) { + this.referenceName = referenceName; + return this; + } + + /** + * Get referenceName + * @return referenceName + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_REFERENCE_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getReferenceName() { + return referenceName; + } + + + @JsonProperty(JSON_PROPERTY_REFERENCE_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setReferenceName(String referenceName) { + this.referenceName = referenceName; + } + + + public QuantUniversalScreenParameterObsolete name(String name) { + this.name = name; + return this; + } + + /** + * Get name + * @return name + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getName() { + return name; + } + + + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setName(String name) { + this.name = name; + } + + + /** + * Return true if this QuantUniversalScreenParameterObsolete object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + QuantUniversalScreenParameterObsolete quantUniversalScreenParameterObsolete = (QuantUniversalScreenParameterObsolete) o; + return Objects.equals(this.referenceName, quantUniversalScreenParameterObsolete.referenceName) && + Objects.equals(this.name, quantUniversalScreenParameterObsolete.name); + } + + @Override + public int hashCode() { + return Objects.hash(referenceName, name); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class QuantUniversalScreenParameterObsolete {\n"); + sb.append(" referenceName: ").append(toIndentedString(referenceName)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenUniverse.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenUniverse.java index e5a82999..25cb175e 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenUniverse.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenUniverse.java @@ -22,6 +22,7 @@ import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonTypeName; import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.QuantUniverse; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.Serializable; @@ -33,7 +34,8 @@ * QuantUniversalScreenUniverse */ @JsonPropertyOrder({ - QuantUniversalScreenUniverse.JSON_PROPERTY_SCREEN + QuantUniversalScreenUniverse.JSON_PROPERTY_SCREEN, + QuantUniversalScreenUniverse.JSON_PROPERTY_SOURCE }) @javax.annotation.Generated(value = "CustomJavaClientCodegen") public class QuantUniversalScreenUniverse implements Serializable { @@ -42,6 +44,48 @@ public class QuantUniversalScreenUniverse implements Serializable { public static final String JSON_PROPERTY_SCREEN = "screen"; private String screen; + /** + * Gets or Sets source + */ + public enum SourceEnum { + SCREENINGEXPRESSIONUNIVERSE("ScreeningExpressionUniverse"), + + UNIVERSALSCREENUNIVERSE("UniversalScreenUniverse"), + + IDENTIFIERUNIVERSE("IdentifierUniverse"); + + private String value; + + SourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static SourceEnum fromValue(String value) { + for (SourceEnum b : SourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_SOURCE = "source"; + private SourceEnum source; + + public QuantUniversalScreenUniverse() { + } public QuantUniversalScreenUniverse screen(String screen) { this.screen = screen; @@ -52,6 +96,7 @@ public QuantUniversalScreenUniverse screen(String screen) { * Get screen * @return screen **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_SCREEN) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -61,11 +106,39 @@ public String getScreen() { } + @JsonProperty(JSON_PROPERTY_SCREEN) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setScreen(String screen) { this.screen = screen; } + public QuantUniversalScreenUniverse source(SourceEnum source) { + this.source = source; + return this; + } + + /** + * Get source + * @return source + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public SourceEnum getSource() { + return source; + } + + + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSource(SourceEnum source) { + this.source = source; + } + + /** * Return true if this QuantUniversalScreenUniverse object is equal to o. */ @@ -78,12 +151,13 @@ public boolean equals(Object o) { return false; } QuantUniversalScreenUniverse quantUniversalScreenUniverse = (QuantUniversalScreenUniverse) o; - return Objects.equals(this.screen, quantUniversalScreenUniverse.screen); + return Objects.equals(this.screen, quantUniversalScreenUniverse.screen) && + Objects.equals(this.source, quantUniversalScreenUniverse.source); } @Override public int hashCode() { - return Objects.hash(screen); + return Objects.hash(screen, source); } @Override @@ -91,6 +165,7 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class QuantUniversalScreenUniverse {\n"); sb.append(" screen: ").append(toIndentedString(screen)).append("\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenUniverseObsolete.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenUniverseObsolete.java new file mode 100644 index 00000000..0771ce0d --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenUniverseObsolete.java @@ -0,0 +1,184 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * QuantUniversalScreenUniverseObsolete + */ +@JsonPropertyOrder({ + QuantUniversalScreenUniverseObsolete.JSON_PROPERTY_SCREEN, + QuantUniversalScreenUniverseObsolete.JSON_PROPERTY_SOURCE +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class QuantUniversalScreenUniverseObsolete implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_SCREEN = "screen"; + private String screen; + + /** + * Gets or Sets source + */ + public enum SourceEnum { + SCREENINGEXPRESSIONUNIVERSE("ScreeningExpressionUniverse"), + + UNIVERSALSCREENUNIVERSE("UniversalScreenUniverse"), + + IDENTIFIERUNIVERSE("IdentifierUniverse"); + + private String value; + + SourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static SourceEnum fromValue(String value) { + for (SourceEnum b : SourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_SOURCE = "source"; + private SourceEnum source; + + public QuantUniversalScreenUniverseObsolete() { + } + + public QuantUniversalScreenUniverseObsolete screen(String screen) { + this.screen = screen; + return this; + } + + /** + * Get screen + * @return screen + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_SCREEN) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getScreen() { + return screen; + } + + + @JsonProperty(JSON_PROPERTY_SCREEN) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setScreen(String screen) { + this.screen = screen; + } + + + public QuantUniversalScreenUniverseObsolete source(SourceEnum source) { + this.source = source; + return this; + } + + /** + * Get source + * @return source + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SourceEnum getSource() { + return source; + } + + + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSource(SourceEnum source) { + this.source = source; + } + + + /** + * Return true if this QuantUniversalScreenUniverseObsolete object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + QuantUniversalScreenUniverseObsolete quantUniversalScreenUniverseObsolete = (QuantUniversalScreenUniverseObsolete) o; + return Objects.equals(this.screen, quantUniversalScreenUniverseObsolete.screen) && + Objects.equals(this.source, quantUniversalScreenUniverseObsolete.source); + } + + @Override + public int hashCode() { + return Objects.hash(screen, source); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class QuantUniversalScreenUniverseObsolete {\n"); + sb.append(" screen: ").append(toIndentedString(screen)).append("\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniverse.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniverse.java new file mode 100644 index 00000000..615493e4 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/QuantUniverse.java @@ -0,0 +1,152 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * QuantUniverse + */ +@JsonPropertyOrder({ + QuantUniverse.JSON_PROPERTY_SOURCE +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class QuantUniverse implements Serializable { + private static final long serialVersionUID = 1L; + + /** + * Gets or Sets source + */ + public enum SourceEnum { + SCREENINGEXPRESSIONUNIVERSE("ScreeningExpressionUniverse"), + + UNIVERSALSCREENUNIVERSE("UniversalScreenUniverse"), + + IDENTIFIERUNIVERSE("IdentifierUniverse"); + + private String value; + + SourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static SourceEnum fromValue(String value) { + for (SourceEnum b : SourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_SOURCE = "source"; + private SourceEnum source; + + public QuantUniverse() { + } + + public QuantUniverse source(SourceEnum source) { + this.source = source; + return this; + } + + /** + * Get source + * @return source + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public SourceEnum getSource() { + return source; + } + + + @JsonProperty(JSON_PROPERTY_SOURCE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSource(SourceEnum source) { + this.source = source; + } + + + /** + * Return true if this QuantUniverse object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + QuantUniverse quantUniverse = (QuantUniverse) o; + return Objects.equals(this.source, quantUniverse.source); + } + + @Override + public int hashCode() { + return Objects.hash(source); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class QuantUniverse {\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ReturnType.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ReturnType.java new file mode 100644 index 00000000..a8296d0c --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/ReturnType.java @@ -0,0 +1,147 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * ReturnType + */ +@JsonPropertyOrder({ + ReturnType.JSON_PROPERTY_NAME, + ReturnType.JSON_PROPERTY_ID +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class ReturnType implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public ReturnType() { + } + + public ReturnType name(String name) { + this.name = name; + return this; + } + + /** + * Get name + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setName(String name) { + this.name = name; + } + + + public ReturnType id(String id) { + this.id = id; + return this; + } + + /** + * Get id + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setId(String id) { + this.id = id; + } + + + /** + * Return true if this ReturnType object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ReturnType returnType = (ReturnType) o; + return Objects.equals(this.name, returnType.name) && + Objects.equals(this.id, returnType.id); + } + + @Override + public int hashCode() { + return Objects.hash(name, id); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ReturnType {\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARAccounts.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARAccounts.java new file mode 100644 index 00000000..a76ba52b --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARAccounts.java @@ -0,0 +1,124 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.ReturnType; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * SPARAccounts + */ +@JsonPropertyOrder({ + SPARAccounts.JSON_PROPERTY_RETURNS_TYPE +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class SPARAccounts implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_RETURNS_TYPE = "returnsType"; + private java.util.List returnsType = null; + + public SPARAccounts() { + } + + public SPARAccounts returnsType(java.util.List returnsType) { + this.returnsType = returnsType; + return this; + } + + public SPARAccounts addReturnsTypeItem(ReturnType returnsTypeItem) { + if (this.returnsType == null) { + this.returnsType = new java.util.ArrayList(); + } + this.returnsType.add(returnsTypeItem); + return this; + } + + /** + * List of SPAR returnsType + * @return returnsType + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of SPAR returnsType") + @JsonProperty(JSON_PROPERTY_RETURNS_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getReturnsType() { + return returnsType; + } + + + @JsonProperty(JSON_PROPERTY_RETURNS_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setReturnsType(java.util.List returnsType) { + this.returnsType = returnsType; + } + + + /** + * Return true if this SPARAccounts object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SPARAccounts spARAccounts = (SPARAccounts) o; + return Objects.equals(this.returnsType, spARAccounts.returnsType); + } + + @Override + public int hashCode() { + return Objects.hash(returnsType); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SPARAccounts {\n"); + sb.append(" returnsType: ").append(toIndentedString(returnsType)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARAccountsRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARAccountsRoot.java new file mode 100644 index 00000000..6a2c7a39 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARAccountsRoot.java @@ -0,0 +1,171 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.SPARAccounts; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * SPARAccountsRoot + */ +@JsonPropertyOrder({ + SPARAccountsRoot.JSON_PROPERTY_DATA, + SPARAccountsRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class SPARAccountsRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private SPARAccounts data; + + public static final String JSON_PROPERTY_META = "meta"; + private JsonNullable meta = JsonNullable.of(null); + + public SPARAccountsRoot() { + } + + public SPARAccountsRoot data(SPARAccounts data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public SPARAccounts getData() { + return data; + } + + + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setData(SPARAccounts data) { + this.data = data; + } + + + public SPARAccountsRoot meta(Object meta) { + this.meta = JsonNullable.of(meta); + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public JsonNullable getMeta_JsonNullable() { + return meta; + } + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } + + public void setMeta(Object meta) { + this.meta = JsonNullable.of(meta); + } + + + /** + * Return true if this SPARAccountsRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SPARAccountsRoot spARAccountsRoot = (SPARAccountsRoot) o; + return Objects.equals(this.data, spARAccountsRoot.data) && + equalsNullable(this.meta, spARAccountsRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + } + + @Override + public int hashCode() { + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SPARAccountsRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARBenchmark.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARBenchmark.java index 5bb15e37..66ee7165 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARBenchmark.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARBenchmark.java @@ -51,6 +51,8 @@ public class SPARBenchmark implements Serializable { public static final String JSON_PROPERTY_IDENTIFIERS = "identifiers"; private java.util.List identifiers = null; + public SPARBenchmark() { + } public SPARBenchmark id(String id) { this.id = id; @@ -71,6 +73,8 @@ public String getId() { } + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { this.id = id; } @@ -95,6 +99,8 @@ public String getName() { } + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } @@ -127,6 +133,8 @@ public java.util.List getIdentifiers() { } + @JsonProperty(JSON_PROPERTY_IDENTIFIERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIdentifiers(java.util.List identifiers) { this.identifiers = identifiers; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARBenchmarkRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARBenchmarkRoot.java index 355af589..6693d547 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARBenchmarkRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARBenchmarkRoot.java @@ -25,6 +25,10 @@ import factset.analyticsapi.engines.models.SPARBenchmark; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; import java.io.Serializable; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import factset.analyticsapi.engines.JSON; @@ -45,8 +49,10 @@ public class SPARBenchmarkRoot implements Serializable { private SPARBenchmark data; public static final String JSON_PROPERTY_META = "meta"; - private Object meta; + private JsonNullable meta = JsonNullable.of(null); + public SPARBenchmarkRoot() { + } public SPARBenchmarkRoot data(SPARBenchmark data) { this.data = data; @@ -57,6 +63,7 @@ public SPARBenchmarkRoot data(SPARBenchmark data) { * Get data * @return data **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -66,13 +73,15 @@ public SPARBenchmark getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setData(SPARBenchmark data) { this.data = data; } public SPARBenchmarkRoot meta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); return this; } @@ -82,16 +91,26 @@ public SPARBenchmarkRoot meta(Object meta) { **/ @javax.annotation.Nullable @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + @JsonProperty(JSON_PROPERTY_META) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Object getMeta() { + public JsonNullable getMeta_JsonNullable() { return meta; } - + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } public void setMeta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); } @@ -108,12 +127,23 @@ public boolean equals(Object o) { } SPARBenchmarkRoot spARBenchmarkRoot = (SPARBenchmarkRoot) o; return Objects.equals(this.data, spARBenchmarkRoot.data) && - Objects.equals(this.meta, spARBenchmarkRoot.meta); + equalsNullable(this.meta, spARBenchmarkRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); } @Override public int hashCode() { - return Objects.hash(data, meta); + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; } @Override diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARCalculationParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARCalculationParameters.java index 99851e7a..27317ca1 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARCalculationParameters.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARCalculationParameters.java @@ -60,6 +60,8 @@ public class SPARCalculationParameters implements Serializable { public static final String JSON_PROPERTY_CURRENCYISOCODE = "currencyisocode"; private String currencyisocode; + public SPARCalculationParameters() { + } public SPARCalculationParameters componentid(String componentid) { this.componentid = componentid; @@ -70,6 +72,7 @@ public SPARCalculationParameters componentid(String componentid) { * The SPAR Engine component identifier to analyze. * @return componentid **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "The SPAR Engine component identifier to analyze.") @JsonProperty(JSON_PROPERTY_COMPONENTID) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -79,6 +82,8 @@ public String getComponentid() { } + @JsonProperty(JSON_PROPERTY_COMPONENTID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setComponentid(String componentid) { this.componentid = componentid; } @@ -111,6 +116,8 @@ public java.util.List getAccounts() { } + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccounts(java.util.List accounts) { this.accounts = accounts; } @@ -135,6 +142,8 @@ public SPARIdentifier getBenchmark() { } + @JsonProperty(JSON_PROPERTY_BENCHMARK) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBenchmark(SPARIdentifier benchmark) { this.benchmark = benchmark; } @@ -159,6 +168,8 @@ public SPARDateParameters getDates() { } + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDates(SPARDateParameters dates) { this.dates = dates; } @@ -183,6 +194,8 @@ public String getCurrencyisocode() { } + @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrencyisocode(String currencyisocode) { this.currencyisocode = currencyisocode; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARCalculationParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARCalculationParametersRoot.java index 809b039c..85d4e69d 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARCalculationParametersRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARCalculationParametersRoot.java @@ -48,6 +48,8 @@ public class SPARCalculationParametersRoot implements Serializable { public static final String JSON_PROPERTY_META = "meta"; private CalculationMeta meta; + public SPARCalculationParametersRoot() { + } public SPARCalculationParametersRoot data(java.util.Map data) { this.data = data; @@ -76,6 +78,8 @@ public java.util.Map getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(java.util.Map data) { this.data = data; } @@ -100,6 +104,8 @@ public CalculationMeta getMeta() { } + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMeta(CalculationMeta meta) { this.meta = meta; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARDateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARDateParameters.java index 74957389..93603f56 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARDateParameters.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARDateParameters.java @@ -51,6 +51,8 @@ public class SPARDateParameters implements Serializable { public static final String JSON_PROPERTY_FREQUENCY = "frequency"; private String frequency; + public SPARDateParameters() { + } public SPARDateParameters startdate(String startdate) { this.startdate = startdate; @@ -61,6 +63,7 @@ public SPARDateParameters startdate(String startdate) { * Calculation's start date. * @return startdate **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "Calculation's start date.") @JsonProperty(JSON_PROPERTY_STARTDATE) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -70,6 +73,8 @@ public String getStartdate() { } + @JsonProperty(JSON_PROPERTY_STARTDATE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setStartdate(String startdate) { this.startdate = startdate; } @@ -84,6 +89,7 @@ public SPARDateParameters enddate(String enddate) { * Calculation's end date. * @return enddate **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "Calculation's end date.") @JsonProperty(JSON_PROPERTY_ENDDATE) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -93,6 +99,8 @@ public String getEnddate() { } + @JsonProperty(JSON_PROPERTY_ENDDATE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setEnddate(String enddate) { this.enddate = enddate; } @@ -107,6 +115,7 @@ public SPARDateParameters frequency(String frequency) { * Calculation's frequency. * @return frequency **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "Calculation's frequency.") @JsonProperty(JSON_PROPERTY_FREQUENCY) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -116,6 +125,8 @@ public String getFrequency() { } + @JsonProperty(JSON_PROPERTY_FREQUENCY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFrequency(String frequency) { this.frequency = frequency; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARIdentifier.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARIdentifier.java index 7b4253dc..1f154aca 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARIdentifier.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/SPARIdentifier.java @@ -51,6 +51,8 @@ public class SPARIdentifier implements Serializable { public static final String JSON_PROPERTY_PREFIX = "prefix"; private String prefix; + public SPARIdentifier() { + } public SPARIdentifier id(String id) { this.id = id; @@ -61,6 +63,7 @@ public SPARIdentifier id(String id) { * User's FactSet account OR benchmark id. * @return id **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "User's FactSet account OR benchmark id.") @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -70,6 +73,8 @@ public String getId() { } + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setId(String id) { this.id = id; } @@ -94,6 +99,8 @@ public String getReturntype() { } + @JsonProperty(JSON_PROPERTY_RETURNTYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReturntype(String returntype) { this.returntype = returntype; } @@ -118,6 +125,8 @@ public String getPrefix() { } + @JsonProperty(JSON_PROPERTY_PREFIX) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrefix(String prefix) { this.prefix = prefix; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplateContentTypes.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplateContentTypes.java new file mode 100644 index 00000000..e446d6bb --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplateContentTypes.java @@ -0,0 +1,203 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplateContentTypes + */ +@JsonPropertyOrder({ + TemplateContentTypes.JSON_PROPERTY_MANDATORY, + TemplateContentTypes.JSON_PROPERTY_OPTIONAL, + TemplateContentTypes.JSON_PROPERTY_LOCKED +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplateContentTypes implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_MANDATORY = "mandatory"; + private java.util.List mandatory = null; + + public static final String JSON_PROPERTY_OPTIONAL = "optional"; + private java.util.List optional = null; + + public static final String JSON_PROPERTY_LOCKED = "locked"; + private java.util.List locked = null; + + public TemplateContentTypes() { + } + + public TemplateContentTypes mandatory(java.util.List mandatory) { + this.mandatory = mandatory; + return this; + } + + public TemplateContentTypes addMandatoryItem(String mandatoryItem) { + if (this.mandatory == null) { + this.mandatory = new java.util.ArrayList(); + } + this.mandatory.add(mandatoryItem); + return this; + } + + /** + * Template mandatory fields + * @return mandatory + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template mandatory fields") + @JsonProperty(JSON_PROPERTY_MANDATORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getMandatory() { + return mandatory; + } + + + @JsonProperty(JSON_PROPERTY_MANDATORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setMandatory(java.util.List mandatory) { + this.mandatory = mandatory; + } + + + public TemplateContentTypes optional(java.util.List optional) { + this.optional = optional; + return this; + } + + public TemplateContentTypes addOptionalItem(String optionalItem) { + if (this.optional == null) { + this.optional = new java.util.ArrayList(); + } + this.optional.add(optionalItem); + return this; + } + + /** + * Template optional fields + * @return optional + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template optional fields") + @JsonProperty(JSON_PROPERTY_OPTIONAL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getOptional() { + return optional; + } + + + @JsonProperty(JSON_PROPERTY_OPTIONAL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setOptional(java.util.List optional) { + this.optional = optional; + } + + + public TemplateContentTypes locked(java.util.List locked) { + this.locked = locked; + return this; + } + + public TemplateContentTypes addLockedItem(String lockedItem) { + if (this.locked == null) { + this.locked = new java.util.ArrayList(); + } + this.locked.add(lockedItem); + return this; + } + + /** + * Template locked fields + * @return locked + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template locked fields") + @JsonProperty(JSON_PROPERTY_LOCKED) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getLocked() { + return locked; + } + + + @JsonProperty(JSON_PROPERTY_LOCKED) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setLocked(java.util.List locked) { + this.locked = locked; + } + + + /** + * Return true if this TemplateContentTypes object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplateContentTypes templateContentTypes = (TemplateContentTypes) o; + return Objects.equals(this.mandatory, templateContentTypes.mandatory) && + Objects.equals(this.optional, templateContentTypes.optional) && + Objects.equals(this.locked, templateContentTypes.locked); + } + + @Override + public int hashCode() { + return Objects.hash(mandatory, optional, locked); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplateContentTypes {\n"); + sb.append(" mandatory: ").append(toIndentedString(mandatory)).append("\n"); + sb.append(" optional: ").append(toIndentedString(optional)).append("\n"); + sb.append(" locked: ").append(toIndentedString(locked)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponent.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponent.java new file mode 100644 index 00000000..b32631c2 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponent.java @@ -0,0 +1,340 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PAComponentData; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplatedPAComponent + */ +@JsonPropertyOrder({ + TemplatedPAComponent.JSON_PROPERTY_ID, + TemplatedPAComponent.JSON_PROPERTY_DIRECTORY, + TemplatedPAComponent.JSON_PROPERTY_SNAPSHOT, + TemplatedPAComponent.JSON_PROPERTY_COMPONENT_DATA, + TemplatedPAComponent.JSON_PROPERTY_DESCRIPTION, + TemplatedPAComponent.JSON_PROPERTY_NAME, + TemplatedPAComponent.JSON_PROPERTY_PARENT_TEMPLATE_ID, + TemplatedPAComponent.JSON_PROPERTY_TYPE +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPAComponent implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_DIRECTORY = "directory"; + private String directory; + + public static final String JSON_PROPERTY_SNAPSHOT = "snapshot"; + private Boolean snapshot; + + public static final String JSON_PROPERTY_COMPONENT_DATA = "componentData"; + private PAComponentData componentData; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_PARENT_TEMPLATE_ID = "parentTemplateId"; + private String parentTemplateId; + + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; + + public TemplatedPAComponent() { + } + + public TemplatedPAComponent id(String id) { + this.id = id; + return this; + } + + /** + * Get id + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setId(String id) { + this.id = id; + } + + + public TemplatedPAComponent directory(String directory) { + this.directory = directory; + return this; + } + + /** + * Get directory + * @return directory + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDirectory() { + return directory; + } + + + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDirectory(String directory) { + this.directory = directory; + } + + + public TemplatedPAComponent snapshot(Boolean snapshot) { + this.snapshot = snapshot; + return this; + } + + /** + * Get snapshot + * @return snapshot + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_SNAPSHOT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getSnapshot() { + return snapshot; + } + + + @JsonProperty(JSON_PROPERTY_SNAPSHOT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSnapshot(Boolean snapshot) { + this.snapshot = snapshot; + } + + + public TemplatedPAComponent componentData(PAComponentData componentData) { + this.componentData = componentData; + return this; + } + + /** + * Get componentData + * @return componentData + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_COMPONENT_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PAComponentData getComponentData() { + return componentData; + } + + + @JsonProperty(JSON_PROPERTY_COMPONENT_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setComponentData(PAComponentData componentData) { + this.componentData = componentData; + } + + + public TemplatedPAComponent description(String description) { + this.description = description; + return this; + } + + /** + * Get description + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDescription(String description) { + this.description = description; + } + + + public TemplatedPAComponent name(String name) { + this.name = name; + return this; + } + + /** + * Get name + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setName(String name) { + this.name = name; + } + + + public TemplatedPAComponent parentTemplateId(String parentTemplateId) { + this.parentTemplateId = parentTemplateId; + return this; + } + + /** + * Get parentTemplateId + * @return parentTemplateId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_PARENT_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getParentTemplateId() { + return parentTemplateId; + } + + + @JsonProperty(JSON_PROPERTY_PARENT_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setParentTemplateId(String parentTemplateId) { + this.parentTemplateId = parentTemplateId; + } + + + public TemplatedPAComponent type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * @return type + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getType() { + return type; + } + + + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setType(String type) { + this.type = type; + } + + + /** + * Return true if this TemplatedPAComponent object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplatedPAComponent templatedPAComponent = (TemplatedPAComponent) o; + return Objects.equals(this.id, templatedPAComponent.id) && + Objects.equals(this.directory, templatedPAComponent.directory) && + Objects.equals(this.snapshot, templatedPAComponent.snapshot) && + Objects.equals(this.componentData, templatedPAComponent.componentData) && + Objects.equals(this.description, templatedPAComponent.description) && + Objects.equals(this.name, templatedPAComponent.name) && + Objects.equals(this.parentTemplateId, templatedPAComponent.parentTemplateId) && + Objects.equals(this.type, templatedPAComponent.type); + } + + @Override + public int hashCode() { + return Objects.hash(id, directory, snapshot, componentData, description, name, parentTemplateId, type); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplatedPAComponent {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); + sb.append(" snapshot: ").append(toIndentedString(snapshot)).append("\n"); + sb.append(" componentData: ").append(toIndentedString(componentData)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" parentTemplateId: ").append(toIndentedString(parentTemplateId)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParameters.java new file mode 100644 index 00000000..7d15644d --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParameters.java @@ -0,0 +1,212 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PAComponentData; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplatedPAComponentParameters + */ +@JsonPropertyOrder({ + TemplatedPAComponentParameters.JSON_PROPERTY_DIRECTORY, + TemplatedPAComponentParameters.JSON_PROPERTY_PARENT_TEMPLATE_ID, + TemplatedPAComponentParameters.JSON_PROPERTY_DESCRIPTION, + TemplatedPAComponentParameters.JSON_PROPERTY_COMPONENT_DATA +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPAComponentParameters implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DIRECTORY = "directory"; + private String directory; + + public static final String JSON_PROPERTY_PARENT_TEMPLATE_ID = "parentTemplateId"; + private String parentTemplateId; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_COMPONENT_DATA = "componentData"; + private PAComponentData componentData; + + public TemplatedPAComponentParameters() { + } + + public TemplatedPAComponentParameters directory(String directory) { + this.directory = directory; + return this; + } + + /** + * Directory to create templated components + * @return directory + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "Directory to create templated components") + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getDirectory() { + return directory; + } + + + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setDirectory(String directory) { + this.directory = directory; + } + + + public TemplatedPAComponentParameters parentTemplateId(String parentTemplateId) { + this.parentTemplateId = parentTemplateId; + return this; + } + + /** + * Parent template id + * @return parentTemplateId + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "Parent template id") + @JsonProperty(JSON_PROPERTY_PARENT_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getParentTemplateId() { + return parentTemplateId; + } + + + @JsonProperty(JSON_PROPERTY_PARENT_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setParentTemplateId(String parentTemplateId) { + this.parentTemplateId = parentTemplateId; + } + + + public TemplatedPAComponentParameters description(String description) { + this.description = description; + return this; + } + + /** + * Component description. + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Component description.") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDescription(String description) { + this.description = description; + } + + + public TemplatedPAComponentParameters componentData(PAComponentData componentData) { + this.componentData = componentData; + return this; + } + + /** + * Get componentData + * @return componentData + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_COMPONENT_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PAComponentData getComponentData() { + return componentData; + } + + + @JsonProperty(JSON_PROPERTY_COMPONENT_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setComponentData(PAComponentData componentData) { + this.componentData = componentData; + } + + + /** + * Return true if this TemplatedPAComponentParameters object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplatedPAComponentParameters templatedPAComponentParameters = (TemplatedPAComponentParameters) o; + return Objects.equals(this.directory, templatedPAComponentParameters.directory) && + Objects.equals(this.parentTemplateId, templatedPAComponentParameters.parentTemplateId) && + Objects.equals(this.description, templatedPAComponentParameters.description) && + Objects.equals(this.componentData, templatedPAComponentParameters.componentData); + } + + @Override + public int hashCode() { + return Objects.hash(directory, parentTemplateId, description, componentData); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplatedPAComponentParameters {\n"); + sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); + sb.append(" parentTemplateId: ").append(toIndentedString(parentTemplateId)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" componentData: ").append(toIndentedString(componentData)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParametersRoot.java new file mode 100644 index 00000000..c0fb0430 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParametersRoot.java @@ -0,0 +1,171 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.TemplatedPAComponentParameters; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplatedPAComponentParametersRoot + */ +@JsonPropertyOrder({ + TemplatedPAComponentParametersRoot.JSON_PROPERTY_DATA, + TemplatedPAComponentParametersRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPAComponentParametersRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private TemplatedPAComponentParameters data; + + public static final String JSON_PROPERTY_META = "meta"; + private JsonNullable meta = JsonNullable.of(null); + + public TemplatedPAComponentParametersRoot() { + } + + public TemplatedPAComponentParametersRoot data(TemplatedPAComponentParameters data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public TemplatedPAComponentParameters getData() { + return data; + } + + + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setData(TemplatedPAComponentParameters data) { + this.data = data; + } + + + public TemplatedPAComponentParametersRoot meta(Object meta) { + this.meta = JsonNullable.of(meta); + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public JsonNullable getMeta_JsonNullable() { + return meta; + } + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } + + public void setMeta(Object meta) { + this.meta = JsonNullable.of(meta); + } + + + /** + * Return true if this TemplatedPAComponentParametersRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplatedPAComponentParametersRoot templatedPAComponentParametersRoot = (TemplatedPAComponentParametersRoot) o; + return Objects.equals(this.data, templatedPAComponentParametersRoot.data) && + equalsNullable(this.meta, templatedPAComponentParametersRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + } + + @Override + public int hashCode() { + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplatedPAComponentParametersRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummary.java new file mode 100644 index 00000000..76a970c2 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummary.java @@ -0,0 +1,243 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplatedPAComponentPostSummary + */ +@JsonPropertyOrder({ + TemplatedPAComponentPostSummary.JSON_PROPERTY_ID, + TemplatedPAComponentPostSummary.JSON_PROPERTY_DESCRIPTION, + TemplatedPAComponentPostSummary.JSON_PROPERTY_NAME, + TemplatedPAComponentPostSummary.JSON_PROPERTY_PARENT_TEMPLATE_ID, + TemplatedPAComponentPostSummary.JSON_PROPERTY_TYPE +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPAComponentPostSummary implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_PARENT_TEMPLATE_ID = "parentTemplateId"; + private String parentTemplateId; + + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; + + public TemplatedPAComponentPostSummary() { + } + + public TemplatedPAComponentPostSummary id(String id) { + this.id = id; + return this; + } + + /** + * Get id + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setId(String id) { + this.id = id; + } + + + public TemplatedPAComponentPostSummary description(String description) { + this.description = description; + return this; + } + + /** + * Get description + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDescription(String description) { + this.description = description; + } + + + public TemplatedPAComponentPostSummary name(String name) { + this.name = name; + return this; + } + + /** + * Get name + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setName(String name) { + this.name = name; + } + + + public TemplatedPAComponentPostSummary parentTemplateId(String parentTemplateId) { + this.parentTemplateId = parentTemplateId; + return this; + } + + /** + * Get parentTemplateId + * @return parentTemplateId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_PARENT_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getParentTemplateId() { + return parentTemplateId; + } + + + @JsonProperty(JSON_PROPERTY_PARENT_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setParentTemplateId(String parentTemplateId) { + this.parentTemplateId = parentTemplateId; + } + + + public TemplatedPAComponentPostSummary type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * @return type + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getType() { + return type; + } + + + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setType(String type) { + this.type = type; + } + + + /** + * Return true if this TemplatedPAComponentPostSummary object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplatedPAComponentPostSummary templatedPAComponentPostSummary = (TemplatedPAComponentPostSummary) o; + return Objects.equals(this.id, templatedPAComponentPostSummary.id) && + Objects.equals(this.description, templatedPAComponentPostSummary.description) && + Objects.equals(this.name, templatedPAComponentPostSummary.name) && + Objects.equals(this.parentTemplateId, templatedPAComponentPostSummary.parentTemplateId) && + Objects.equals(this.type, templatedPAComponentPostSummary.type); + } + + @Override + public int hashCode() { + return Objects.hash(id, description, name, parentTemplateId, type); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplatedPAComponentPostSummary {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" parentTemplateId: ").append(toIndentedString(parentTemplateId)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummaryRoot.java new file mode 100644 index 00000000..4286aad5 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentPostSummaryRoot.java @@ -0,0 +1,171 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.TemplatedPAComponentPostSummary; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplatedPAComponentPostSummaryRoot + */ +@JsonPropertyOrder({ + TemplatedPAComponentPostSummaryRoot.JSON_PROPERTY_DATA, + TemplatedPAComponentPostSummaryRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPAComponentPostSummaryRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private TemplatedPAComponentPostSummary data; + + public static final String JSON_PROPERTY_META = "meta"; + private JsonNullable meta = JsonNullable.of(null); + + public TemplatedPAComponentPostSummaryRoot() { + } + + public TemplatedPAComponentPostSummaryRoot data(TemplatedPAComponentPostSummary data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public TemplatedPAComponentPostSummary getData() { + return data; + } + + + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setData(TemplatedPAComponentPostSummary data) { + this.data = data; + } + + + public TemplatedPAComponentPostSummaryRoot meta(Object meta) { + this.meta = JsonNullable.of(meta); + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public JsonNullable getMeta_JsonNullable() { + return meta; + } + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } + + public void setMeta(Object meta) { + this.meta = JsonNullable.of(meta); + } + + + /** + * Return true if this TemplatedPAComponentPostSummaryRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplatedPAComponentPostSummaryRoot templatedPAComponentPostSummaryRoot = (TemplatedPAComponentPostSummaryRoot) o; + return Objects.equals(this.data, templatedPAComponentPostSummaryRoot.data) && + equalsNullable(this.meta, templatedPAComponentPostSummaryRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + } + + @Override + public int hashCode() { + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplatedPAComponentPostSummaryRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentRoot.java new file mode 100644 index 00000000..982d62af --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentRoot.java @@ -0,0 +1,171 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.TemplatedPAComponent; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplatedPAComponentRoot + */ +@JsonPropertyOrder({ + TemplatedPAComponentRoot.JSON_PROPERTY_DATA, + TemplatedPAComponentRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPAComponentRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private TemplatedPAComponent data; + + public static final String JSON_PROPERTY_META = "meta"; + private JsonNullable meta = JsonNullable.of(null); + + public TemplatedPAComponentRoot() { + } + + public TemplatedPAComponentRoot data(TemplatedPAComponent data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public TemplatedPAComponent getData() { + return data; + } + + + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setData(TemplatedPAComponent data) { + this.data = data; + } + + + public TemplatedPAComponentRoot meta(Object meta) { + this.meta = JsonNullable.of(meta); + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public JsonNullable getMeta_JsonNullable() { + return meta; + } + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } + + public void setMeta(Object meta) { + this.meta = JsonNullable.of(meta); + } + + + /** + * Return true if this TemplatedPAComponentRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplatedPAComponentRoot templatedPAComponentRoot = (TemplatedPAComponentRoot) o; + return Objects.equals(this.data, templatedPAComponentRoot.data) && + equalsNullable(this.meta, templatedPAComponentRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + } + + @Override + public int hashCode() { + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplatedPAComponentRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummary.java new file mode 100644 index 00000000..d773a4d3 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummary.java @@ -0,0 +1,211 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplatedPAComponentSummary + */ +@JsonPropertyOrder({ + TemplatedPAComponentSummary.JSON_PROPERTY_DESCRIPTION, + TemplatedPAComponentSummary.JSON_PROPERTY_NAME, + TemplatedPAComponentSummary.JSON_PROPERTY_PARENT_TEMPLATE_ID, + TemplatedPAComponentSummary.JSON_PROPERTY_TYPE +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPAComponentSummary implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_PARENT_TEMPLATE_ID = "parentTemplateId"; + private String parentTemplateId; + + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; + + public TemplatedPAComponentSummary() { + } + + public TemplatedPAComponentSummary description(String description) { + this.description = description; + return this; + } + + /** + * Get description + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDescription(String description) { + this.description = description; + } + + + public TemplatedPAComponentSummary name(String name) { + this.name = name; + return this; + } + + /** + * Get name + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setName(String name) { + this.name = name; + } + + + public TemplatedPAComponentSummary parentTemplateId(String parentTemplateId) { + this.parentTemplateId = parentTemplateId; + return this; + } + + /** + * Get parentTemplateId + * @return parentTemplateId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_PARENT_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getParentTemplateId() { + return parentTemplateId; + } + + + @JsonProperty(JSON_PROPERTY_PARENT_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setParentTemplateId(String parentTemplateId) { + this.parentTemplateId = parentTemplateId; + } + + + public TemplatedPAComponentSummary type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * @return type + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getType() { + return type; + } + + + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setType(String type) { + this.type = type; + } + + + /** + * Return true if this TemplatedPAComponentSummary object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplatedPAComponentSummary templatedPAComponentSummary = (TemplatedPAComponentSummary) o; + return Objects.equals(this.description, templatedPAComponentSummary.description) && + Objects.equals(this.name, templatedPAComponentSummary.name) && + Objects.equals(this.parentTemplateId, templatedPAComponentSummary.parentTemplateId) && + Objects.equals(this.type, templatedPAComponentSummary.type); + } + + @Override + public int hashCode() { + return Objects.hash(description, name, parentTemplateId, type); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplatedPAComponentSummary {\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" parentTemplateId: ").append(toIndentedString(parentTemplateId)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummaryRoot.java new file mode 100644 index 00000000..80bf4d34 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentSummaryRoot.java @@ -0,0 +1,176 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.TemplatedPAComponentSummary; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplatedPAComponentSummaryRoot + */ +@JsonPropertyOrder({ + TemplatedPAComponentSummaryRoot.JSON_PROPERTY_DATA, + TemplatedPAComponentSummaryRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPAComponentSummaryRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private java.util.Map data = new java.util.HashMap(); + + public static final String JSON_PROPERTY_META = "meta"; + private JsonNullable meta = JsonNullable.of(null); + + public TemplatedPAComponentSummaryRoot() { + } + + public TemplatedPAComponentSummaryRoot data(java.util.Map data) { + this.data = data; + return this; + } + + public TemplatedPAComponentSummaryRoot putDataItem(String key, TemplatedPAComponentSummary dataItem) { + this.data.put(key, dataItem); + return this; + } + + /** + * Get data + * @return data + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public java.util.Map getData() { + return data; + } + + + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setData(java.util.Map data) { + this.data = data; + } + + + public TemplatedPAComponentSummaryRoot meta(Object meta) { + this.meta = JsonNullable.of(meta); + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public JsonNullable getMeta_JsonNullable() { + return meta; + } + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } + + public void setMeta(Object meta) { + this.meta = JsonNullable.of(meta); + } + + + /** + * Return true if this TemplatedPAComponentSummaryRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplatedPAComponentSummaryRoot templatedPAComponentSummaryRoot = (TemplatedPAComponentSummaryRoot) o; + return Objects.equals(this.data, templatedPAComponentSummaryRoot.data) && + equalsNullable(this.meta, templatedPAComponentSummaryRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + } + + @Override + public int hashCode() { + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplatedPAComponentSummaryRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParameters.java new file mode 100644 index 00000000..69c91944 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParameters.java @@ -0,0 +1,180 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PAComponentData; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplatedPAComponentUpdateParameters + */ +@JsonPropertyOrder({ + TemplatedPAComponentUpdateParameters.JSON_PROPERTY_PARENT_TEMPLATE_ID, + TemplatedPAComponentUpdateParameters.JSON_PROPERTY_DESCRIPTION, + TemplatedPAComponentUpdateParameters.JSON_PROPERTY_COMPONENT_DATA +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPAComponentUpdateParameters implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_PARENT_TEMPLATE_ID = "parentTemplateId"; + private String parentTemplateId; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_COMPONENT_DATA = "componentData"; + private PAComponentData componentData; + + public TemplatedPAComponentUpdateParameters() { + } + + public TemplatedPAComponentUpdateParameters parentTemplateId(String parentTemplateId) { + this.parentTemplateId = parentTemplateId; + return this; + } + + /** + * Parent template id + * @return parentTemplateId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Parent template id") + @JsonProperty(JSON_PROPERTY_PARENT_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getParentTemplateId() { + return parentTemplateId; + } + + + @JsonProperty(JSON_PROPERTY_PARENT_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setParentTemplateId(String parentTemplateId) { + this.parentTemplateId = parentTemplateId; + } + + + public TemplatedPAComponentUpdateParameters description(String description) { + this.description = description; + return this; + } + + /** + * Component description. + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Component description.") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDescription(String description) { + this.description = description; + } + + + public TemplatedPAComponentUpdateParameters componentData(PAComponentData componentData) { + this.componentData = componentData; + return this; + } + + /** + * Get componentData + * @return componentData + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_COMPONENT_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PAComponentData getComponentData() { + return componentData; + } + + + @JsonProperty(JSON_PROPERTY_COMPONENT_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setComponentData(PAComponentData componentData) { + this.componentData = componentData; + } + + + /** + * Return true if this TemplatedPAComponentUpdateParameters object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplatedPAComponentUpdateParameters templatedPAComponentUpdateParameters = (TemplatedPAComponentUpdateParameters) o; + return Objects.equals(this.parentTemplateId, templatedPAComponentUpdateParameters.parentTemplateId) && + Objects.equals(this.description, templatedPAComponentUpdateParameters.description) && + Objects.equals(this.componentData, templatedPAComponentUpdateParameters.componentData); + } + + @Override + public int hashCode() { + return Objects.hash(parentTemplateId, description, componentData); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplatedPAComponentUpdateParameters {\n"); + sb.append(" parentTemplateId: ").append(toIndentedString(parentTemplateId)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" componentData: ").append(toIndentedString(componentData)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParametersRoot.java new file mode 100644 index 00000000..404f5dc1 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentUpdateParametersRoot.java @@ -0,0 +1,171 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.TemplatedPAComponentUpdateParameters; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * TemplatedPAComponentUpdateParametersRoot + */ +@JsonPropertyOrder({ + TemplatedPAComponentUpdateParametersRoot.JSON_PROPERTY_DATA, + TemplatedPAComponentUpdateParametersRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class TemplatedPAComponentUpdateParametersRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private TemplatedPAComponentUpdateParameters data; + + public static final String JSON_PROPERTY_META = "meta"; + private JsonNullable meta = JsonNullable.of(null); + + public TemplatedPAComponentUpdateParametersRoot() { + } + + public TemplatedPAComponentUpdateParametersRoot data(TemplatedPAComponentUpdateParameters data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public TemplatedPAComponentUpdateParameters getData() { + return data; + } + + + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setData(TemplatedPAComponentUpdateParameters data) { + this.data = data; + } + + + public TemplatedPAComponentUpdateParametersRoot meta(Object meta) { + this.meta = JsonNullable.of(meta); + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public JsonNullable getMeta_JsonNullable() { + return meta; + } + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } + + public void setMeta(Object meta) { + this.meta = JsonNullable.of(meta); + } + + + /** + * Return true if this TemplatedPAComponentUpdateParametersRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TemplatedPAComponentUpdateParametersRoot templatedPAComponentUpdateParametersRoot = (TemplatedPAComponentUpdateParametersRoot) o; + return Objects.equals(this.data, templatedPAComponentUpdateParametersRoot.data) && + equalsNullable(this.meta, templatedPAComponentUpdateParametersRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + } + + @Override + public int hashCode() { + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TemplatedPAComponentUpdateParametersRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplate.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplate.java new file mode 100644 index 00000000..98eeca44 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplate.java @@ -0,0 +1,600 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PACalculationColumn; +import factset.analyticsapi.engines.models.PACalculationGroup; +import factset.analyticsapi.engines.models.PADateParameters; +import factset.analyticsapi.engines.models.PAIdentifier; +import factset.analyticsapi.engines.models.TemplateContentTypes; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplate + */ +@JsonPropertyOrder({ + UnlinkedPATemplate.JSON_PROPERTY_ID, + UnlinkedPATemplate.JSON_PROPERTY_DIRECTORY, + UnlinkedPATemplate.JSON_PROPERTY_TEMPLATE_TYPE_ID, + UnlinkedPATemplate.JSON_PROPERTY_SNAPSHOT, + UnlinkedPATemplate.JSON_PROPERTY_ACCOUNTS, + UnlinkedPATemplate.JSON_PROPERTY_BENCHMARKS, + UnlinkedPATemplate.JSON_PROPERTY_COLUMNS, + UnlinkedPATemplate.JSON_PROPERTY_DATES, + UnlinkedPATemplate.JSON_PROPERTY_GROUPS, + UnlinkedPATemplate.JSON_PROPERTY_CURRENCYISOCODE, + UnlinkedPATemplate.JSON_PROPERTY_COMPONENTDETAIL, + UnlinkedPATemplate.JSON_PROPERTY_CONTENT, + UnlinkedPATemplate.JSON_PROPERTY_DESCRIPTION, + UnlinkedPATemplate.JSON_PROPERTY_NAME, + UnlinkedPATemplate.JSON_PROPERTY_CATEGORY +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplate implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_DIRECTORY = "directory"; + private String directory; + + public static final String JSON_PROPERTY_TEMPLATE_TYPE_ID = "templateTypeId"; + private String templateTypeId; + + public static final String JSON_PROPERTY_SNAPSHOT = "snapshot"; + private Boolean snapshot; + + public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; + private java.util.List accounts = null; + + public static final String JSON_PROPERTY_BENCHMARKS = "benchmarks"; + private java.util.List benchmarks = null; + + public static final String JSON_PROPERTY_COLUMNS = "columns"; + private java.util.List columns = null; + + public static final String JSON_PROPERTY_DATES = "dates"; + private PADateParameters dates; + + public static final String JSON_PROPERTY_GROUPS = "groups"; + private java.util.List groups = null; + + public static final String JSON_PROPERTY_CURRENCYISOCODE = "currencyisocode"; + private String currencyisocode; + + public static final String JSON_PROPERTY_COMPONENTDETAIL = "componentdetail"; + private String componentdetail; + + public static final String JSON_PROPERTY_CONTENT = "content"; + private TemplateContentTypes content; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_CATEGORY = "category"; + private String category; + + public UnlinkedPATemplate() { + } + + public UnlinkedPATemplate id(String id) { + this.id = id; + return this; + } + + /** + * Template id. + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template id.") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setId(String id) { + this.id = id; + } + + + public UnlinkedPATemplate directory(String directory) { + this.directory = directory; + return this; + } + + /** + * Template directory. + * @return directory + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template directory.") + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDirectory() { + return directory; + } + + + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDirectory(String directory) { + this.directory = directory; + } + + + public UnlinkedPATemplate templateTypeId(String templateTypeId) { + this.templateTypeId = templateTypeId; + return this; + } + + /** + * Template type id + * @return templateTypeId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template type id") + @JsonProperty(JSON_PROPERTY_TEMPLATE_TYPE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getTemplateTypeId() { + return templateTypeId; + } + + + @JsonProperty(JSON_PROPERTY_TEMPLATE_TYPE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTemplateTypeId(String templateTypeId) { + this.templateTypeId = templateTypeId; + } + + + public UnlinkedPATemplate snapshot(Boolean snapshot) { + this.snapshot = snapshot; + return this; + } + + /** + * snapshot. + * @return snapshot + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "snapshot.") + @JsonProperty(JSON_PROPERTY_SNAPSHOT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getSnapshot() { + return snapshot; + } + + + @JsonProperty(JSON_PROPERTY_SNAPSHOT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSnapshot(Boolean snapshot) { + this.snapshot = snapshot; + } + + + public UnlinkedPATemplate accounts(java.util.List accounts) { + this.accounts = accounts; + return this; + } + + public UnlinkedPATemplate addAccountsItem(PAIdentifier accountsItem) { + if (this.accounts == null) { + this.accounts = new java.util.ArrayList(); + } + this.accounts.add(accountsItem); + return this; + } + + /** + * List of accounts + * @return accounts + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of accounts") + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getAccounts() { + return accounts; + } + + + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAccounts(java.util.List accounts) { + this.accounts = accounts; + } + + + public UnlinkedPATemplate benchmarks(java.util.List benchmarks) { + this.benchmarks = benchmarks; + return this; + } + + public UnlinkedPATemplate addBenchmarksItem(PAIdentifier benchmarksItem) { + if (this.benchmarks == null) { + this.benchmarks = new java.util.ArrayList(); + } + this.benchmarks.add(benchmarksItem); + return this; + } + + /** + * List of benchmarks + * @return benchmarks + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of benchmarks") + @JsonProperty(JSON_PROPERTY_BENCHMARKS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getBenchmarks() { + return benchmarks; + } + + + @JsonProperty(JSON_PROPERTY_BENCHMARKS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setBenchmarks(java.util.List benchmarks) { + this.benchmarks = benchmarks; + } + + + public UnlinkedPATemplate columns(java.util.List columns) { + this.columns = columns; + return this; + } + + public UnlinkedPATemplate addColumnsItem(PACalculationColumn columnsItem) { + if (this.columns == null) { + this.columns = new java.util.ArrayList(); + } + this.columns.add(columnsItem); + return this; + } + + /** + * List of columns for the PA calculation + * @return columns + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of columns for the PA calculation") + @JsonProperty(JSON_PROPERTY_COLUMNS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getColumns() { + return columns; + } + + + @JsonProperty(JSON_PROPERTY_COLUMNS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setColumns(java.util.List columns) { + this.columns = columns; + } + + + public UnlinkedPATemplate dates(PADateParameters dates) { + this.dates = dates; + return this; + } + + /** + * Get dates + * @return dates + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PADateParameters getDates() { + return dates; + } + + + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDates(PADateParameters dates) { + this.dates = dates; + } + + + public UnlinkedPATemplate groups(java.util.List groups) { + this.groups = groups; + return this; + } + + public UnlinkedPATemplate addGroupsItem(PACalculationGroup groupsItem) { + if (this.groups == null) { + this.groups = new java.util.ArrayList(); + } + this.groups.add(groupsItem); + return this; + } + + /** + * List of groupings for the PA calculation + * @return groups + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of groupings for the PA calculation") + @JsonProperty(JSON_PROPERTY_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getGroups() { + return groups; + } + + + @JsonProperty(JSON_PROPERTY_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroups(java.util.List groups) { + this.groups = groups; + } + + + public UnlinkedPATemplate currencyisocode(String currencyisocode) { + this.currencyisocode = currencyisocode; + return this; + } + + /** + * Currency ISO code for calculation. + * @return currencyisocode + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Currency ISO code for calculation.") + @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCurrencyisocode() { + return currencyisocode; + } + + + @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCurrencyisocode(String currencyisocode) { + this.currencyisocode = currencyisocode; + } + + + public UnlinkedPATemplate componentdetail(String componentdetail) { + this.componentdetail = componentdetail; + return this; + } + + /** + * PA storage type. It can be GROUPS or TOTALS or SECURITIES. + * @return componentdetail + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "PA storage type. It can be GROUPS or TOTALS or SECURITIES.") + @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getComponentdetail() { + return componentdetail; + } + + + @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setComponentdetail(String componentdetail) { + this.componentdetail = componentdetail; + } + + + public UnlinkedPATemplate content(TemplateContentTypes content) { + this.content = content; + return this; + } + + /** + * Get content + * @return content + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_CONTENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public TemplateContentTypes getContent() { + return content; + } + + + @JsonProperty(JSON_PROPERTY_CONTENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setContent(TemplateContentTypes content) { + this.content = content; + } + + + public UnlinkedPATemplate description(String description) { + this.description = description; + return this; + } + + /** + * Template description. + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template description.") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDescription(String description) { + this.description = description; + } + + + public UnlinkedPATemplate name(String name) { + this.name = name; + return this; + } + + /** + * Template name. + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template name.") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setName(String name) { + this.name = name; + } + + + public UnlinkedPATemplate category(String category) { + this.category = category; + return this; + } + + /** + * Unlinked template category + * @return category + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Unlinked template category") + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCategory() { + return category; + } + + + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCategory(String category) { + this.category = category; + } + + + /** + * Return true if this UnlinkedPATemplate object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplate unlinkedPATemplate = (UnlinkedPATemplate) o; + return Objects.equals(this.id, unlinkedPATemplate.id) && + Objects.equals(this.directory, unlinkedPATemplate.directory) && + Objects.equals(this.templateTypeId, unlinkedPATemplate.templateTypeId) && + Objects.equals(this.snapshot, unlinkedPATemplate.snapshot) && + Objects.equals(this.accounts, unlinkedPATemplate.accounts) && + Objects.equals(this.benchmarks, unlinkedPATemplate.benchmarks) && + Objects.equals(this.columns, unlinkedPATemplate.columns) && + Objects.equals(this.dates, unlinkedPATemplate.dates) && + Objects.equals(this.groups, unlinkedPATemplate.groups) && + Objects.equals(this.currencyisocode, unlinkedPATemplate.currencyisocode) && + Objects.equals(this.componentdetail, unlinkedPATemplate.componentdetail) && + Objects.equals(this.content, unlinkedPATemplate.content) && + Objects.equals(this.description, unlinkedPATemplate.description) && + Objects.equals(this.name, unlinkedPATemplate.name) && + Objects.equals(this.category, unlinkedPATemplate.category); + } + + @Override + public int hashCode() { + return Objects.hash(id, directory, templateTypeId, snapshot, accounts, benchmarks, columns, dates, groups, currencyisocode, componentdetail, content, description, name, category); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplate {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); + sb.append(" templateTypeId: ").append(toIndentedString(templateTypeId)).append("\n"); + sb.append(" snapshot: ").append(toIndentedString(snapshot)).append("\n"); + sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); + sb.append(" benchmarks: ").append(toIndentedString(benchmarks)).append("\n"); + sb.append(" columns: ").append(toIndentedString(columns)).append("\n"); + sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); + sb.append(" groups: ").append(toIndentedString(groups)).append("\n"); + sb.append(" currencyisocode: ").append(toIndentedString(currencyisocode)).append("\n"); + sb.append(" componentdetail: ").append(toIndentedString(componentdetail)).append("\n"); + sb.append(" content: ").append(toIndentedString(content)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" category: ").append(toIndentedString(category)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndType.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndType.java new file mode 100644 index 00000000..ebfbd7ed --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndType.java @@ -0,0 +1,147 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateCategoryAndType + */ +@JsonPropertyOrder({ + UnlinkedPATemplateCategoryAndType.JSON_PROPERTY_CATEGORY, + UnlinkedPATemplateCategoryAndType.JSON_PROPERTY_NAME +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateCategoryAndType implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_CATEGORY = "category"; + private String category; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public UnlinkedPATemplateCategoryAndType() { + } + + public UnlinkedPATemplateCategoryAndType category(String category) { + this.category = category; + return this; + } + + /** + * Unlinked template category + * @return category + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Unlinked template category") + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCategory() { + return category; + } + + + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCategory(String category) { + this.category = category; + } + + + public UnlinkedPATemplateCategoryAndType name(String name) { + this.name = name; + return this; + } + + /** + * Unlinked template type + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Unlinked template type") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setName(String name) { + this.name = name; + } + + + /** + * Return true if this UnlinkedPATemplateCategoryAndType object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateCategoryAndType unlinkedPATemplateCategoryAndType = (UnlinkedPATemplateCategoryAndType) o; + return Objects.equals(this.category, unlinkedPATemplateCategoryAndType.category) && + Objects.equals(this.name, unlinkedPATemplateCategoryAndType.name); + } + + @Override + public int hashCode() { + return Objects.hash(category, name); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateCategoryAndType {\n"); + sb.append(" category: ").append(toIndentedString(category)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetails.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetails.java new file mode 100644 index 00000000..b53da87b --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetails.java @@ -0,0 +1,293 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.UnlinkedPATemplateColumnDetails; +import factset.analyticsapi.engines.models.UnlinkedPATemplateGroupDetails; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateCategoryAndTypeDetails + */ +@JsonPropertyOrder({ + UnlinkedPATemplateCategoryAndTypeDetails.JSON_PROPERTY_ID, + UnlinkedPATemplateCategoryAndTypeDetails.JSON_PROPERTY_COLUMNS, + UnlinkedPATemplateCategoryAndTypeDetails.JSON_PROPERTY_GROUPS, + UnlinkedPATemplateCategoryAndTypeDetails.JSON_PROPERTY_SNAPSHOT, + UnlinkedPATemplateCategoryAndTypeDetails.JSON_PROPERTY_CATEGORY, + UnlinkedPATemplateCategoryAndTypeDetails.JSON_PROPERTY_NAME +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateCategoryAndTypeDetails implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_COLUMNS = "columns"; + private java.util.List columns = null; + + public static final String JSON_PROPERTY_GROUPS = "groups"; + private java.util.List groups = null; + + public static final String JSON_PROPERTY_SNAPSHOT = "snapshot"; + private Boolean snapshot; + + public static final String JSON_PROPERTY_CATEGORY = "category"; + private String category; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public UnlinkedPATemplateCategoryAndTypeDetails() { + } + + public UnlinkedPATemplateCategoryAndTypeDetails id(String id) { + this.id = id; + return this; + } + + /** + * Type Id + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Type Id") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setId(String id) { + this.id = id; + } + + + public UnlinkedPATemplateCategoryAndTypeDetails columns(java.util.List columns) { + this.columns = columns; + return this; + } + + public UnlinkedPATemplateCategoryAndTypeDetails addColumnsItem(UnlinkedPATemplateColumnDetails columnsItem) { + if (this.columns == null) { + this.columns = new java.util.ArrayList(); + } + this.columns.add(columnsItem); + return this; + } + + /** + * List of default columns + * @return columns + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of default columns") + @JsonProperty(JSON_PROPERTY_COLUMNS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getColumns() { + return columns; + } + + + @JsonProperty(JSON_PROPERTY_COLUMNS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setColumns(java.util.List columns) { + this.columns = columns; + } + + + public UnlinkedPATemplateCategoryAndTypeDetails groups(java.util.List groups) { + this.groups = groups; + return this; + } + + public UnlinkedPATemplateCategoryAndTypeDetails addGroupsItem(UnlinkedPATemplateGroupDetails groupsItem) { + if (this.groups == null) { + this.groups = new java.util.ArrayList(); + } + this.groups.add(groupsItem); + return this; + } + + /** + * List of default groupings + * @return groups + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of default groupings") + @JsonProperty(JSON_PROPERTY_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getGroups() { + return groups; + } + + + @JsonProperty(JSON_PROPERTY_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroups(java.util.List groups) { + this.groups = groups; + } + + + public UnlinkedPATemplateCategoryAndTypeDetails snapshot(Boolean snapshot) { + this.snapshot = snapshot; + return this; + } + + /** + * Snapshot + * @return snapshot + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Snapshot") + @JsonProperty(JSON_PROPERTY_SNAPSHOT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getSnapshot() { + return snapshot; + } + + + @JsonProperty(JSON_PROPERTY_SNAPSHOT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSnapshot(Boolean snapshot) { + this.snapshot = snapshot; + } + + + public UnlinkedPATemplateCategoryAndTypeDetails category(String category) { + this.category = category; + return this; + } + + /** + * Unlinked template category + * @return category + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Unlinked template category") + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCategory() { + return category; + } + + + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCategory(String category) { + this.category = category; + } + + + public UnlinkedPATemplateCategoryAndTypeDetails name(String name) { + this.name = name; + return this; + } + + /** + * Unlinked template type + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Unlinked template type") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setName(String name) { + this.name = name; + } + + + /** + * Return true if this UnlinkedPATemplateCategoryAndTypeDetails object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateCategoryAndTypeDetails unlinkedPATemplateCategoryAndTypeDetails = (UnlinkedPATemplateCategoryAndTypeDetails) o; + return Objects.equals(this.id, unlinkedPATemplateCategoryAndTypeDetails.id) && + Objects.equals(this.columns, unlinkedPATemplateCategoryAndTypeDetails.columns) && + Objects.equals(this.groups, unlinkedPATemplateCategoryAndTypeDetails.groups) && + Objects.equals(this.snapshot, unlinkedPATemplateCategoryAndTypeDetails.snapshot) && + Objects.equals(this.category, unlinkedPATemplateCategoryAndTypeDetails.category) && + Objects.equals(this.name, unlinkedPATemplateCategoryAndTypeDetails.name); + } + + @Override + public int hashCode() { + return Objects.hash(id, columns, groups, snapshot, category, name); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateCategoryAndTypeDetails {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" columns: ").append(toIndentedString(columns)).append("\n"); + sb.append(" groups: ").append(toIndentedString(groups)).append("\n"); + sb.append(" snapshot: ").append(toIndentedString(snapshot)).append("\n"); + sb.append(" category: ").append(toIndentedString(category)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetailsRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetailsRoot.java new file mode 100644 index 00000000..7bf03d37 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeDetailsRoot.java @@ -0,0 +1,171 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.UnlinkedPATemplateCategoryAndTypeDetails; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateCategoryAndTypeDetailsRoot + */ +@JsonPropertyOrder({ + UnlinkedPATemplateCategoryAndTypeDetailsRoot.JSON_PROPERTY_DATA, + UnlinkedPATemplateCategoryAndTypeDetailsRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateCategoryAndTypeDetailsRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private UnlinkedPATemplateCategoryAndTypeDetails data; + + public static final String JSON_PROPERTY_META = "meta"; + private JsonNullable meta = JsonNullable.of(null); + + public UnlinkedPATemplateCategoryAndTypeDetailsRoot() { + } + + public UnlinkedPATemplateCategoryAndTypeDetailsRoot data(UnlinkedPATemplateCategoryAndTypeDetails data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public UnlinkedPATemplateCategoryAndTypeDetails getData() { + return data; + } + + + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setData(UnlinkedPATemplateCategoryAndTypeDetails data) { + this.data = data; + } + + + public UnlinkedPATemplateCategoryAndTypeDetailsRoot meta(Object meta) { + this.meta = JsonNullable.of(meta); + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public JsonNullable getMeta_JsonNullable() { + return meta; + } + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } + + public void setMeta(Object meta) { + this.meta = JsonNullable.of(meta); + } + + + /** + * Return true if this UnlinkedPATemplateCategoryAndTypeDetailsRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateCategoryAndTypeDetailsRoot unlinkedPATemplateCategoryAndTypeDetailsRoot = (UnlinkedPATemplateCategoryAndTypeDetailsRoot) o; + return Objects.equals(this.data, unlinkedPATemplateCategoryAndTypeDetailsRoot.data) && + equalsNullable(this.meta, unlinkedPATemplateCategoryAndTypeDetailsRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + } + + @Override + public int hashCode() { + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateCategoryAndTypeDetailsRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeRoot.java new file mode 100644 index 00000000..fdc2e62b --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateCategoryAndTypeRoot.java @@ -0,0 +1,176 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.UnlinkedPATemplateCategoryAndType; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateCategoryAndTypeRoot + */ +@JsonPropertyOrder({ + UnlinkedPATemplateCategoryAndTypeRoot.JSON_PROPERTY_DATA, + UnlinkedPATemplateCategoryAndTypeRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateCategoryAndTypeRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private java.util.Map data = new java.util.HashMap(); + + public static final String JSON_PROPERTY_META = "meta"; + private JsonNullable meta = JsonNullable.of(null); + + public UnlinkedPATemplateCategoryAndTypeRoot() { + } + + public UnlinkedPATemplateCategoryAndTypeRoot data(java.util.Map data) { + this.data = data; + return this; + } + + public UnlinkedPATemplateCategoryAndTypeRoot putDataItem(String key, UnlinkedPATemplateCategoryAndType dataItem) { + this.data.put(key, dataItem); + return this; + } + + /** + * Get data + * @return data + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public java.util.Map getData() { + return data; + } + + + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setData(java.util.Map data) { + this.data = data; + } + + + public UnlinkedPATemplateCategoryAndTypeRoot meta(Object meta) { + this.meta = JsonNullable.of(meta); + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public JsonNullable getMeta_JsonNullable() { + return meta; + } + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } + + public void setMeta(Object meta) { + this.meta = JsonNullable.of(meta); + } + + + /** + * Return true if this UnlinkedPATemplateCategoryAndTypeRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateCategoryAndTypeRoot unlinkedPATemplateCategoryAndTypeRoot = (UnlinkedPATemplateCategoryAndTypeRoot) o; + return Objects.equals(this.data, unlinkedPATemplateCategoryAndTypeRoot.data) && + equalsNullable(this.meta, unlinkedPATemplateCategoryAndTypeRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + } + + @Override + public int hashCode() { + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateCategoryAndTypeRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateColumnDetails.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateColumnDetails.java new file mode 100644 index 00000000..4a3d4172 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateColumnDetails.java @@ -0,0 +1,187 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateColumnDetails + */ +@JsonPropertyOrder({ + UnlinkedPATemplateColumnDetails.JSON_PROPERTY_NAME, + UnlinkedPATemplateColumnDetails.JSON_PROPERTY_ID, + UnlinkedPATemplateColumnDetails.JSON_PROPERTY_STATISTICS +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateColumnDetails implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_STATISTICS = "statistics"; + private java.util.List statistics = null; + + public UnlinkedPATemplateColumnDetails() { + } + + public UnlinkedPATemplateColumnDetails name(String name) { + this.name = name; + return this; + } + + /** + * Unlinked template column name + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Unlinked template column name") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setName(String name) { + this.name = name; + } + + + public UnlinkedPATemplateColumnDetails id(String id) { + this.id = id; + return this; + } + + /** + * FactSet-defined or User-defined Column identifier. + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "FactSet-defined or User-defined Column identifier.") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setId(String id) { + this.id = id; + } + + + public UnlinkedPATemplateColumnDetails statistics(java.util.List statistics) { + this.statistics = statistics; + return this; + } + + public UnlinkedPATemplateColumnDetails addStatisticsItem(String statisticsItem) { + if (this.statistics == null) { + this.statistics = new java.util.ArrayList(); + } + this.statistics.add(statisticsItem); + return this; + } + + /** + * Column Statistic identifier + * @return statistics + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Column Statistic identifier") + @JsonProperty(JSON_PROPERTY_STATISTICS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getStatistics() { + return statistics; + } + + + @JsonProperty(JSON_PROPERTY_STATISTICS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setStatistics(java.util.List statistics) { + this.statistics = statistics; + } + + + /** + * Return true if this UnlinkedPATemplateColumnDetails object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateColumnDetails unlinkedPATemplateColumnDetails = (UnlinkedPATemplateColumnDetails) o; + return Objects.equals(this.name, unlinkedPATemplateColumnDetails.name) && + Objects.equals(this.id, unlinkedPATemplateColumnDetails.id) && + Objects.equals(this.statistics, unlinkedPATemplateColumnDetails.statistics); + } + + @Override + public int hashCode() { + return Objects.hash(name, id, statistics); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateColumnDetails {\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" statistics: ").append(toIndentedString(statistics)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateGroupDetails.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateGroupDetails.java new file mode 100644 index 00000000..0688ea1c --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateGroupDetails.java @@ -0,0 +1,147 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateGroupDetails + */ +@JsonPropertyOrder({ + UnlinkedPATemplateGroupDetails.JSON_PROPERTY_NAME, + UnlinkedPATemplateGroupDetails.JSON_PROPERTY_ID +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateGroupDetails implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public UnlinkedPATemplateGroupDetails() { + } + + public UnlinkedPATemplateGroupDetails name(String name) { + this.name = name; + return this; + } + + /** + * Unlinked template group name + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Unlinked template group name") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setName(String name) { + this.name = name; + } + + + public UnlinkedPATemplateGroupDetails id(String id) { + this.id = id; + return this; + } + + /** + * FactSet-defined or User-defined Group identifier. + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "FactSet-defined or User-defined Group identifier.") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setId(String id) { + this.id = id; + } + + + /** + * Return true if this UnlinkedPATemplateGroupDetails object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateGroupDetails unlinkedPATemplateGroupDetails = (UnlinkedPATemplateGroupDetails) o; + return Objects.equals(this.name, unlinkedPATemplateGroupDetails.name) && + Objects.equals(this.id, unlinkedPATemplateGroupDetails.id); + } + + @Override + public int hashCode() { + return Objects.hash(name, id); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateGroupDetails {\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParameters.java new file mode 100644 index 00000000..1e601207 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParameters.java @@ -0,0 +1,472 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PACalculationColumn; +import factset.analyticsapi.engines.models.PACalculationGroup; +import factset.analyticsapi.engines.models.PADateParameters; +import factset.analyticsapi.engines.models.PAIdentifier; +import factset.analyticsapi.engines.models.TemplateContentTypes; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateParameters + */ +@JsonPropertyOrder({ + UnlinkedPATemplateParameters.JSON_PROPERTY_DIRECTORY, + UnlinkedPATemplateParameters.JSON_PROPERTY_TEMPLATE_TYPE_ID, + UnlinkedPATemplateParameters.JSON_PROPERTY_DESCRIPTION, + UnlinkedPATemplateParameters.JSON_PROPERTY_ACCOUNTS, + UnlinkedPATemplateParameters.JSON_PROPERTY_BENCHMARKS, + UnlinkedPATemplateParameters.JSON_PROPERTY_COLUMNS, + UnlinkedPATemplateParameters.JSON_PROPERTY_DATES, + UnlinkedPATemplateParameters.JSON_PROPERTY_GROUPS, + UnlinkedPATemplateParameters.JSON_PROPERTY_CURRENCYISOCODE, + UnlinkedPATemplateParameters.JSON_PROPERTY_COMPONENTDETAIL, + UnlinkedPATemplateParameters.JSON_PROPERTY_CONTENT +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateParameters implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DIRECTORY = "directory"; + private String directory; + + public static final String JSON_PROPERTY_TEMPLATE_TYPE_ID = "templateTypeId"; + private String templateTypeId; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; + private java.util.List accounts = null; + + public static final String JSON_PROPERTY_BENCHMARKS = "benchmarks"; + private java.util.List benchmarks = null; + + public static final String JSON_PROPERTY_COLUMNS = "columns"; + private java.util.List columns = null; + + public static final String JSON_PROPERTY_DATES = "dates"; + private PADateParameters dates; + + public static final String JSON_PROPERTY_GROUPS = "groups"; + private java.util.List groups = null; + + public static final String JSON_PROPERTY_CURRENCYISOCODE = "currencyisocode"; + private String currencyisocode; + + public static final String JSON_PROPERTY_COMPONENTDETAIL = "componentdetail"; + private String componentdetail; + + public static final String JSON_PROPERTY_CONTENT = "content"; + private TemplateContentTypes content; + + public UnlinkedPATemplateParameters() { + } + + public UnlinkedPATemplateParameters directory(String directory) { + this.directory = directory; + return this; + } + + /** + * The directory to create an unlinked PA template + * @return directory + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "The directory to create an unlinked PA template") + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getDirectory() { + return directory; + } + + + @JsonProperty(JSON_PROPERTY_DIRECTORY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setDirectory(String directory) { + this.directory = directory; + } + + + public UnlinkedPATemplateParameters templateTypeId(String templateTypeId) { + this.templateTypeId = templateTypeId; + return this; + } + + /** + * Template type id + * @return templateTypeId + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "Template type id") + @JsonProperty(JSON_PROPERTY_TEMPLATE_TYPE_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getTemplateTypeId() { + return templateTypeId; + } + + + @JsonProperty(JSON_PROPERTY_TEMPLATE_TYPE_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setTemplateTypeId(String templateTypeId) { + this.templateTypeId = templateTypeId; + } + + + public UnlinkedPATemplateParameters description(String description) { + this.description = description; + return this; + } + + /** + * Template description + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template description") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDescription(String description) { + this.description = description; + } + + + public UnlinkedPATemplateParameters accounts(java.util.List accounts) { + this.accounts = accounts; + return this; + } + + public UnlinkedPATemplateParameters addAccountsItem(PAIdentifier accountsItem) { + if (this.accounts == null) { + this.accounts = new java.util.ArrayList(); + } + this.accounts.add(accountsItem); + return this; + } + + /** + * List of accounts + * @return accounts + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of accounts") + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getAccounts() { + return accounts; + } + + + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAccounts(java.util.List accounts) { + this.accounts = accounts; + } + + + public UnlinkedPATemplateParameters benchmarks(java.util.List benchmarks) { + this.benchmarks = benchmarks; + return this; + } + + public UnlinkedPATemplateParameters addBenchmarksItem(PAIdentifier benchmarksItem) { + if (this.benchmarks == null) { + this.benchmarks = new java.util.ArrayList(); + } + this.benchmarks.add(benchmarksItem); + return this; + } + + /** + * List of benchmarks + * @return benchmarks + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of benchmarks") + @JsonProperty(JSON_PROPERTY_BENCHMARKS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getBenchmarks() { + return benchmarks; + } + + + @JsonProperty(JSON_PROPERTY_BENCHMARKS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setBenchmarks(java.util.List benchmarks) { + this.benchmarks = benchmarks; + } + + + public UnlinkedPATemplateParameters columns(java.util.List columns) { + this.columns = columns; + return this; + } + + public UnlinkedPATemplateParameters addColumnsItem(PACalculationColumn columnsItem) { + if (this.columns == null) { + this.columns = new java.util.ArrayList(); + } + this.columns.add(columnsItem); + return this; + } + + /** + * List of columns for the PA calculation + * @return columns + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of columns for the PA calculation") + @JsonProperty(JSON_PROPERTY_COLUMNS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getColumns() { + return columns; + } + + + @JsonProperty(JSON_PROPERTY_COLUMNS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setColumns(java.util.List columns) { + this.columns = columns; + } + + + public UnlinkedPATemplateParameters dates(PADateParameters dates) { + this.dates = dates; + return this; + } + + /** + * Get dates + * @return dates + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PADateParameters getDates() { + return dates; + } + + + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDates(PADateParameters dates) { + this.dates = dates; + } + + + public UnlinkedPATemplateParameters groups(java.util.List groups) { + this.groups = groups; + return this; + } + + public UnlinkedPATemplateParameters addGroupsItem(PACalculationGroup groupsItem) { + if (this.groups == null) { + this.groups = new java.util.ArrayList(); + } + this.groups.add(groupsItem); + return this; + } + + /** + * List of groupings for the PA calculation + * @return groups + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of groupings for the PA calculation") + @JsonProperty(JSON_PROPERTY_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getGroups() { + return groups; + } + + + @JsonProperty(JSON_PROPERTY_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroups(java.util.List groups) { + this.groups = groups; + } + + + public UnlinkedPATemplateParameters currencyisocode(String currencyisocode) { + this.currencyisocode = currencyisocode; + return this; + } + + /** + * Currency ISO code for calculation. + * @return currencyisocode + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Currency ISO code for calculation.") + @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCurrencyisocode() { + return currencyisocode; + } + + + @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCurrencyisocode(String currencyisocode) { + this.currencyisocode = currencyisocode; + } + + + public UnlinkedPATemplateParameters componentdetail(String componentdetail) { + this.componentdetail = componentdetail; + return this; + } + + /** + * PA storage type. It can be GROUPS or TOTALS or SECURITIES. + * @return componentdetail + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "PA storage type. It can be GROUPS or TOTALS or SECURITIES.") + @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getComponentdetail() { + return componentdetail; + } + + + @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setComponentdetail(String componentdetail) { + this.componentdetail = componentdetail; + } + + + public UnlinkedPATemplateParameters content(TemplateContentTypes content) { + this.content = content; + return this; + } + + /** + * Get content + * @return content + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_CONTENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public TemplateContentTypes getContent() { + return content; + } + + + @JsonProperty(JSON_PROPERTY_CONTENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setContent(TemplateContentTypes content) { + this.content = content; + } + + + /** + * Return true if this UnlinkedPATemplateParameters object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateParameters unlinkedPATemplateParameters = (UnlinkedPATemplateParameters) o; + return Objects.equals(this.directory, unlinkedPATemplateParameters.directory) && + Objects.equals(this.templateTypeId, unlinkedPATemplateParameters.templateTypeId) && + Objects.equals(this.description, unlinkedPATemplateParameters.description) && + Objects.equals(this.accounts, unlinkedPATemplateParameters.accounts) && + Objects.equals(this.benchmarks, unlinkedPATemplateParameters.benchmarks) && + Objects.equals(this.columns, unlinkedPATemplateParameters.columns) && + Objects.equals(this.dates, unlinkedPATemplateParameters.dates) && + Objects.equals(this.groups, unlinkedPATemplateParameters.groups) && + Objects.equals(this.currencyisocode, unlinkedPATemplateParameters.currencyisocode) && + Objects.equals(this.componentdetail, unlinkedPATemplateParameters.componentdetail) && + Objects.equals(this.content, unlinkedPATemplateParameters.content); + } + + @Override + public int hashCode() { + return Objects.hash(directory, templateTypeId, description, accounts, benchmarks, columns, dates, groups, currencyisocode, componentdetail, content); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateParameters {\n"); + sb.append(" directory: ").append(toIndentedString(directory)).append("\n"); + sb.append(" templateTypeId: ").append(toIndentedString(templateTypeId)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); + sb.append(" benchmarks: ").append(toIndentedString(benchmarks)).append("\n"); + sb.append(" columns: ").append(toIndentedString(columns)).append("\n"); + sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); + sb.append(" groups: ").append(toIndentedString(groups)).append("\n"); + sb.append(" currencyisocode: ").append(toIndentedString(currencyisocode)).append("\n"); + sb.append(" componentdetail: ").append(toIndentedString(componentdetail)).append("\n"); + sb.append(" content: ").append(toIndentedString(content)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParametersRoot.java new file mode 100644 index 00000000..3cd1749b --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateParametersRoot.java @@ -0,0 +1,171 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.UnlinkedPATemplateParameters; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateParametersRoot + */ +@JsonPropertyOrder({ + UnlinkedPATemplateParametersRoot.JSON_PROPERTY_DATA, + UnlinkedPATemplateParametersRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateParametersRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private UnlinkedPATemplateParameters data; + + public static final String JSON_PROPERTY_META = "meta"; + private JsonNullable meta = JsonNullable.of(null); + + public UnlinkedPATemplateParametersRoot() { + } + + public UnlinkedPATemplateParametersRoot data(UnlinkedPATemplateParameters data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public UnlinkedPATemplateParameters getData() { + return data; + } + + + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setData(UnlinkedPATemplateParameters data) { + this.data = data; + } + + + public UnlinkedPATemplateParametersRoot meta(Object meta) { + this.meta = JsonNullable.of(meta); + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public JsonNullable getMeta_JsonNullable() { + return meta; + } + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } + + public void setMeta(Object meta) { + this.meta = JsonNullable.of(meta); + } + + + /** + * Return true if this UnlinkedPATemplateParametersRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateParametersRoot unlinkedPATemplateParametersRoot = (UnlinkedPATemplateParametersRoot) o; + return Objects.equals(this.data, unlinkedPATemplateParametersRoot.data) && + equalsNullable(this.meta, unlinkedPATemplateParametersRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + } + + @Override + public int hashCode() { + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateParametersRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummary.java new file mode 100644 index 00000000..e81d6b7e --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummary.java @@ -0,0 +1,211 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplatePostSummary + */ +@JsonPropertyOrder({ + UnlinkedPATemplatePostSummary.JSON_PROPERTY_ID, + UnlinkedPATemplatePostSummary.JSON_PROPERTY_DESCRIPTION, + UnlinkedPATemplatePostSummary.JSON_PROPERTY_NAME, + UnlinkedPATemplatePostSummary.JSON_PROPERTY_CATEGORY +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplatePostSummary implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_ID = "id"; + private String id; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_CATEGORY = "category"; + private String category; + + public UnlinkedPATemplatePostSummary() { + } + + public UnlinkedPATemplatePostSummary id(String id) { + this.id = id; + return this; + } + + /** + * Template id. + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template id.") + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getId() { + return id; + } + + + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setId(String id) { + this.id = id; + } + + + public UnlinkedPATemplatePostSummary description(String description) { + this.description = description; + return this; + } + + /** + * Template description. + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template description.") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDescription(String description) { + this.description = description; + } + + + public UnlinkedPATemplatePostSummary name(String name) { + this.name = name; + return this; + } + + /** + * Template name. + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template name.") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setName(String name) { + this.name = name; + } + + + public UnlinkedPATemplatePostSummary category(String category) { + this.category = category; + return this; + } + + /** + * Unlinked template category + * @return category + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Unlinked template category") + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCategory() { + return category; + } + + + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCategory(String category) { + this.category = category; + } + + + /** + * Return true if this UnlinkedPATemplatePostSummary object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplatePostSummary unlinkedPATemplatePostSummary = (UnlinkedPATemplatePostSummary) o; + return Objects.equals(this.id, unlinkedPATemplatePostSummary.id) && + Objects.equals(this.description, unlinkedPATemplatePostSummary.description) && + Objects.equals(this.name, unlinkedPATemplatePostSummary.name) && + Objects.equals(this.category, unlinkedPATemplatePostSummary.category); + } + + @Override + public int hashCode() { + return Objects.hash(id, description, name, category); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplatePostSummary {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" category: ").append(toIndentedString(category)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummaryRoot.java new file mode 100644 index 00000000..fd42e0d6 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplatePostSummaryRoot.java @@ -0,0 +1,171 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.UnlinkedPATemplatePostSummary; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplatePostSummaryRoot + */ +@JsonPropertyOrder({ + UnlinkedPATemplatePostSummaryRoot.JSON_PROPERTY_DATA, + UnlinkedPATemplatePostSummaryRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplatePostSummaryRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private UnlinkedPATemplatePostSummary data; + + public static final String JSON_PROPERTY_META = "meta"; + private JsonNullable meta = JsonNullable.of(null); + + public UnlinkedPATemplatePostSummaryRoot() { + } + + public UnlinkedPATemplatePostSummaryRoot data(UnlinkedPATemplatePostSummary data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public UnlinkedPATemplatePostSummary getData() { + return data; + } + + + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setData(UnlinkedPATemplatePostSummary data) { + this.data = data; + } + + + public UnlinkedPATemplatePostSummaryRoot meta(Object meta) { + this.meta = JsonNullable.of(meta); + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public JsonNullable getMeta_JsonNullable() { + return meta; + } + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } + + public void setMeta(Object meta) { + this.meta = JsonNullable.of(meta); + } + + + /** + * Return true if this UnlinkedPATemplatePostSummaryRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplatePostSummaryRoot unlinkedPATemplatePostSummaryRoot = (UnlinkedPATemplatePostSummaryRoot) o; + return Objects.equals(this.data, unlinkedPATemplatePostSummaryRoot.data) && + equalsNullable(this.meta, unlinkedPATemplatePostSummaryRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + } + + @Override + public int hashCode() { + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplatePostSummaryRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateRoot.java new file mode 100644 index 00000000..dda7cdb0 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateRoot.java @@ -0,0 +1,171 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.UnlinkedPATemplate; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateRoot + */ +@JsonPropertyOrder({ + UnlinkedPATemplateRoot.JSON_PROPERTY_DATA, + UnlinkedPATemplateRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private UnlinkedPATemplate data; + + public static final String JSON_PROPERTY_META = "meta"; + private JsonNullable meta = JsonNullable.of(null); + + public UnlinkedPATemplateRoot() { + } + + public UnlinkedPATemplateRoot data(UnlinkedPATemplate data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public UnlinkedPATemplate getData() { + return data; + } + + + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setData(UnlinkedPATemplate data) { + this.data = data; + } + + + public UnlinkedPATemplateRoot meta(Object meta) { + this.meta = JsonNullable.of(meta); + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public JsonNullable getMeta_JsonNullable() { + return meta; + } + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } + + public void setMeta(Object meta) { + this.meta = JsonNullable.of(meta); + } + + + /** + * Return true if this UnlinkedPATemplateRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateRoot unlinkedPATemplateRoot = (UnlinkedPATemplateRoot) o; + return Objects.equals(this.data, unlinkedPATemplateRoot.data) && + equalsNullable(this.meta, unlinkedPATemplateRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + } + + @Override + public int hashCode() { + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummary.java new file mode 100644 index 00000000..44af354b --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummary.java @@ -0,0 +1,179 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateSummary + */ +@JsonPropertyOrder({ + UnlinkedPATemplateSummary.JSON_PROPERTY_DESCRIPTION, + UnlinkedPATemplateSummary.JSON_PROPERTY_NAME, + UnlinkedPATemplateSummary.JSON_PROPERTY_CATEGORY +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateSummary implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_CATEGORY = "category"; + private String category; + + public UnlinkedPATemplateSummary() { + } + + public UnlinkedPATemplateSummary description(String description) { + this.description = description; + return this; + } + + /** + * Template description. + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template description.") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDescription(String description) { + this.description = description; + } + + + public UnlinkedPATemplateSummary name(String name) { + this.name = name; + return this; + } + + /** + * Template name. + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template name.") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setName(String name) { + this.name = name; + } + + + public UnlinkedPATemplateSummary category(String category) { + this.category = category; + return this; + } + + /** + * Unlinked template category + * @return category + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Unlinked template category") + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCategory() { + return category; + } + + + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCategory(String category) { + this.category = category; + } + + + /** + * Return true if this UnlinkedPATemplateSummary object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateSummary unlinkedPATemplateSummary = (UnlinkedPATemplateSummary) o; + return Objects.equals(this.description, unlinkedPATemplateSummary.description) && + Objects.equals(this.name, unlinkedPATemplateSummary.name) && + Objects.equals(this.category, unlinkedPATemplateSummary.category); + } + + @Override + public int hashCode() { + return Objects.hash(description, name, category); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateSummary {\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" category: ").append(toIndentedString(category)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummaryRoot.java new file mode 100644 index 00000000..27e1a0e0 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummaryRoot.java @@ -0,0 +1,176 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.UnlinkedPATemplateSummary; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateSummaryRoot + */ +@JsonPropertyOrder({ + UnlinkedPATemplateSummaryRoot.JSON_PROPERTY_DATA, + UnlinkedPATemplateSummaryRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateSummaryRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private java.util.Map data = new java.util.HashMap(); + + public static final String JSON_PROPERTY_META = "meta"; + private JsonNullable meta = JsonNullable.of(null); + + public UnlinkedPATemplateSummaryRoot() { + } + + public UnlinkedPATemplateSummaryRoot data(java.util.Map data) { + this.data = data; + return this; + } + + public UnlinkedPATemplateSummaryRoot putDataItem(String key, UnlinkedPATemplateSummary dataItem) { + this.data.put(key, dataItem); + return this; + } + + /** + * Get data + * @return data + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public java.util.Map getData() { + return data; + } + + + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setData(java.util.Map data) { + this.data = data; + } + + + public UnlinkedPATemplateSummaryRoot meta(Object meta) { + this.meta = JsonNullable.of(meta); + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public JsonNullable getMeta_JsonNullable() { + return meta; + } + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } + + public void setMeta(Object meta) { + this.meta = JsonNullable.of(meta); + } + + + /** + * Return true if this UnlinkedPATemplateSummaryRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateSummaryRoot unlinkedPATemplateSummaryRoot = (UnlinkedPATemplateSummaryRoot) o; + return Objects.equals(this.data, unlinkedPATemplateSummaryRoot.data) && + equalsNullable(this.meta, unlinkedPATemplateSummaryRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + } + + @Override + public int hashCode() { + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateSummaryRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParameters.java new file mode 100644 index 00000000..498c6b62 --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParameters.java @@ -0,0 +1,408 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.PACalculationColumn; +import factset.analyticsapi.engines.models.PACalculationGroup; +import factset.analyticsapi.engines.models.PADateParameters; +import factset.analyticsapi.engines.models.PAIdentifier; +import factset.analyticsapi.engines.models.TemplateContentTypes; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateUpdateParameters + */ +@JsonPropertyOrder({ + UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_DESCRIPTION, + UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_ACCOUNTS, + UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_BENCHMARKS, + UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_COLUMNS, + UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_DATES, + UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_GROUPS, + UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_CURRENCYISOCODE, + UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_COMPONENTDETAIL, + UnlinkedPATemplateUpdateParameters.JSON_PROPERTY_CONTENT +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateUpdateParameters implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DESCRIPTION = "description"; + private String description; + + public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; + private java.util.List accounts = null; + + public static final String JSON_PROPERTY_BENCHMARKS = "benchmarks"; + private java.util.List benchmarks = null; + + public static final String JSON_PROPERTY_COLUMNS = "columns"; + private java.util.List columns = null; + + public static final String JSON_PROPERTY_DATES = "dates"; + private PADateParameters dates; + + public static final String JSON_PROPERTY_GROUPS = "groups"; + private java.util.List groups = null; + + public static final String JSON_PROPERTY_CURRENCYISOCODE = "currencyisocode"; + private String currencyisocode; + + public static final String JSON_PROPERTY_COMPONENTDETAIL = "componentdetail"; + private String componentdetail; + + public static final String JSON_PROPERTY_CONTENT = "content"; + private TemplateContentTypes content; + + public UnlinkedPATemplateUpdateParameters() { + } + + public UnlinkedPATemplateUpdateParameters description(String description) { + this.description = description; + return this; + } + + /** + * Template description + * @return description + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Template description") + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getDescription() { + return description; + } + + + @JsonProperty(JSON_PROPERTY_DESCRIPTION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDescription(String description) { + this.description = description; + } + + + public UnlinkedPATemplateUpdateParameters accounts(java.util.List accounts) { + this.accounts = accounts; + return this; + } + + public UnlinkedPATemplateUpdateParameters addAccountsItem(PAIdentifier accountsItem) { + if (this.accounts == null) { + this.accounts = new java.util.ArrayList(); + } + this.accounts.add(accountsItem); + return this; + } + + /** + * List of accounts + * @return accounts + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of accounts") + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getAccounts() { + return accounts; + } + + + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAccounts(java.util.List accounts) { + this.accounts = accounts; + } + + + public UnlinkedPATemplateUpdateParameters benchmarks(java.util.List benchmarks) { + this.benchmarks = benchmarks; + return this; + } + + public UnlinkedPATemplateUpdateParameters addBenchmarksItem(PAIdentifier benchmarksItem) { + if (this.benchmarks == null) { + this.benchmarks = new java.util.ArrayList(); + } + this.benchmarks.add(benchmarksItem); + return this; + } + + /** + * List of benchmarks + * @return benchmarks + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of benchmarks") + @JsonProperty(JSON_PROPERTY_BENCHMARKS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getBenchmarks() { + return benchmarks; + } + + + @JsonProperty(JSON_PROPERTY_BENCHMARKS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setBenchmarks(java.util.List benchmarks) { + this.benchmarks = benchmarks; + } + + + public UnlinkedPATemplateUpdateParameters columns(java.util.List columns) { + this.columns = columns; + return this; + } + + public UnlinkedPATemplateUpdateParameters addColumnsItem(PACalculationColumn columnsItem) { + if (this.columns == null) { + this.columns = new java.util.ArrayList(); + } + this.columns.add(columnsItem); + return this; + } + + /** + * List of columns for the PA calculation + * @return columns + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of columns for the PA calculation") + @JsonProperty(JSON_PROPERTY_COLUMNS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getColumns() { + return columns; + } + + + @JsonProperty(JSON_PROPERTY_COLUMNS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setColumns(java.util.List columns) { + this.columns = columns; + } + + + public UnlinkedPATemplateUpdateParameters dates(PADateParameters dates) { + this.dates = dates; + return this; + } + + /** + * Get dates + * @return dates + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public PADateParameters getDates() { + return dates; + } + + + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDates(PADateParameters dates) { + this.dates = dates; + } + + + public UnlinkedPATemplateUpdateParameters groups(java.util.List groups) { + this.groups = groups; + return this; + } + + public UnlinkedPATemplateUpdateParameters addGroupsItem(PACalculationGroup groupsItem) { + if (this.groups == null) { + this.groups = new java.util.ArrayList(); + } + this.groups.add(groupsItem); + return this; + } + + /** + * List of groupings for the PA calculation + * @return groups + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of groupings for the PA calculation") + @JsonProperty(JSON_PROPERTY_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public java.util.List getGroups() { + return groups; + } + + + @JsonProperty(JSON_PROPERTY_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroups(java.util.List groups) { + this.groups = groups; + } + + + public UnlinkedPATemplateUpdateParameters currencyisocode(String currencyisocode) { + this.currencyisocode = currencyisocode; + return this; + } + + /** + * Currency ISO code for calculation. + * @return currencyisocode + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "Currency ISO code for calculation.") + @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCurrencyisocode() { + return currencyisocode; + } + + + @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCurrencyisocode(String currencyisocode) { + this.currencyisocode = currencyisocode; + } + + + public UnlinkedPATemplateUpdateParameters componentdetail(String componentdetail) { + this.componentdetail = componentdetail; + return this; + } + + /** + * PA storage type. It can be GROUPS or TOTALS or SECURITIES. + * @return componentdetail + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "PA storage type. It can be GROUPS or TOTALS or SECURITIES.") + @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getComponentdetail() { + return componentdetail; + } + + + @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setComponentdetail(String componentdetail) { + this.componentdetail = componentdetail; + } + + + public UnlinkedPATemplateUpdateParameters content(TemplateContentTypes content) { + this.content = content; + return this; + } + + /** + * Get content + * @return content + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_CONTENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public TemplateContentTypes getContent() { + return content; + } + + + @JsonProperty(JSON_PROPERTY_CONTENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setContent(TemplateContentTypes content) { + this.content = content; + } + + + /** + * Return true if this UnlinkedPATemplateUpdateParameters object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateUpdateParameters unlinkedPATemplateUpdateParameters = (UnlinkedPATemplateUpdateParameters) o; + return Objects.equals(this.description, unlinkedPATemplateUpdateParameters.description) && + Objects.equals(this.accounts, unlinkedPATemplateUpdateParameters.accounts) && + Objects.equals(this.benchmarks, unlinkedPATemplateUpdateParameters.benchmarks) && + Objects.equals(this.columns, unlinkedPATemplateUpdateParameters.columns) && + Objects.equals(this.dates, unlinkedPATemplateUpdateParameters.dates) && + Objects.equals(this.groups, unlinkedPATemplateUpdateParameters.groups) && + Objects.equals(this.currencyisocode, unlinkedPATemplateUpdateParameters.currencyisocode) && + Objects.equals(this.componentdetail, unlinkedPATemplateUpdateParameters.componentdetail) && + Objects.equals(this.content, unlinkedPATemplateUpdateParameters.content); + } + + @Override + public int hashCode() { + return Objects.hash(description, accounts, benchmarks, columns, dates, groups, currencyisocode, componentdetail, content); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateUpdateParameters {\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); + sb.append(" benchmarks: ").append(toIndentedString(benchmarks)).append("\n"); + sb.append(" columns: ").append(toIndentedString(columns)).append("\n"); + sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); + sb.append(" groups: ").append(toIndentedString(groups)).append("\n"); + sb.append(" currencyisocode: ").append(toIndentedString(currencyisocode)).append("\n"); + sb.append(" componentdetail: ").append(toIndentedString(componentdetail)).append("\n"); + sb.append(" content: ").append(toIndentedString(content)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParametersRoot.java new file mode 100644 index 00000000..f9a84c9b --- /dev/null +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParametersRoot.java @@ -0,0 +1,171 @@ +/* + * 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: analytics.api.support@factset.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package factset.analyticsapi.engines.models; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import factset.analyticsapi.engines.models.UnlinkedPATemplateUpdateParameters; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; +import java.io.Serializable; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import factset.analyticsapi.engines.JSON; + + +/** + * UnlinkedPATemplateUpdateParametersRoot + */ +@JsonPropertyOrder({ + UnlinkedPATemplateUpdateParametersRoot.JSON_PROPERTY_DATA, + UnlinkedPATemplateUpdateParametersRoot.JSON_PROPERTY_META +}) +@javax.annotation.Generated(value = "CustomJavaClientCodegen") +public class UnlinkedPATemplateUpdateParametersRoot implements Serializable { + private static final long serialVersionUID = 1L; + + public static final String JSON_PROPERTY_DATA = "data"; + private UnlinkedPATemplateUpdateParameters data; + + public static final String JSON_PROPERTY_META = "meta"; + private JsonNullable meta = JsonNullable.of(null); + + public UnlinkedPATemplateUpdateParametersRoot() { + } + + public UnlinkedPATemplateUpdateParametersRoot data(UnlinkedPATemplateUpdateParameters data) { + this.data = data; + return this; + } + + /** + * Get data + * @return data + **/ + @javax.annotation.Nonnull + @ApiModelProperty(required = true, value = "") + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public UnlinkedPATemplateUpdateParameters getData() { + return data; + } + + + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setData(UnlinkedPATemplateUpdateParameters data) { + this.data = data; + } + + + public UnlinkedPATemplateUpdateParametersRoot meta(Object meta) { + this.meta = JsonNullable.of(meta); + return this; + } + + /** + * Get meta + * @return meta + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public JsonNullable getMeta_JsonNullable() { + return meta; + } + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } + + public void setMeta(Object meta) { + this.meta = JsonNullable.of(meta); + } + + + /** + * Return true if this UnlinkedPATemplateUpdateParametersRoot object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnlinkedPATemplateUpdateParametersRoot unlinkedPATemplateUpdateParametersRoot = (UnlinkedPATemplateUpdateParametersRoot) o; + return Objects.equals(this.data, unlinkedPATemplateUpdateParametersRoot.data) && + equalsNullable(this.meta, unlinkedPATemplateUpdateParametersRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + } + + @Override + public int hashCode() { + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnlinkedPATemplateUpdateParametersRoot {\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); + sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultCalculationParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultCalculationParameters.java index 3efdda7b..e8cbeb5e 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultCalculationParameters.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultCalculationParameters.java @@ -60,6 +60,8 @@ public class VaultCalculationParameters implements Serializable { public static final String JSON_PROPERTY_COMPONENTDETAIL = "componentdetail"; private String componentdetail; + public VaultCalculationParameters() { + } public VaultCalculationParameters componentid(String componentid) { this.componentid = componentid; @@ -70,6 +72,7 @@ public VaultCalculationParameters componentid(String componentid) { * The Vault component identifier to analyze. * @return componentid **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "The Vault component identifier to analyze.") @JsonProperty(JSON_PROPERTY_COMPONENTID) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -79,6 +82,8 @@ public String getComponentid() { } + @JsonProperty(JSON_PROPERTY_COMPONENTID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setComponentid(String componentid) { this.componentid = componentid; } @@ -93,6 +98,7 @@ public VaultCalculationParameters account(VaultIdentifier account) { * Get account * @return account **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_ACCOUNT) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -102,6 +108,8 @@ public VaultIdentifier getAccount() { } + @JsonProperty(JSON_PROPERTY_ACCOUNT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAccount(VaultIdentifier account) { this.account = account; } @@ -126,6 +134,8 @@ public VaultDateParameters getDates() { } + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDates(VaultDateParameters dates) { this.dates = dates; } @@ -140,6 +150,7 @@ public VaultCalculationParameters configid(String configid) { * Vault Configuration identifier. * @return configid **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "Vault Configuration identifier.") @JsonProperty(JSON_PROPERTY_CONFIGID) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -149,6 +160,8 @@ public String getConfigid() { } + @JsonProperty(JSON_PROPERTY_CONFIGID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setConfigid(String configid) { this.configid = configid; } @@ -160,11 +173,11 @@ public VaultCalculationParameters componentdetail(String componentdetail) { } /** - * Component detail type for the Vault component. It can be GROUPS or TOTALS. + * Component detail type for the Vault component. It can be GROUPS or TOTALS or SECURITIES. * @return componentdetail **/ @javax.annotation.Nullable - @ApiModelProperty(value = "Component detail type for the Vault component. It can be GROUPS or TOTALS.") + @ApiModelProperty(value = "Component detail type for the Vault component. It can be GROUPS or TOTALS or SECURITIES.") @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -173,6 +186,8 @@ public String getComponentdetail() { } + @JsonProperty(JSON_PROPERTY_COMPONENTDETAIL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setComponentdetail(String componentdetail) { this.componentdetail = componentdetail; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultCalculationParametersRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultCalculationParametersRoot.java index e9294136..ddaf785f 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultCalculationParametersRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultCalculationParametersRoot.java @@ -48,6 +48,8 @@ public class VaultCalculationParametersRoot implements Serializable { public static final String JSON_PROPERTY_META = "meta"; private CalculationMeta meta; + public VaultCalculationParametersRoot() { + } public VaultCalculationParametersRoot data(java.util.Map data) { this.data = data; @@ -76,6 +78,8 @@ public java.util.Map getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(java.util.Map data) { this.data = data; } @@ -100,6 +104,8 @@ public CalculationMeta getMeta() { } + @JsonProperty(JSON_PROPERTY_META) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMeta(CalculationMeta meta) { this.meta = meta; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultComponent.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultComponent.java index 9f5fdd19..d5c38128 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultComponent.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultComponent.java @@ -41,6 +41,7 @@ VaultComponent.JSON_PROPERTY_CURRENCYISOCODE, VaultComponent.JSON_PROPERTY_DATES, VaultComponent.JSON_PROPERTY_SNAPSHOT, + VaultComponent.JSON_PROPERTY_PATH, VaultComponent.JSON_PROPERTY_NAME, VaultComponent.JSON_PROPERTY_CATEGORY }) @@ -66,12 +67,17 @@ public class VaultComponent implements Serializable { public static final String JSON_PROPERTY_SNAPSHOT = "snapshot"; private Boolean snapshot; + public static final String JSON_PROPERTY_PATH = "path"; + private String path; + public static final String JSON_PROPERTY_NAME = "name"; private String name; public static final String JSON_PROPERTY_CATEGORY = "category"; private String category; + public VaultComponent() { + } public VaultComponent id(String id) { this.id = id; @@ -92,6 +98,8 @@ public String getId() { } + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { this.id = id; } @@ -116,6 +124,8 @@ public VaultIdentifier getAccount() { } + @JsonProperty(JSON_PROPERTY_ACCOUNT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccount(VaultIdentifier account) { this.account = account; } @@ -140,6 +150,8 @@ public VaultIdentifier getBenchmark() { } + @JsonProperty(JSON_PROPERTY_BENCHMARK) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBenchmark(VaultIdentifier benchmark) { this.benchmark = benchmark; } @@ -164,6 +176,8 @@ public String getCurrencyisocode() { } + @JsonProperty(JSON_PROPERTY_CURRENCYISOCODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrencyisocode(String currencyisocode) { this.currencyisocode = currencyisocode; } @@ -188,6 +202,8 @@ public VaultDateParameters getDates() { } + @JsonProperty(JSON_PROPERTY_DATES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDates(VaultDateParameters dates) { this.dates = dates; } @@ -212,11 +228,39 @@ public Boolean getSnapshot() { } + @JsonProperty(JSON_PROPERTY_SNAPSHOT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSnapshot(Boolean snapshot) { this.snapshot = snapshot; } + public VaultComponent path(String path) { + this.path = path; + return this; + } + + /** + * The path to the document + * @return path + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The path to the document") + @JsonProperty(JSON_PROPERTY_PATH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getPath() { + return path; + } + + + @JsonProperty(JSON_PROPERTY_PATH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setPath(String path) { + this.path = path; + } + + public VaultComponent name(String name) { this.name = name; return this; @@ -236,6 +280,8 @@ public String getName() { } + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } @@ -260,6 +306,8 @@ public String getCategory() { } + @JsonProperty(JSON_PROPERTY_CATEGORY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCategory(String category) { this.category = category; } @@ -283,13 +331,14 @@ public boolean equals(Object o) { Objects.equals(this.currencyisocode, vaultComponent.currencyisocode) && Objects.equals(this.dates, vaultComponent.dates) && Objects.equals(this.snapshot, vaultComponent.snapshot) && + Objects.equals(this.path, vaultComponent.path) && Objects.equals(this.name, vaultComponent.name) && Objects.equals(this.category, vaultComponent.category); } @Override public int hashCode() { - return Objects.hash(id, account, benchmark, currencyisocode, dates, snapshot, name, category); + return Objects.hash(id, account, benchmark, currencyisocode, dates, snapshot, path, name, category); } @Override @@ -302,6 +351,7 @@ public String toString() { sb.append(" currencyisocode: ").append(toIndentedString(currencyisocode)).append("\n"); sb.append(" dates: ").append(toIndentedString(dates)).append("\n"); sb.append(" snapshot: ").append(toIndentedString(snapshot)).append("\n"); + sb.append(" path: ").append(toIndentedString(path)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" category: ").append(toIndentedString(category)).append("\n"); sb.append("}"); diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultComponentRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultComponentRoot.java index 78b8b594..0f6ea064 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultComponentRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultComponentRoot.java @@ -25,6 +25,10 @@ import factset.analyticsapi.engines.models.VaultComponent; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; import java.io.Serializable; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import factset.analyticsapi.engines.JSON; @@ -45,8 +49,10 @@ public class VaultComponentRoot implements Serializable { private VaultComponent data; public static final String JSON_PROPERTY_META = "meta"; - private Object meta; + private JsonNullable meta = JsonNullable.of(null); + public VaultComponentRoot() { + } public VaultComponentRoot data(VaultComponent data) { this.data = data; @@ -57,6 +63,7 @@ public VaultComponentRoot data(VaultComponent data) { * Get data * @return data **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -66,13 +73,15 @@ public VaultComponent getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setData(VaultComponent data) { this.data = data; } public VaultComponentRoot meta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); return this; } @@ -82,16 +91,26 @@ public VaultComponentRoot meta(Object meta) { **/ @javax.annotation.Nullable @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + @JsonProperty(JSON_PROPERTY_META) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Object getMeta() { + public JsonNullable getMeta_JsonNullable() { return meta; } - + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } public void setMeta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); } @@ -108,12 +127,23 @@ public boolean equals(Object o) { } VaultComponentRoot vaultComponentRoot = (VaultComponentRoot) o; return Objects.equals(this.data, vaultComponentRoot.data) && - Objects.equals(this.meta, vaultComponentRoot.meta); + equalsNullable(this.meta, vaultComponentRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); } @Override public int hashCode() { - return Objects.hash(data, meta); + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; } @Override diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultConfiguration.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultConfiguration.java index 2cc73480..616ef004 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultConfiguration.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultConfiguration.java @@ -47,6 +47,8 @@ public class VaultConfiguration implements Serializable { public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; private java.util.Map accounts = null; + public VaultConfiguration() { + } public VaultConfiguration name(String name) { this.name = name; @@ -67,6 +69,8 @@ public String getName() { } + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } @@ -99,6 +103,8 @@ public java.util.Map getAccounts() { } + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccounts(java.util.Map accounts) { this.accounts = accounts; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultConfigurationRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultConfigurationRoot.java index d58d2b27..685fdde8 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultConfigurationRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultConfigurationRoot.java @@ -25,6 +25,10 @@ import factset.analyticsapi.engines.models.VaultConfiguration; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; import java.io.Serializable; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import factset.analyticsapi.engines.JSON; @@ -45,8 +49,10 @@ public class VaultConfigurationRoot implements Serializable { private VaultConfiguration data; public static final String JSON_PROPERTY_META = "meta"; - private Object meta; + private JsonNullable meta = JsonNullable.of(null); + public VaultConfigurationRoot() { + } public VaultConfigurationRoot data(VaultConfiguration data) { this.data = data; @@ -57,6 +63,7 @@ public VaultConfigurationRoot data(VaultConfiguration data) { * Get data * @return data **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -66,13 +73,15 @@ public VaultConfiguration getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setData(VaultConfiguration data) { this.data = data; } public VaultConfigurationRoot meta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); return this; } @@ -82,16 +91,26 @@ public VaultConfigurationRoot meta(Object meta) { **/ @javax.annotation.Nullable @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + @JsonProperty(JSON_PROPERTY_META) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Object getMeta() { + public JsonNullable getMeta_JsonNullable() { return meta; } - + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } public void setMeta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); } @@ -108,12 +127,23 @@ public boolean equals(Object o) { } VaultConfigurationRoot vaultConfigurationRoot = (VaultConfigurationRoot) o; return Objects.equals(this.data, vaultConfigurationRoot.data) && - Objects.equals(this.meta, vaultConfigurationRoot.meta); + equalsNullable(this.meta, vaultConfigurationRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); } @Override public int hashCode() { - return Objects.hash(data, meta); + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; } @Override diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultConfigurationSummary.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultConfigurationSummary.java index 78240cc2..cfd9d957 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultConfigurationSummary.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultConfigurationSummary.java @@ -42,6 +42,8 @@ public class VaultConfigurationSummary implements Serializable { public static final String JSON_PROPERTY_NAME = "name"; private String name; + public VaultConfigurationSummary() { + } public VaultConfigurationSummary name(String name) { this.name = name; @@ -62,6 +64,8 @@ public String getName() { } + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultConfigurationSummaryRoot.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultConfigurationSummaryRoot.java index 635d7268..31795312 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultConfigurationSummaryRoot.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultConfigurationSummaryRoot.java @@ -25,6 +25,10 @@ import factset.analyticsapi.engines.models.VaultConfigurationSummary; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import org.openapitools.jackson.nullable.JsonNullable; +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.openapitools.jackson.nullable.JsonNullable; +import java.util.NoSuchElementException; import java.io.Serializable; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import factset.analyticsapi.engines.JSON; @@ -45,8 +49,10 @@ public class VaultConfigurationSummaryRoot implements Serializable { private java.util.Map data = new java.util.HashMap(); public static final String JSON_PROPERTY_META = "meta"; - private Object meta; + private JsonNullable meta = JsonNullable.of(null); + public VaultConfigurationSummaryRoot() { + } public VaultConfigurationSummaryRoot data(java.util.Map data) { this.data = data; @@ -62,6 +68,7 @@ public VaultConfigurationSummaryRoot putDataItem(String key, VaultConfigurationS * Get data * @return data **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "") @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -71,13 +78,15 @@ public java.util.Map getData() { } + @JsonProperty(JSON_PROPERTY_DATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setData(java.util.Map data) { this.data = data; } public VaultConfigurationSummaryRoot meta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); return this; } @@ -87,16 +96,26 @@ public VaultConfigurationSummaryRoot meta(Object meta) { **/ @javax.annotation.Nullable @ApiModelProperty(value = "") + @JsonIgnore + + public Object getMeta() { + return meta.orElse(null); + } + @JsonProperty(JSON_PROPERTY_META) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Object getMeta() { + public JsonNullable getMeta_JsonNullable() { return meta; } - + + @JsonProperty(JSON_PROPERTY_META) + public void setMeta_JsonNullable(JsonNullable meta) { + this.meta = meta; + } public void setMeta(Object meta) { - this.meta = meta; + this.meta = JsonNullable.of(meta); } @@ -113,12 +132,23 @@ public boolean equals(Object o) { } VaultConfigurationSummaryRoot vaultConfigurationSummaryRoot = (VaultConfigurationSummaryRoot) o; return Objects.equals(this.data, vaultConfigurationSummaryRoot.data) && - Objects.equals(this.meta, vaultConfigurationSummaryRoot.meta); + equalsNullable(this.meta, vaultConfigurationSummaryRoot.meta); + } + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); } @Override public int hashCode() { - return Objects.hash(data, meta); + return Objects.hash(data, hashCodeNullable(meta)); + } + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; } @Override diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultDateParameters.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultDateParameters.java index 9b88b259..1ff6d48b 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultDateParameters.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultDateParameters.java @@ -51,6 +51,8 @@ public class VaultDateParameters implements Serializable { public static final String JSON_PROPERTY_FREQUENCY = "frequency"; private String frequency; + public VaultDateParameters() { + } public VaultDateParameters startdate(String startdate) { this.startdate = startdate; @@ -71,6 +73,8 @@ public String getStartdate() { } + @JsonProperty(JSON_PROPERTY_STARTDATE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStartdate(String startdate) { this.startdate = startdate; } @@ -85,6 +89,7 @@ public VaultDateParameters enddate(String enddate) { * Calculation's end date. * @return enddate **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "Calculation's end date.") @JsonProperty(JSON_PROPERTY_ENDDATE) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -94,6 +99,8 @@ public String getEnddate() { } + @JsonProperty(JSON_PROPERTY_ENDDATE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setEnddate(String enddate) { this.enddate = enddate; } @@ -108,6 +115,7 @@ public VaultDateParameters frequency(String frequency) { * Calculation's frequency. * @return frequency **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "Calculation's frequency.") @JsonProperty(JSON_PROPERTY_FREQUENCY) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -117,6 +125,8 @@ public String getFrequency() { } + @JsonProperty(JSON_PROPERTY_FREQUENCY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFrequency(String frequency) { this.frequency = frequency; } diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultIdentifier.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultIdentifier.java index b6ea8202..29d470c4 100644 --- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultIdentifier.java +++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/models/VaultIdentifier.java @@ -43,6 +43,8 @@ public class VaultIdentifier implements Serializable { public static final String JSON_PROPERTY_ID = "id"; private String id; + public VaultIdentifier() { + } public VaultIdentifier id(String id) { this.id = id; @@ -53,6 +55,7 @@ public VaultIdentifier id(String id) { * User's FactSet account path OR benchmark. * @return id **/ + @javax.annotation.Nonnull @ApiModelProperty(required = true, value = "User's FactSet account path OR benchmark.") @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) @@ -62,6 +65,8 @@ public String getId() { } + @JsonProperty(JSON_PROPERTY_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setId(String id) { this.id = id; }