From 766e17d7fec54d0e8a0883536f72507ca609afd7 Mon Sep 17 00:00:00 2001 From: factset-sdk-bot Date: Tue, 19 Jan 2021 14:57:16 +0000 Subject: [PATCH] feat(sdk): Auto-commit from 'analyticsapi-engines-sdk-generator' repository PR 8 for SDK version v3.2.0 --- auto-generated-sdk/.openapi-generator-ignore | 2 - auto-generated-sdk/DESCRIPTION | 4 +- auto-generated-sdk/NAMESPACE | 31 + auto-generated-sdk/R/account_directories.R | 4 +- auto-generated-sdk/R/accounts_api.R | 59 +- auto-generated-sdk/R/api.R | 8 + auto-generated-sdk/R/api_client.R | 6 +- .../R/axioma_equity_optimization_parameters.R | 138 +++ auto-generated-sdk/R/calculation.R | 29 +- auto-generated-sdk/R/calculation_status.R | 57 +- .../R/calculation_status_summary.R | 34 +- .../R/calculation_unit_status.R | 50 +- auto-generated-sdk/R/calculations_api.R | 251 ++-- auto-generated-sdk/R/column.R | 4 +- auto-generated-sdk/R/column_statistic.R | 4 +- auto-generated-sdk/R/column_statistics_api.R | 45 +- auto-generated-sdk/R/column_summary.R | 4 +- auto-generated-sdk/R/columns_api.R | 112 +- auto-generated-sdk/R/component_account.R | 4 +- auto-generated-sdk/R/component_benchmark.R | 4 +- auto-generated-sdk/R/component_summary.R | 4 +- auto-generated-sdk/R/components_api.R | 269 +++-- auto-generated-sdk/R/configuration_account.R | 4 +- auto-generated-sdk/R/configurations_api.R | 110 +- auto-generated-sdk/R/currencies_api.R | 45 +- auto-generated-sdk/R/currency.R | 4 +- .../R/date_parameters_summary.R | 4 +- auto-generated-sdk/R/dates_api.R | 114 +- auto-generated-sdk/R/document_directories.R | 4 +- auto-generated-sdk/R/documents_api.R | 362 ++++-- auto-generated-sdk/R/event_summary.R | 108 ++ .../R/fi_calculation_parameters.R | 112 ++ auto-generated-sdk/R/fi_calculations_api.R | 659 ++++++++++ auto-generated-sdk/R/fi_job_settings.R | 87 ++ auto-generated-sdk/R/fi_security.R | 174 +++ .../R/fiab_calculation_parameters.R | 156 +++ .../R/fiab_calculation_status.R | 175 +++ .../R/fiab_calculation_status_summary.R | 86 ++ auto-generated-sdk/R/fiab_calculations_api.R | 619 ++++++++++ auto-generated-sdk/R/fiab_date_parameters.R | 86 ++ auto-generated-sdk/R/fiab_identifier.R | 64 + auto-generated-sdk/R/frequencies_api.R | 127 +- auto-generated-sdk/R/frequency.R | 4 +- auto-generated-sdk/R/group.R | 4 +- auto-generated-sdk/R/groups_api.R | 47 +- auto-generated-sdk/R/optimal_portfolio.R | 129 ++ auto-generated-sdk/R/optimization.R | 108 ++ auto-generated-sdk/R/optimizations_api.R | 615 ++++++++++ auto-generated-sdk/R/optimizer_account.R | 88 ++ .../R/optimizer_account_overrides.R | 130 ++ .../R/optimizer_optimal_holdings.R | 106 ++ auto-generated-sdk/R/optimizer_output_types.R | 114 ++ auto-generated-sdk/R/optimizer_strategy.R | 88 ++ .../R/optimizer_strategy_overrides.R | 153 +++ auto-generated-sdk/R/optimizer_trades_list.R | 85 ++ auto-generated-sdk/R/pa_calculation_column.R | 4 +- auto-generated-sdk/R/pa_calculation_group.R | 4 +- .../R/pa_calculation_parameters.R | 28 +- auto-generated-sdk/R/pa_calculations_api.R | 639 ++++++++++ auto-generated-sdk/R/pa_component.R | 4 +- auto-generated-sdk/R/pa_date_parameters.R | 4 +- auto-generated-sdk/R/pa_identifier.R | 4 +- .../R/pub_calculation_parameters.R | 112 ++ auto-generated-sdk/R/pub_date_parameters.R | 86 ++ auto-generated-sdk/R/pub_identifier.R | 86 ++ auto-generated-sdk/R/spar_benchmark.R | 109 ++ auto-generated-sdk/R/spar_benchmark_api.R | 243 ++++ .../R/spar_calculation_parameters.R | 4 +- auto-generated-sdk/R/spar_calculations_api.R | 628 ++++++++++ auto-generated-sdk/R/spar_date_parameters.R | 4 +- auto-generated-sdk/R/spar_identifier.R | 4 +- auto-generated-sdk/R/stach_extensions.R | 5 +- auto-generated-sdk/R/strategy_documents_api.R | 1065 +++++++++++++++++ auto-generated-sdk/R/utility_api.R | 4 +- .../R/vault_calculation_parameters.R | 28 +- auto-generated-sdk/R/vault_calculations_api.R | 639 ++++++++++ auto-generated-sdk/R/vault_component.R | 4 +- auto-generated-sdk/R/vault_configuration.R | 4 +- .../R/vault_configuration_summary.R | 4 +- auto-generated-sdk/R/vault_date_parameters.R | 4 +- auto-generated-sdk/R/vault_identifier.R | 4 +- auto-generated-sdk/README.md | 58 +- auto-generated-sdk/cran-comments.md | 17 - auto-generated-sdk/docs/AccountsApi.md | 21 +- .../AxiomaEquityOptimizationParameters.md | 11 + auto-generated-sdk/docs/Calculation.md | 7 +- auto-generated-sdk/docs/CalculationStatus.md | 9 +- .../docs/CalculationStatusSummary.md | 4 +- .../docs/CalculationUnitStatus.md | 8 +- auto-generated-sdk/docs/CalculationsApi.md | 77 +- .../docs/ColumnStatisticsApi.md | 13 +- auto-generated-sdk/docs/ColumnSummary.md | 1 + auto-generated-sdk/docs/ColumnsApi.md | 44 +- auto-generated-sdk/docs/ComponentsApi.md | 85 +- auto-generated-sdk/docs/ConfigurationsApi.md | 34 +- auto-generated-sdk/docs/CurrenciesApi.md | 13 +- auto-generated-sdk/docs/DatesApi.md | 38 +- auto-generated-sdk/docs/DocumentsApi.md | 131 +- auto-generated-sdk/docs/EventSummary.md | 10 + .../docs/FIABCalculationParameters.md | 12 + .../docs/FIABCalculationStatus.md | 13 + .../docs/FIABCalculationStatusSummary.md | 9 + .../docs/FIABCalculationsApi.md | 202 ++++ auto-generated-sdk/docs/FIABDateParameters.md | 10 + auto-generated-sdk/docs/FIABIdentifier.md | 8 + .../docs/FICalculationParameters.md | 10 + auto-generated-sdk/docs/FICalculationsApi.md | 212 ++++ auto-generated-sdk/docs/FIJobSettings.md | 9 + auto-generated-sdk/docs/FISecurity.md | 13 + auto-generated-sdk/docs/FrequenciesApi.md | 39 +- auto-generated-sdk/docs/GroupsApi.md | 13 +- auto-generated-sdk/docs/OptimalPortfolio.md | 11 + auto-generated-sdk/docs/Optimization.md | 10 + auto-generated-sdk/docs/OptimizationsApi.md | 204 ++++ auto-generated-sdk/docs/OptimizerAccount.md | 9 + .../docs/OptimizerAccountOverrides.md | 11 + .../docs/OptimizerOptimalHoldings.md | 10 + .../docs/OptimizerOutputTypes.md | 10 + auto-generated-sdk/docs/OptimizerStrategy.md | 9 + .../docs/OptimizerStrategyOverrides.md | 12 + .../docs/OptimizerTradesList.md | 9 + .../docs/PACalculationParameters.md | 9 +- auto-generated-sdk/docs/PACalculationsApi.md | 212 ++++ auto-generated-sdk/docs/PAComponent.md | 6 +- auto-generated-sdk/docs/PADateParameters.md | 1 + auto-generated-sdk/docs/PAIdentifier.md | 2 +- .../docs/PubCalculationParameters.md | 10 + auto-generated-sdk/docs/PubDateParameters.md | 10 + auto-generated-sdk/docs/PubIdentifier.md | 9 + auto-generated-sdk/docs/SPARBenchmark.md | 10 + auto-generated-sdk/docs/SPARBenchmarkApi.md | 76 ++ .../docs/SPARCalculationParameters.md | 2 +- .../docs/SPARCalculationsApi.md | 212 ++++ auto-generated-sdk/docs/SPARDateParameters.md | 1 + auto-generated-sdk/docs/SPARIdentifier.md | 1 + .../docs/StrategyDocumentsApi.md | 348 ++++++ .../docs/VaultCalculationParameters.md | 1 + .../docs/VaultCalculationsApi.md | 212 ++++ .../docs/VaultDateParameters.md | 1 + auto-generated-sdk/docs/VaultIdentifier.md | 1 + auto-generated-sdk/man/AccountsApi.Rd | 55 +- .../man/AxiomaEquityOptimizationParameters.Rd | 109 ++ auto-generated-sdk/man/Calculation.Rd | 4 +- auto-generated-sdk/man/CalculationStatus.Rd | 7 +- .../man/CalculationStatusSummary.Rd | 4 +- .../man/CalculationUnitStatus.Rd | 6 +- auto-generated-sdk/man/CalculationsApi.Rd | 251 ++-- auto-generated-sdk/man/ColumnStatisticsApi.Rd | 41 +- auto-generated-sdk/man/ColumnsApi.Rd | 112 +- auto-generated-sdk/man/ComponentsApi.Rd | 265 ++-- auto-generated-sdk/man/ConfigurationsApi.Rd | 106 +- auto-generated-sdk/man/CurrenciesApi.Rd | 41 +- auto-generated-sdk/man/DatesApi.Rd | 110 +- auto-generated-sdk/man/DocumentsApi.Rd | 312 +++-- auto-generated-sdk/man/EventSummary.Rd | 97 ++ .../man/FIABCalculationParameters.Rd | 108 ++ .../man/FIABCalculationStatus.Rd | 111 ++ .../man/FIABCalculationStatusSummary.Rd | 95 ++ auto-generated-sdk/man/FIABCalculationsApi.Rd | 523 ++++++++ auto-generated-sdk/man/FIABDateParameters.Rd | 95 ++ auto-generated-sdk/man/FIABIdentifier.Rd | 93 ++ .../man/FICalculationParameters.Rd | 97 ++ auto-generated-sdk/man/FICalculationsApi.Rd | 558 +++++++++ auto-generated-sdk/man/FIJobSettings.Rd | 95 ++ auto-generated-sdk/man/FISecurity.Rd | 111 ++ auto-generated-sdk/man/FrequenciesApi.Rd | 123 +- auto-generated-sdk/man/GroupsApi.Rd | 43 +- auto-generated-sdk/man/OptimalPortfolio.Rd | 105 ++ auto-generated-sdk/man/Optimization.Rd | 102 ++ auto-generated-sdk/man/OptimizationsApi.Rd | 526 ++++++++ auto-generated-sdk/man/OptimizerAccount.Rd | 95 ++ .../man/OptimizerAccountOverrides.Rd | 105 ++ .../man/OptimizerOptimalHoldings.Rd | 102 ++ .../man/OptimizerOutputTypes.Rd | 97 ++ auto-generated-sdk/man/OptimizerStrategy.Rd | 95 ++ .../man/OptimizerStrategyOverrides.Rd | 108 ++ auto-generated-sdk/man/OptimizerTradesList.Rd | 95 ++ .../man/PACalculationParameters.Rd | 3 + auto-generated-sdk/man/PACalculationsApi.Rd | 538 +++++++++ .../man/PubCalculationParameters.Rd | 97 ++ auto-generated-sdk/man/PubDateParameters.Rd | 95 ++ auto-generated-sdk/man/PubIdentifier.Rd | 95 ++ auto-generated-sdk/man/SPARBenchmark.Rd | 97 ++ auto-generated-sdk/man/SPARBenchmarkApi.Rd | 222 ++++ auto-generated-sdk/man/SPARCalculationsApi.Rd | 527 ++++++++ .../man/StrategyDocumentsApi.Rd | 858 +++++++++++++ .../man/VaultCalculationParameters.Rd | 3 + .../man/VaultCalculationsApi.Rd | 538 +++++++++ auto-generated-sdk/tests/testthat.R | 4 + 189 files changed, 18576 insertions(+), 1671 deletions(-) create mode 100644 auto-generated-sdk/R/api.R create mode 100644 auto-generated-sdk/R/axioma_equity_optimization_parameters.R create mode 100644 auto-generated-sdk/R/event_summary.R create mode 100644 auto-generated-sdk/R/fi_calculation_parameters.R create mode 100644 auto-generated-sdk/R/fi_calculations_api.R create mode 100644 auto-generated-sdk/R/fi_job_settings.R create mode 100644 auto-generated-sdk/R/fi_security.R create mode 100644 auto-generated-sdk/R/fiab_calculation_parameters.R create mode 100644 auto-generated-sdk/R/fiab_calculation_status.R create mode 100644 auto-generated-sdk/R/fiab_calculation_status_summary.R create mode 100644 auto-generated-sdk/R/fiab_calculations_api.R create mode 100644 auto-generated-sdk/R/fiab_date_parameters.R create mode 100644 auto-generated-sdk/R/fiab_identifier.R create mode 100644 auto-generated-sdk/R/optimal_portfolio.R create mode 100644 auto-generated-sdk/R/optimization.R create mode 100644 auto-generated-sdk/R/optimizations_api.R create mode 100644 auto-generated-sdk/R/optimizer_account.R create mode 100644 auto-generated-sdk/R/optimizer_account_overrides.R create mode 100644 auto-generated-sdk/R/optimizer_optimal_holdings.R create mode 100644 auto-generated-sdk/R/optimizer_output_types.R create mode 100644 auto-generated-sdk/R/optimizer_strategy.R create mode 100644 auto-generated-sdk/R/optimizer_strategy_overrides.R create mode 100644 auto-generated-sdk/R/optimizer_trades_list.R create mode 100644 auto-generated-sdk/R/pa_calculations_api.R create mode 100644 auto-generated-sdk/R/pub_calculation_parameters.R create mode 100644 auto-generated-sdk/R/pub_date_parameters.R create mode 100644 auto-generated-sdk/R/pub_identifier.R create mode 100644 auto-generated-sdk/R/spar_benchmark.R create mode 100644 auto-generated-sdk/R/spar_benchmark_api.R create mode 100644 auto-generated-sdk/R/spar_calculations_api.R create mode 100644 auto-generated-sdk/R/strategy_documents_api.R create mode 100644 auto-generated-sdk/R/vault_calculations_api.R delete mode 100644 auto-generated-sdk/cran-comments.md create mode 100644 auto-generated-sdk/docs/AxiomaEquityOptimizationParameters.md create mode 100644 auto-generated-sdk/docs/EventSummary.md create mode 100644 auto-generated-sdk/docs/FIABCalculationParameters.md create mode 100644 auto-generated-sdk/docs/FIABCalculationStatus.md create mode 100644 auto-generated-sdk/docs/FIABCalculationStatusSummary.md create mode 100644 auto-generated-sdk/docs/FIABCalculationsApi.md create mode 100644 auto-generated-sdk/docs/FIABDateParameters.md create mode 100644 auto-generated-sdk/docs/FIABIdentifier.md create mode 100644 auto-generated-sdk/docs/FICalculationParameters.md create mode 100644 auto-generated-sdk/docs/FICalculationsApi.md create mode 100644 auto-generated-sdk/docs/FIJobSettings.md create mode 100644 auto-generated-sdk/docs/FISecurity.md create mode 100644 auto-generated-sdk/docs/OptimalPortfolio.md create mode 100644 auto-generated-sdk/docs/Optimization.md create mode 100644 auto-generated-sdk/docs/OptimizationsApi.md create mode 100644 auto-generated-sdk/docs/OptimizerAccount.md create mode 100644 auto-generated-sdk/docs/OptimizerAccountOverrides.md create mode 100644 auto-generated-sdk/docs/OptimizerOptimalHoldings.md create mode 100644 auto-generated-sdk/docs/OptimizerOutputTypes.md create mode 100644 auto-generated-sdk/docs/OptimizerStrategy.md create mode 100644 auto-generated-sdk/docs/OptimizerStrategyOverrides.md create mode 100644 auto-generated-sdk/docs/OptimizerTradesList.md create mode 100644 auto-generated-sdk/docs/PACalculationsApi.md create mode 100644 auto-generated-sdk/docs/PubCalculationParameters.md create mode 100644 auto-generated-sdk/docs/PubDateParameters.md create mode 100644 auto-generated-sdk/docs/PubIdentifier.md create mode 100644 auto-generated-sdk/docs/SPARBenchmark.md create mode 100644 auto-generated-sdk/docs/SPARBenchmarkApi.md create mode 100644 auto-generated-sdk/docs/SPARCalculationsApi.md create mode 100644 auto-generated-sdk/docs/StrategyDocumentsApi.md create mode 100644 auto-generated-sdk/docs/VaultCalculationsApi.md create mode 100644 auto-generated-sdk/man/AxiomaEquityOptimizationParameters.Rd create mode 100644 auto-generated-sdk/man/EventSummary.Rd create mode 100644 auto-generated-sdk/man/FIABCalculationParameters.Rd create mode 100644 auto-generated-sdk/man/FIABCalculationStatus.Rd create mode 100644 auto-generated-sdk/man/FIABCalculationStatusSummary.Rd create mode 100644 auto-generated-sdk/man/FIABCalculationsApi.Rd create mode 100644 auto-generated-sdk/man/FIABDateParameters.Rd create mode 100644 auto-generated-sdk/man/FIABIdentifier.Rd create mode 100644 auto-generated-sdk/man/FICalculationParameters.Rd create mode 100644 auto-generated-sdk/man/FICalculationsApi.Rd create mode 100644 auto-generated-sdk/man/FIJobSettings.Rd create mode 100644 auto-generated-sdk/man/FISecurity.Rd create mode 100644 auto-generated-sdk/man/OptimalPortfolio.Rd create mode 100644 auto-generated-sdk/man/Optimization.Rd create mode 100644 auto-generated-sdk/man/OptimizationsApi.Rd create mode 100644 auto-generated-sdk/man/OptimizerAccount.Rd create mode 100644 auto-generated-sdk/man/OptimizerAccountOverrides.Rd create mode 100644 auto-generated-sdk/man/OptimizerOptimalHoldings.Rd create mode 100644 auto-generated-sdk/man/OptimizerOutputTypes.Rd create mode 100644 auto-generated-sdk/man/OptimizerStrategy.Rd create mode 100644 auto-generated-sdk/man/OptimizerStrategyOverrides.Rd create mode 100644 auto-generated-sdk/man/OptimizerTradesList.Rd create mode 100644 auto-generated-sdk/man/PACalculationsApi.Rd create mode 100644 auto-generated-sdk/man/PubCalculationParameters.Rd create mode 100644 auto-generated-sdk/man/PubDateParameters.Rd create mode 100644 auto-generated-sdk/man/PubIdentifier.Rd create mode 100644 auto-generated-sdk/man/SPARBenchmark.Rd create mode 100644 auto-generated-sdk/man/SPARBenchmarkApi.Rd create mode 100644 auto-generated-sdk/man/SPARCalculationsApi.Rd create mode 100644 auto-generated-sdk/man/StrategyDocumentsApi.Rd create mode 100644 auto-generated-sdk/man/VaultCalculationsApi.Rd create mode 100644 auto-generated-sdk/tests/testthat.R diff --git a/auto-generated-sdk/.openapi-generator-ignore b/auto-generated-sdk/.openapi-generator-ignore index 3e2e4fb..7484ee5 100644 --- a/auto-generated-sdk/.openapi-generator-ignore +++ b/auto-generated-sdk/.openapi-generator-ignore @@ -21,5 +21,3 @@ #docs/*.md # Then explicitly reverse the ignore rule for a single file: #!docs/README.md - -tests/testthat.R \ No newline at end of file diff --git a/auto-generated-sdk/DESCRIPTION b/auto-generated-sdk/DESCRIPTION index f6f5a37..b1a8edf 100644 --- a/auto-generated-sdk/DESCRIPTION +++ b/auto-generated-sdk/DESCRIPTION @@ -1,6 +1,6 @@ Package: factset.analyticsapi.engines Title: 'FactSet' Engines API Client -Version: 3.1.0 +Version: 3.2.0 Authors@R: c( person("Analytics API Support", email = "analytics.api.support@factset.com", role = "aut"), person("Akshay Sheth", email = "asheth@factset.com", role = "cre")) @@ -18,4 +18,4 @@ License: Apache License 2.0 LazyData: true Suggests: testthat Imports: jsonlite, httr, R6, base64enc, rlang, factset.protobuf.stach (< 2.0.0) -RoxygenNote: 7.1.0 +RoxygenNote: 7.1.1 diff --git a/auto-generated-sdk/NAMESPACE b/auto-generated-sdk/NAMESPACE index 6739d94..6880500 100644 --- a/auto-generated-sdk/NAMESPACE +++ b/auto-generated-sdk/NAMESPACE @@ -8,6 +8,7 @@ export(ApiException) # Models export(AccountDirectories) +export(AxiomaEquityOptimizationParameters) export(Calculation) export(CalculationStatus) export(CalculationStatusSummary) @@ -22,14 +23,36 @@ export(ConfigurationAccount) export(Currency) export(DateParametersSummary) export(DocumentDirectories) +export(EventSummary) +export(FIABCalculationParameters) +export(FIABCalculationStatus) +export(FIABCalculationStatusSummary) +export(FIABDateParameters) +export(FIABIdentifier) +export(FICalculationParameters) +export(FIJobSettings) +export(FISecurity) export(Frequency) export(Group) +export(OptimalPortfolio) +export(Optimization) +export(OptimizerAccount) +export(OptimizerAccountOverrides) +export(OptimizerOptimalHoldings) +export(OptimizerOutputTypes) +export(OptimizerStrategy) +export(OptimizerStrategyOverrides) +export(OptimizerTradesList) export(PACalculationColumn) export(PACalculationGroup) export(PACalculationParameters) export(PAComponent) export(PADateParameters) export(PAIdentifier) +export(PubCalculationParameters) +export(PubDateParameters) +export(PubIdentifier) +export(SPARBenchmark) export(SPARCalculationParameters) export(SPARDateParameters) export(SPARIdentifier) @@ -50,7 +73,15 @@ export(ConfigurationsApi) export(CurrenciesApi) export(DatesApi) export(DocumentsApi) +export(FIABCalculationsApi) +export(FICalculationsApi) export(FrequenciesApi) export(GroupsApi) +export(OptimizationsApi) +export(PACalculationsApi) +export(SPARBenchmarkApi) +export(SPARCalculationsApi) +export(StrategyDocumentsApi) +export(VaultCalculationsApi) export(UtilityApi) export(StachExtensions) \ No newline at end of file diff --git a/auto-generated-sdk/R/account_directories.R b/auto-generated-sdk/R/account_directories.R index 4044df3..1096161 100644 --- a/auto-generated-sdk/R/account_directories.R +++ b/auto-generated-sdk/R/account_directories.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/accounts_api.R b/auto-generated-sdk/R/accounts_api.R index c9686d2..87f5b1b 100644 --- a/auto-generated-sdk/R/accounts_api.R +++ b/auto-generated-sdk/R/accounts_api.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech @@ -29,11 +29,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 400 | Invalid query parameter or value provided #' @@ -41,11 +41,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication #' @@ -53,11 +53,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials #' @@ -65,11 +62,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 404 | Path not found #' @@ -77,11 +74,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json #' @@ -89,11 +86,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting #' @@ -101,11 +108,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in some time #' @@ -113,11 +117,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' @@ -129,7 +130,7 @@ #' #################### GetAccounts #################### #' #' library(factset.analyticsapi.engines) -#' var.path <- 'path_example' # character | The directory to get the accounts and sub-directories in +#' var.path <- '' # character | The directory to get the accounts and sub-directories in #' #' #Get accounts and sub-directories in a directory #' api.instance <- AccountsApi$new() diff --git a/auto-generated-sdk/R/api.R b/auto-generated-sdk/R/api.R new file mode 100644 index 0000000..ed8b7b7 --- /dev/null +++ b/auto-generated-sdk/R/api.R @@ -0,0 +1,8 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + diff --git a/auto-generated-sdk/R/api_client.R b/auto-generated-sdk/R/api_client.R index 5fe6fee..cdae1e9 100644 --- a/auto-generated-sdk/R/api_client.R +++ b/auto-generated-sdk/R/api_client.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech @@ -40,7 +40,7 @@ ApiClient <- R6::R6Class( # base path of all requests basePath = "https://api.factset.com", # user agent in the HTTP request - userAgent = "engines-api/3.1.0/r", + userAgent = "engines-api/3.2.0/r", # default headers in the HTTP request defaultHeaders = NULL, # username (HTTP basic authentication) diff --git a/auto-generated-sdk/R/axioma_equity_optimization_parameters.R b/auto-generated-sdk/R/axioma_equity_optimization_parameters.R new file mode 100644 index 0000000..59848e1 --- /dev/null +++ b/auto-generated-sdk/R/axioma_equity_optimization_parameters.R @@ -0,0 +1,138 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title AxiomaEquityOptimizationParameters +#' @description AxiomaEquityOptimizationParameters Class +#' @format An \code{R6Class} generator object +#' @field strategy \link{OptimizerStrategy} +#' +#' @field account \link{OptimizerAccount} [optional] +#' +#' @field optimization \link{Optimization} [optional] +#' +#' @field outputtypes \link{OptimizerOutputTypes} +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +AxiomaEquityOptimizationParameters <- R6::R6Class( + 'AxiomaEquityOptimizationParameters', + public = list( + `strategy` = NULL, + `account` = NULL, + `optimization` = NULL, + `outputtypes` = NULL, + initialize = function(`strategy`, `outputtypes`, `account`=NULL, `optimization`=NULL, ...){ + local.optional.var <- list(...) + if (!missing(`strategy`)) { + stopifnot(R6::is.R6(`strategy`)) + self$`strategy` <- `strategy` + } + if (!missing(`outputtypes`)) { + stopifnot(R6::is.R6(`outputtypes`)) + self$`outputtypes` <- `outputtypes` + } + if (!is.null(`account`)) { + stopifnot(R6::is.R6(`account`)) + self$`account` <- `account` + } + if (!is.null(`optimization`)) { + stopifnot(R6::is.R6(`optimization`)) + self$`optimization` <- `optimization` + } + }, + toJSON = function() { + AxiomaEquityOptimizationParametersObject <- list() + if (!is.null(self$`strategy`)) { + AxiomaEquityOptimizationParametersObject[['strategy']] <- + self$`strategy`$toJSON() + } + if (!is.null(self$`account`)) { + AxiomaEquityOptimizationParametersObject[['account']] <- + self$`account`$toJSON() + } + if (!is.null(self$`optimization`)) { + AxiomaEquityOptimizationParametersObject[['optimization']] <- + self$`optimization`$toJSON() + } + if (!is.null(self$`outputtypes`)) { + AxiomaEquityOptimizationParametersObject[['outputtypes']] <- + self$`outputtypes`$toJSON() + } + + AxiomaEquityOptimizationParametersObject + }, + fromJSON = function(AxiomaEquityOptimizationParametersJson) { + AxiomaEquityOptimizationParametersObject <- jsonlite::fromJSON(AxiomaEquityOptimizationParametersJson) + if (!is.null(AxiomaEquityOptimizationParametersObject$`strategy`)) { + strategyObject <- OptimizerStrategy$new() + strategyObject$fromJSON(jsonlite::toJSON(AxiomaEquityOptimizationParametersObject$strategy, auto_unbox = TRUE, digits = NA)) + self$`strategy` <- strategyObject + } + if (!is.null(AxiomaEquityOptimizationParametersObject$`account`)) { + accountObject <- OptimizerAccount$new() + accountObject$fromJSON(jsonlite::toJSON(AxiomaEquityOptimizationParametersObject$account, auto_unbox = TRUE, digits = NA)) + self$`account` <- accountObject + } + if (!is.null(AxiomaEquityOptimizationParametersObject$`optimization`)) { + optimizationObject <- Optimization$new() + optimizationObject$fromJSON(jsonlite::toJSON(AxiomaEquityOptimizationParametersObject$optimization, auto_unbox = TRUE, digits = NA)) + self$`optimization` <- optimizationObject + } + if (!is.null(AxiomaEquityOptimizationParametersObject$`outputtypes`)) { + outputtypesObject <- OptimizerOutputTypes$new() + outputtypesObject$fromJSON(jsonlite::toJSON(AxiomaEquityOptimizationParametersObject$outputtypes, auto_unbox = TRUE, digits = NA)) + self$`outputtypes` <- outputtypesObject + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`strategy`)) { + sprintf( + '"strategy": + %s + ', + jsonlite::toJSON(self$`strategy`$toJSON(), auto_unbox=TRUE, digits = NA) + )}, + if (!is.null(self$`account`)) { + sprintf( + '"account": + %s + ', + jsonlite::toJSON(self$`account`$toJSON(), auto_unbox=TRUE, digits = NA) + )}, + if (!is.null(self$`optimization`)) { + sprintf( + '"optimization": + %s + ', + jsonlite::toJSON(self$`optimization`$toJSON(), auto_unbox=TRUE, digits = NA) + )}, + if (!is.null(self$`outputtypes`)) { + sprintf( + '"outputtypes": + %s + ', + jsonlite::toJSON(self$`outputtypes`$toJSON(), auto_unbox=TRUE, digits = NA) + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(AxiomaEquityOptimizationParametersJson) { + AxiomaEquityOptimizationParametersObject <- jsonlite::fromJSON(AxiomaEquityOptimizationParametersJson) + self$`strategy` <- OptimizerStrategy$new()$fromJSON(jsonlite::toJSON(AxiomaEquityOptimizationParametersObject$strategy, auto_unbox = TRUE, digits = NA)) + self$`account` <- OptimizerAccount$new()$fromJSON(jsonlite::toJSON(AxiomaEquityOptimizationParametersObject$account, auto_unbox = TRUE, digits = NA)) + self$`optimization` <- Optimization$new()$fromJSON(jsonlite::toJSON(AxiomaEquityOptimizationParametersObject$optimization, auto_unbox = TRUE, digits = NA)) + self$`outputtypes` <- OptimizerOutputTypes$new()$fromJSON(jsonlite::toJSON(AxiomaEquityOptimizationParametersObject$outputtypes, auto_unbox = TRUE, digits = NA)) + self + } + ) +) diff --git a/auto-generated-sdk/R/calculation.R b/auto-generated-sdk/R/calculation.R index f650b7a..cb22868 100644 --- a/auto-generated-sdk/R/calculation.R +++ b/auto-generated-sdk/R/calculation.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech @@ -16,6 +16,8 @@ #' #' @field vault named list( \link{VaultCalculationParameters} ) [optional] #' +#' @field pub named list( \link{PubCalculationParameters} ) [optional] +#' #' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON @@ -26,7 +28,8 @@ Calculation <- R6::R6Class( `pa` = NULL, `spar` = NULL, `vault` = NULL, - initialize = function(`pa`=NULL, `spar`=NULL, `vault`=NULL, ...){ + `pub` = NULL, + initialize = function(`pa`=NULL, `spar`=NULL, `vault`=NULL, `pub`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`pa`)) { stopifnot(is.vector(`pa`), length(`pa`) != 0) @@ -43,6 +46,11 @@ Calculation <- R6::R6Class( sapply(`vault`, function(x) stopifnot(R6::is.R6(x))) self$`vault` <- `vault` } + if (!is.null(`pub`)) { + stopifnot(is.vector(`pub`), length(`pub`) != 0) + sapply(`pub`, function(x) stopifnot(R6::is.R6(x))) + self$`pub` <- `pub` + } }, toJSON = function() { CalculationObject <- list() @@ -58,6 +66,10 @@ Calculation <- R6::R6Class( CalculationObject[['vault']] <- lapply(self$`vault`, function(x) x$toJSON()) } + if (!is.null(self$`pub`)) { + CalculationObject[['pub']] <- + lapply(self$`pub`, function(x) x$toJSON()) + } CalculationObject }, @@ -72,6 +84,9 @@ Calculation <- R6::R6Class( if (!is.null(CalculationObject$`vault`)) { self$`vault` <- ApiClient$new()$deserializeObj(CalculationObject$`vault`, "map(VaultCalculationParameters)", loadNamespace("factset.analyticsapi.engines")) } + if (!is.null(CalculationObject$`pub`)) { + self$`pub` <- ApiClient$new()$deserializeObj(CalculationObject$`pub`, "map(PubCalculationParameters)", loadNamespace("factset.analyticsapi.engines")) + } }, toJSONString = function() { jsoncontent <- c( @@ -95,6 +110,13 @@ Calculation <- R6::R6Class( %s ', jsonlite::toJSON(lapply(self$`vault`, function(x){ x$toJSON() }), auto_unbox = TRUE, digits=NA) + )}, + if (!is.null(self$`pub`)) { + sprintf( + '"pub": + %s +', + jsonlite::toJSON(lapply(self$`pub`, function(x){ x$toJSON() }), auto_unbox = TRUE, digits=NA) )} ) jsoncontent <- paste(jsoncontent, collapse = ",") @@ -105,6 +127,7 @@ Calculation <- R6::R6Class( self$`pa` <- ApiClient$new()$deserializeObj(CalculationObject$`pa`, "map(PACalculationParameters)", loadNamespace("factset.analyticsapi.engines")) self$`spar` <- ApiClient$new()$deserializeObj(CalculationObject$`spar`, "map(SPARCalculationParameters)", loadNamespace("factset.analyticsapi.engines")) self$`vault` <- ApiClient$new()$deserializeObj(CalculationObject$`vault`, "map(VaultCalculationParameters)", loadNamespace("factset.analyticsapi.engines")) + self$`pub` <- ApiClient$new()$deserializeObj(CalculationObject$`pub`, "map(PubCalculationParameters)", loadNamespace("factset.analyticsapi.engines")) self } ) diff --git a/auto-generated-sdk/R/calculation_status.R b/auto-generated-sdk/R/calculation_status.R index 267416c..64d2206 100644 --- a/auto-generated-sdk/R/calculation_status.R +++ b/auto-generated-sdk/R/calculation_status.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech @@ -12,7 +12,7 @@ #' @format An \code{R6Class} generator object #' @field status character [optional] #' -#' @field points integer [optional] +#' @field units integer [optional] #' #' @field pa named list( \link{CalculationUnitStatus} ) [optional] #' @@ -20,6 +20,8 @@ #' #' @field vault named list( \link{CalculationUnitStatus} ) [optional] #' +#' @field pub named list( \link{CalculationUnitStatus} ) [optional] +#' #' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON @@ -28,19 +30,20 @@ CalculationStatus <- R6::R6Class( 'CalculationStatus', public = list( `status` = NULL, - `points` = NULL, + `units` = NULL, `pa` = NULL, `spar` = NULL, `vault` = NULL, - initialize = function(`status`=NULL, `points`=NULL, `pa`=NULL, `spar`=NULL, `vault`=NULL, ...){ + `pub` = NULL, + initialize = function(`status`=NULL, `units`=NULL, `pa`=NULL, `spar`=NULL, `vault`=NULL, `pub`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`status`)) { stopifnot(is.character(`status`), length(`status`) == 1) self$`status` <- `status` } - if (!is.null(`points`)) { - stopifnot(is.numeric(`points`), length(`points`) == 1) - self$`points` <- `points` + if (!is.null(`units`)) { + stopifnot(is.numeric(`units`), length(`units`) == 1) + self$`units` <- `units` } if (!is.null(`pa`)) { stopifnot(is.vector(`pa`), length(`pa`) != 0) @@ -57,6 +60,11 @@ CalculationStatus <- R6::R6Class( sapply(`vault`, function(x) stopifnot(R6::is.R6(x))) self$`vault` <- `vault` } + if (!is.null(`pub`)) { + stopifnot(is.vector(`pub`), length(`pub`) != 0) + sapply(`pub`, function(x) stopifnot(R6::is.R6(x))) + self$`pub` <- `pub` + } }, toJSON = function() { CalculationStatusObject <- list() @@ -64,9 +72,9 @@ CalculationStatus <- R6::R6Class( CalculationStatusObject[['status']] <- self$`status` } - if (!is.null(self$`points`)) { - CalculationStatusObject[['points']] <- - self$`points` + if (!is.null(self$`units`)) { + CalculationStatusObject[['units']] <- + self$`units` } if (!is.null(self$`pa`)) { CalculationStatusObject[['pa']] <- @@ -80,6 +88,10 @@ CalculationStatus <- R6::R6Class( CalculationStatusObject[['vault']] <- lapply(self$`vault`, function(x) x$toJSON()) } + if (!is.null(self$`pub`)) { + CalculationStatusObject[['pub']] <- + lapply(self$`pub`, function(x) x$toJSON()) + } CalculationStatusObject }, @@ -88,8 +100,8 @@ CalculationStatus <- R6::R6Class( if (!is.null(CalculationStatusObject$`status`)) { self$`status` <- CalculationStatusObject$`status` } - if (!is.null(CalculationStatusObject$`points`)) { - self$`points` <- CalculationStatusObject$`points` + if (!is.null(CalculationStatusObject$`units`)) { + self$`units` <- CalculationStatusObject$`units` } if (!is.null(CalculationStatusObject$`pa`)) { self$`pa` <- ApiClient$new()$deserializeObj(CalculationStatusObject$`pa`, "map(CalculationUnitStatus)", loadNamespace("factset.analyticsapi.engines")) @@ -100,6 +112,9 @@ CalculationStatus <- R6::R6Class( if (!is.null(CalculationStatusObject$`vault`)) { self$`vault` <- ApiClient$new()$deserializeObj(CalculationStatusObject$`vault`, "map(CalculationUnitStatus)", loadNamespace("factset.analyticsapi.engines")) } + if (!is.null(CalculationStatusObject$`pub`)) { + self$`pub` <- ApiClient$new()$deserializeObj(CalculationStatusObject$`pub`, "map(CalculationUnitStatus)", loadNamespace("factset.analyticsapi.engines")) + } }, toJSONString = function() { jsoncontent <- c( @@ -110,12 +125,12 @@ CalculationStatus <- R6::R6Class( ', self$`status` )}, - if (!is.null(self$`points`)) { + if (!is.null(self$`units`)) { sprintf( - '"points": + '"units": %d ', - self$`points` + self$`units` )}, if (!is.null(self$`pa`)) { sprintf( @@ -137,6 +152,13 @@ CalculationStatus <- R6::R6Class( %s ', jsonlite::toJSON(lapply(self$`vault`, function(x){ x$toJSON() }), auto_unbox = TRUE, digits=NA) + )}, + if (!is.null(self$`pub`)) { + sprintf( + '"pub": + %s +', + jsonlite::toJSON(lapply(self$`pub`, function(x){ x$toJSON() }), auto_unbox = TRUE, digits=NA) )} ) jsoncontent <- paste(jsoncontent, collapse = ",") @@ -145,10 +167,11 @@ CalculationStatus <- R6::R6Class( fromJSONString = function(CalculationStatusJson) { CalculationStatusObject <- jsonlite::fromJSON(CalculationStatusJson) self$`status` <- CalculationStatusObject$`status` - self$`points` <- CalculationStatusObject$`points` + self$`units` <- CalculationStatusObject$`units` self$`pa` <- ApiClient$new()$deserializeObj(CalculationStatusObject$`pa`, "map(CalculationUnitStatus)", loadNamespace("factset.analyticsapi.engines")) self$`spar` <- ApiClient$new()$deserializeObj(CalculationStatusObject$`spar`, "map(CalculationUnitStatus)", loadNamespace("factset.analyticsapi.engines")) self$`vault` <- ApiClient$new()$deserializeObj(CalculationStatusObject$`vault`, "map(CalculationUnitStatus)", loadNamespace("factset.analyticsapi.engines")) + self$`pub` <- ApiClient$new()$deserializeObj(CalculationStatusObject$`pub`, "map(CalculationUnitStatus)", loadNamespace("factset.analyticsapi.engines")) self } ) diff --git a/auto-generated-sdk/R/calculation_status_summary.R b/auto-generated-sdk/R/calculation_status_summary.R index 32029f5..a71f5fc 100644 --- a/auto-generated-sdk/R/calculation_status_summary.R +++ b/auto-generated-sdk/R/calculation_status_summary.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech @@ -12,7 +12,7 @@ #' @format An \code{R6Class} generator object #' @field status character [optional] #' -#' @field points integer [optional] +#' @field units integer [optional] #' #' @field requestTime character [optional] #' @@ -26,18 +26,18 @@ CalculationStatusSummary <- R6::R6Class( 'CalculationStatusSummary', public = list( `status` = NULL, - `points` = NULL, + `units` = NULL, `requestTime` = NULL, `lastPollTime` = NULL, - initialize = function(`status`=NULL, `points`=NULL, `requestTime`=NULL, `lastPollTime`=NULL, ...){ + initialize = function(`status`=NULL, `units`=NULL, `requestTime`=NULL, `lastPollTime`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`status`)) { stopifnot(is.character(`status`), length(`status`) == 1) self$`status` <- `status` } - if (!is.null(`points`)) { - stopifnot(is.numeric(`points`), length(`points`) == 1) - self$`points` <- `points` + if (!is.null(`units`)) { + stopifnot(is.numeric(`units`), length(`units`) == 1) + self$`units` <- `units` } if (!is.null(`requestTime`)) { stopifnot(is.character(`requestTime`), length(`requestTime`) == 1) @@ -54,9 +54,9 @@ CalculationStatusSummary <- R6::R6Class( CalculationStatusSummaryObject[['status']] <- self$`status` } - if (!is.null(self$`points`)) { - CalculationStatusSummaryObject[['points']] <- - self$`points` + if (!is.null(self$`units`)) { + CalculationStatusSummaryObject[['units']] <- + self$`units` } if (!is.null(self$`requestTime`)) { CalculationStatusSummaryObject[['requestTime']] <- @@ -74,8 +74,8 @@ CalculationStatusSummary <- R6::R6Class( if (!is.null(CalculationStatusSummaryObject$`status`)) { self$`status` <- CalculationStatusSummaryObject$`status` } - if (!is.null(CalculationStatusSummaryObject$`points`)) { - self$`points` <- CalculationStatusSummaryObject$`points` + if (!is.null(CalculationStatusSummaryObject$`units`)) { + self$`units` <- CalculationStatusSummaryObject$`units` } if (!is.null(CalculationStatusSummaryObject$`requestTime`)) { self$`requestTime` <- CalculationStatusSummaryObject$`requestTime` @@ -93,12 +93,12 @@ CalculationStatusSummary <- R6::R6Class( ', self$`status` )}, - if (!is.null(self$`points`)) { + if (!is.null(self$`units`)) { sprintf( - '"points": + '"units": %d ', - self$`points` + self$`units` )}, if (!is.null(self$`requestTime`)) { sprintf( @@ -121,7 +121,7 @@ CalculationStatusSummary <- R6::R6Class( fromJSONString = function(CalculationStatusSummaryJson) { CalculationStatusSummaryObject <- jsonlite::fromJSON(CalculationStatusSummaryJson) self$`status` <- CalculationStatusSummaryObject$`status` - self$`points` <- CalculationStatusSummaryObject$`points` + self$`units` <- CalculationStatusSummaryObject$`units` self$`requestTime` <- CalculationStatusSummaryObject$`requestTime` self$`lastPollTime` <- CalculationStatusSummaryObject$`lastPollTime` self diff --git a/auto-generated-sdk/R/calculation_unit_status.R b/auto-generated-sdk/R/calculation_unit_status.R index bd5b82e..80defe7 100644 --- a/auto-generated-sdk/R/calculation_unit_status.R +++ b/auto-generated-sdk/R/calculation_unit_status.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech @@ -12,12 +12,12 @@ #' @format An \code{R6Class} generator object #' @field status character [optional] #' -#' @field points integer [optional] -#' #' @field error character [optional] #' #' @field result character [optional] #' +#' @field progress character [optional] +#' #' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON @@ -26,19 +26,15 @@ CalculationUnitStatus <- R6::R6Class( 'CalculationUnitStatus', public = list( `status` = NULL, - `points` = NULL, `error` = NULL, `result` = NULL, - initialize = function(`status`=NULL, `points`=NULL, `error`=NULL, `result`=NULL, ...){ + `progress` = NULL, + initialize = function(`status`=NULL, `error`=NULL, `result`=NULL, `progress`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`status`)) { stopifnot(is.character(`status`), length(`status`) == 1) self$`status` <- `status` } - if (!is.null(`points`)) { - stopifnot(is.numeric(`points`), length(`points`) == 1) - self$`points` <- `points` - } if (!is.null(`error`)) { stopifnot(is.character(`error`), length(`error`) == 1) self$`error` <- `error` @@ -47,6 +43,10 @@ CalculationUnitStatus <- R6::R6Class( stopifnot(is.character(`result`), length(`result`) == 1) self$`result` <- `result` } + if (!is.null(`progress`)) { + stopifnot(is.character(`progress`), length(`progress`) == 1) + self$`progress` <- `progress` + } }, toJSON = function() { CalculationUnitStatusObject <- list() @@ -54,10 +54,6 @@ CalculationUnitStatus <- R6::R6Class( CalculationUnitStatusObject[['status']] <- self$`status` } - if (!is.null(self$`points`)) { - CalculationUnitStatusObject[['points']] <- - self$`points` - } if (!is.null(self$`error`)) { CalculationUnitStatusObject[['error']] <- self$`error` @@ -66,6 +62,10 @@ CalculationUnitStatus <- R6::R6Class( CalculationUnitStatusObject[['result']] <- self$`result` } + if (!is.null(self$`progress`)) { + CalculationUnitStatusObject[['progress']] <- + self$`progress` + } CalculationUnitStatusObject }, @@ -74,15 +74,15 @@ CalculationUnitStatus <- R6::R6Class( if (!is.null(CalculationUnitStatusObject$`status`)) { self$`status` <- CalculationUnitStatusObject$`status` } - if (!is.null(CalculationUnitStatusObject$`points`)) { - self$`points` <- CalculationUnitStatusObject$`points` - } if (!is.null(CalculationUnitStatusObject$`error`)) { self$`error` <- CalculationUnitStatusObject$`error` } if (!is.null(CalculationUnitStatusObject$`result`)) { self$`result` <- CalculationUnitStatusObject$`result` } + if (!is.null(CalculationUnitStatusObject$`progress`)) { + self$`progress` <- CalculationUnitStatusObject$`progress` + } }, toJSONString = function() { jsoncontent <- c( @@ -93,13 +93,6 @@ CalculationUnitStatus <- R6::R6Class( ', self$`status` )}, - if (!is.null(self$`points`)) { - sprintf( - '"points": - %d - ', - self$`points` - )}, if (!is.null(self$`error`)) { sprintf( '"error": @@ -113,6 +106,13 @@ CalculationUnitStatus <- R6::R6Class( "%s" ', self$`result` + )}, + if (!is.null(self$`progress`)) { + sprintf( + '"progress": + "%s" + ', + self$`progress` )} ) jsoncontent <- paste(jsoncontent, collapse = ",") @@ -121,9 +121,9 @@ CalculationUnitStatus <- R6::R6Class( fromJSONString = function(CalculationUnitStatusJson) { CalculationUnitStatusObject <- jsonlite::fromJSON(CalculationUnitStatusJson) self$`status` <- CalculationUnitStatusObject$`status` - self$`points` <- CalculationUnitStatusObject$`points` self$`error` <- CalculationUnitStatusObject$`error` self$`result` <- CalculationUnitStatusObject$`result` + self$`progress` <- CalculationUnitStatusObject$`progress` self } ) diff --git a/auto-generated-sdk/R/calculations_api.R b/auto-generated-sdk/R/calculations_api.R index 7c95492..46032dc 100644 --- a/auto-generated-sdk/R/calculations_api.R +++ b/auto-generated-sdk/R/calculations_api.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech @@ -28,11 +28,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 400 | Invalid identifier provided. #' @@ -40,11 +40,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication. #' @@ -52,11 +52,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials. #' @@ -64,11 +61,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 404 | There was no request for the identifier provided, or the request was already canceled for the provided identifier. #' @@ -76,11 +73,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. #' @@ -88,11 +95,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in sometime. #' @@ -100,11 +104,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' @@ -123,12 +124,12 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr #' Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 400 | Invalid identifier provided. #' @@ -136,12 +137,12 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr #' Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication. #' @@ -149,12 +150,9 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr #' Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials. #' @@ -162,12 +160,12 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr #' Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 404 | Provided identifier was not a request, or the request was cancelled. #' @@ -175,12 +173,12 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr #' Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. #' @@ -188,12 +186,23 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr #' Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. #' @@ -201,12 +210,9 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr #' Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in sometime. #' @@ -214,12 +220,9 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr #' Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' @@ -237,11 +240,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication. #' @@ -249,11 +252,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials. #' @@ -261,11 +261,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. #' @@ -273,11 +273,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. #' @@ -285,11 +295,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in sometime. #' @@ -297,18 +304,17 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' #' \strong{ RunCalculation } \emph{ Run calculation } -#' This endpoint creates a new calculation and runs the set of calculation units specified in the POST body. This must be used first before get status or cancelling endpoints with a calculation id. A successful response will contain the URL to check the status of the calculation request. Remarks: * Maximum 25 points allowed per calculation and maximum 500 points allowed across all simultaneous calculations. (Refer API documentation for more information) * Any settings in POST body will act as a one-time override over the settings saved in the PA/SPAR/Vault template. +#' This endpoint creates a new calculation and runs the set of calculation units specified in the POST body. This must be used first before get status or cancelling endpoints with a calculation id. A successful response will contain the URL to check the status of the calculation request. Remarks: * Maximum 500 units allowed across all simultaneous calculations. (Refer API documentation for more information) * Any settings in POST body will act as a one-time override over the settings saved in the PA/SPAR/Vault template. #' #' \itemize{ +#' \item \emph{ @param } x.factset.content.organization character +#' \item \emph{ @param } x.factset.content.type character #' \item \emph{ @param } calculation \link{Calculation} #' #' \item On encountering errors, an error of subclass ApiException will be thrown. @@ -319,14 +325,16 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' Location \tab URL to check status of the request. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr #' X-FactSet-Api-Points-Remaining \tab Number of points remaining till points limit reached. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' X-FactSet-Api-Units-Limit \tab Maximum units limit across all batches. \cr +#' X-FactSet-Api-Units-Remaining \tab Number of units remaining till units limit reached. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' Location \tab URL to check status of the request. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 400 | Invalid POST body. #' @@ -334,14 +342,15 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr #' X-FactSet-Api-Points-Remaining \tab Number of points remaining till points limit reached. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' X-FactSet-Api-Units-Limit \tab Maximum units limit across all batches. \cr +#' X-FactSet-Api-Units-Remaining \tab Number of units remaining till units limit reached. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' Location \tab URL to check status of the request. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication. #' @@ -349,14 +358,12 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr #' X-FactSet-Api-Points-Remaining \tab Number of points remaining till points limit reached. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' Location \tab URL to check status of the request. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Units-Limit \tab Maximum units limit across all batches. \cr +#' X-FactSet-Api-Units-Remaining \tab Number of units remaining till units limit reached. \cr #' } #' \item status code : 403 | User is forbidden with current credentials. #' @@ -364,14 +371,15 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr #' X-FactSet-Api-Points-Remaining \tab Number of points remaining till points limit reached. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' X-FactSet-Api-Units-Limit \tab Maximum units limit across all batches. \cr +#' X-FactSet-Api-Units-Remaining \tab Number of units remaining till units limit reached. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' Location \tab URL to check status of the request. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 415 | Missing/Invalid Content-Type header. Header needs to be set to application/json. #' @@ -379,14 +387,15 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr #' X-FactSet-Api-Points-Remaining \tab Number of points remaining till points limit reached. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' X-FactSet-Api-Units-Limit \tab Maximum units limit across all batches. \cr +#' X-FactSet-Api-Units-Remaining \tab Number of units remaining till units limit reached. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' Location \tab URL to check status of the request. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 429 | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish / expire. #' @@ -394,14 +403,16 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr #' X-FactSet-Api-Points-Remaining \tab Number of points remaining till points limit reached. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' X-FactSet-Api-Units-Limit \tab Maximum units limit across all batches. \cr +#' X-FactSet-Api-Units-Remaining \tab Number of units remaining till units limit reached. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' Location \tab URL to check status of the request. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. #' @@ -409,14 +420,12 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr #' X-FactSet-Api-Points-Remaining \tab Number of points remaining till points limit reached. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' Location \tab URL to check status of the request. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Units-Limit \tab Maximum units limit across all batches. \cr +#' X-FactSet-Api-Units-Remaining \tab Number of units remaining till units limit reached. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in sometime. #' @@ -424,14 +433,12 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr #' X-FactSet-Api-Points-Remaining \tab Number of points remaining till points limit reached. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' Location \tab URL to check status of the request. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Units-Limit \tab Maximum units limit across all batches. \cr +#' X-FactSet-Api-Units-Remaining \tab Number of units remaining till units limit reached. \cr #' } #' } #' @@ -533,6 +540,8 @@ #' #################### RunCalculation #################### #' #' library(factset.analyticsapi.engines) +#' var.x.factset.content.organization <- 'x.factset.content.organization_example' # character | For specifying the format of the calculation result. Accepted values are \"column\" or \"row\" or \"simplifiedrow\" +#' var.x.factset.content.type <- 'x.factset.content.type_example' # character | For specifying the content type of the calculation result. Accepted values are either \"application/json\" or \"application/x-protobuf\" #' var.calculation <- Calculation$new() # Calculation | #' #' #Run calculation @@ -545,7 +554,7 @@ #' api.instance$apiClient$password <- ''; #' #'result <- tryCatch( -#' api.instance$RunCalculation(calculation=var.calculation), +#' api.instance$RunCalculation(x.factset.content.organization=var.x.factset.content.organization, x.factset.content.type=var.x.factset.content.type, calculation=var.calculation), #' ApiException = function(ex) ex #' ) #' # In case of error, print the error object @@ -760,8 +769,8 @@ CalculationsApi <- R6::R6Class( rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) } }, - RunCalculation = function(calculation=NULL, ...){ - apiResponse <- self$RunCalculationWithHttpInfo(calculation, ...) + RunCalculation = function(x.factset.content.organization=NULL, x.factset.content.type=NULL, calculation=NULL, ...){ + apiResponse <- self$RunCalculationWithHttpInfo(x.factset.content.organization, x.factset.content.type, calculation, ...) resp <- apiResponse$response if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { apiResponse$content @@ -774,11 +783,15 @@ CalculationsApi <- R6::R6Class( } }, - RunCalculationWithHttpInfo = function(calculation=NULL, ...){ + RunCalculationWithHttpInfo = function(x.factset.content.organization=NULL, x.factset.content.type=NULL, calculation=NULL, ...){ args <- list(...) queryParams <- list() headerParams <- c() + headerParams['x-factset-content-organization'] <- `x.factset.content.organization` + + headerParams['x-factset-content-type'] <- `x.factset.content.type` + if (!missing(`calculation`)) { body <- `calculation`$toJSONString() } else { diff --git a/auto-generated-sdk/R/column.R b/auto-generated-sdk/R/column.R index bf2ca78..27586fc 100644 --- a/auto-generated-sdk/R/column.R +++ b/auto-generated-sdk/R/column.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/column_statistic.R b/auto-generated-sdk/R/column_statistic.R index 3c5997e..87d2848 100644 --- a/auto-generated-sdk/R/column_statistic.R +++ b/auto-generated-sdk/R/column_statistic.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/column_statistics_api.R b/auto-generated-sdk/R/column_statistics_api.R index 02e4730..86f3440 100644 --- a/auto-generated-sdk/R/column_statistics_api.R +++ b/auto-generated-sdk/R/column_statistics_api.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech @@ -28,11 +28,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication. #' @@ -40,11 +40,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials #' @@ -52,11 +49,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. #' @@ -64,11 +61,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting #' @@ -76,11 +83,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in sometime. #' @@ -88,11 +92,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' diff --git a/auto-generated-sdk/R/column_summary.R b/auto-generated-sdk/R/column_summary.R index 2ed4823..f2e04cf 100644 --- a/auto-generated-sdk/R/column_summary.R +++ b/auto-generated-sdk/R/column_summary.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/columns_api.R b/auto-generated-sdk/R/columns_api.R index 5a978b3..acb262f 100644 --- a/auto-generated-sdk/R/columns_api.R +++ b/auto-generated-sdk/R/columns_api.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech @@ -29,12 +29,12 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' Age \tab Standard HTTP header. Header will specify the age of columns list cached response. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 400 | Invalid column Id. #' @@ -42,11 +42,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication. #' @@ -54,11 +54,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials #' @@ -66,11 +63,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 404 | Column not found. #' @@ -78,11 +75,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. #' @@ -90,11 +87,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. #' @@ -102,11 +109,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in sometime. #' @@ -114,11 +118,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' @@ -139,12 +140,12 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' Age \tab Standard HTTP header. Header will specify the age of columns list cached response. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication. #' @@ -152,11 +153,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials #' @@ -164,11 +162,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. #' @@ -176,11 +174,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting #' @@ -188,11 +196,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in sometime. #' @@ -200,11 +205,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' @@ -247,9 +249,9 @@ #' #################### GetPAColumns #################### #' #' library(factset.analyticsapi.engines) -#' var.name <- 'name_example' # character | -#' var.category <- 'category_example' # character | -#' var.directory <- 'directory_example' # character | +#' var.name <- '' # character | Column name +#' var.category <- '' # character | Column category +#' var.directory <- '' # character | The directory to get the columns in #' #' #Get PA columns #' api.instance <- ColumnsApi$new() @@ -360,7 +362,7 @@ ColumnsApi <- R6::R6Class( rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) } }, - GetPAColumns = function(name=NULL, category=NULL, directory=NULL, ...){ + GetPAColumns = function(name='', category='', directory='', ...){ apiResponse <- self$GetPAColumnsWithHttpInfo(name, category, directory, ...) resp <- apiResponse$response if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { @@ -374,7 +376,7 @@ ColumnsApi <- R6::R6Class( } }, - GetPAColumnsWithHttpInfo = function(name=NULL, category=NULL, directory=NULL, ...){ + GetPAColumnsWithHttpInfo = function(name='', category='', directory='', ...){ args <- list(...) queryParams <- list() headerParams <- c() diff --git a/auto-generated-sdk/R/component_account.R b/auto-generated-sdk/R/component_account.R index 94dca86..646553a 100644 --- a/auto-generated-sdk/R/component_account.R +++ b/auto-generated-sdk/R/component_account.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/component_benchmark.R b/auto-generated-sdk/R/component_benchmark.R index 4d2da9b..0b2beea 100644 --- a/auto-generated-sdk/R/component_benchmark.R +++ b/auto-generated-sdk/R/component_benchmark.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/component_summary.R b/auto-generated-sdk/R/component_summary.R index 5da817e..c82bcec 100644 --- a/auto-generated-sdk/R/component_summary.R +++ b/auto-generated-sdk/R/component_summary.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/components_api.R b/auto-generated-sdk/R/components_api.R index 7906cba..2109fe4 100644 --- a/auto-generated-sdk/R/components_api.R +++ b/auto-generated-sdk/R/components_api.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech @@ -29,11 +29,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 400 | Invalid PA component id. #' @@ -41,11 +41,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication. #' @@ -53,11 +53,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials #' @@ -65,11 +62,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 404 | Component not found. #' @@ -77,11 +74,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. #' @@ -89,11 +86,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. #' @@ -101,11 +108,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in sometime. #' @@ -113,11 +117,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' @@ -136,11 +137,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 400 | Invalid query parameter provided or Invalid PA document name. #' @@ -148,11 +149,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication. #' @@ -160,11 +161,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials #' @@ -172,11 +170,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 404 | Document not found. #' @@ -184,11 +182,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. #' @@ -196,11 +194,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. #' @@ -208,11 +216,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in sometime. #' @@ -220,11 +225,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' @@ -243,11 +245,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 400 | Invalid query parameter provided or Invalid SPAR document name. #' @@ -255,11 +257,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication. #' @@ -267,11 +269,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials #' @@ -279,11 +278,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 404 | SPAR Document not found. #' @@ -291,11 +290,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. #' @@ -303,11 +302,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. #' @@ -315,11 +324,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in sometime. #' @@ -327,11 +333,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' @@ -350,11 +353,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 400 | Invalid Vault component id. #' @@ -362,11 +365,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication. #' @@ -374,11 +377,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials #' @@ -386,11 +386,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 404 | Vault Component not found. #' @@ -398,11 +398,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. #' @@ -410,11 +410,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. #' @@ -422,11 +432,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in sometime. #' @@ -434,11 +441,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' @@ -457,11 +461,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 400 | Invalid query parameter provided or invalid Vault document name. #' @@ -469,11 +473,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication. #' @@ -481,11 +485,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials #' @@ -493,11 +494,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 404 | Vault Document not found. #' @@ -505,11 +506,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. #' @@ -517,11 +518,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. #' @@ -529,11 +540,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in sometime. #' @@ -541,11 +549,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' diff --git a/auto-generated-sdk/R/configuration_account.R b/auto-generated-sdk/R/configuration_account.R index 1cb7968..ccd41b9 100644 --- a/auto-generated-sdk/R/configuration_account.R +++ b/auto-generated-sdk/R/configuration_account.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/configurations_api.R b/auto-generated-sdk/R/configurations_api.R index 4553cd5..6426f6a 100644 --- a/auto-generated-sdk/R/configurations_api.R +++ b/auto-generated-sdk/R/configurations_api.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech @@ -29,11 +29,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 400 | Invalid vault configuration code. #' @@ -41,11 +41,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication. #' @@ -53,11 +53,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials #' @@ -65,11 +62,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 404 | Vault configuration id not found. #' @@ -77,11 +74,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. #' @@ -89,11 +86,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. #' @@ -101,11 +108,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in sometime. #' @@ -113,11 +117,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' @@ -136,11 +137,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 400 | Invalid account. #' @@ -148,11 +149,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication. #' @@ -160,11 +161,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials #' @@ -172,11 +170,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 404 | Account not found. #' @@ -184,11 +182,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. #' @@ -196,11 +194,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. #' @@ -208,11 +216,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in sometime. #' @@ -220,11 +225,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' diff --git a/auto-generated-sdk/R/currencies_api.R b/auto-generated-sdk/R/currencies_api.R index 85774db..a6f21cd 100644 --- a/auto-generated-sdk/R/currencies_api.R +++ b/auto-generated-sdk/R/currencies_api.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech @@ -28,11 +28,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication. #' @@ -40,11 +40,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials #' @@ -52,11 +49,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. #' @@ -64,11 +61,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. #' @@ -76,11 +83,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in sometime. #' @@ -88,11 +92,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' diff --git a/auto-generated-sdk/R/currency.R b/auto-generated-sdk/R/currency.R index ff2b259..db662c4 100644 --- a/auto-generated-sdk/R/currency.R +++ b/auto-generated-sdk/R/currency.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/date_parameters_summary.R b/auto-generated-sdk/R/date_parameters_summary.R index 4fd80e9..c2a892d 100644 --- a/auto-generated-sdk/R/date_parameters_summary.R +++ b/auto-generated-sdk/R/date_parameters_summary.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/dates_api.R b/auto-generated-sdk/R/dates_api.R index 871a94c..2c33702 100644 --- a/auto-generated-sdk/R/dates_api.R +++ b/auto-generated-sdk/R/dates_api.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech @@ -15,7 +15,7 @@ #' @section Methods: #' \describe{ #' \strong{ ConvertPADatesToAbsoluteFormat } \emph{ Convert PA dates to absolute format } -#' This endpoint converts the given start and end dates to yyyymmdd format for a PA calculation. +#' This endpoint converts the given start and end dates in FactSet date format to yyyymmdd format for a PA calculation. For more information on FactSet date format, please refer to the PA Engine API documentation under the 'API Documentation' section in the developer portal. #' #' \itemize{ #' \item \emph{ @param } enddate character @@ -32,11 +32,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 400 | Invalid query parameter or value is provided. #' @@ -44,11 +44,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication. #' @@ -56,11 +56,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials #' @@ -68,11 +65,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 404 | Document or account not found. #' @@ -80,11 +77,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. #' @@ -92,11 +89,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. #' @@ -104,11 +111,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in sometime. #' @@ -116,16 +120,13 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' #' \strong{ ConvertVaultDatesToAbsoluteFormat } \emph{ Convert Vault dates to absolute format } -#' This endpoint converts the given start and end dates to yyyymmdd format for a Vault calculation. +#' This endpoint converts the given start and end dates in FactSet date format to yyyymmdd format for a Vault calculation. For more information on FactSet date format, please refer to the Vault API documentation under the 'API Documentation' section in the developer portal. #' #' \itemize{ #' \item \emph{ @param } enddate character @@ -142,11 +143,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 400 | Invalid query parameter or value is provided. #' @@ -154,11 +155,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication. #' @@ -166,11 +167,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials #' @@ -178,11 +176,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 404 | vault Document or account not found. #' @@ -190,11 +188,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. #' @@ -202,11 +200,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. #' @@ -214,11 +222,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in sometime. #' @@ -226,11 +231,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' diff --git a/auto-generated-sdk/R/document_directories.R b/auto-generated-sdk/R/document_directories.R index 8f74424..9a894c5 100644 --- a/auto-generated-sdk/R/document_directories.R +++ b/auto-generated-sdk/R/document_directories.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/documents_api.R b/auto-generated-sdk/R/documents_api.R index ac31606..1ff16b0 100644 --- a/auto-generated-sdk/R/documents_api.R +++ b/auto-generated-sdk/R/documents_api.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech @@ -29,11 +29,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 400 | Invalid query parameter or value provided #' @@ -41,11 +41,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication #' @@ -53,11 +53,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials #' @@ -65,11 +62,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 404 | Path not found #' @@ -77,11 +74,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json #' @@ -89,11 +86,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting #' @@ -101,23 +108,125 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in some time +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' \strong{ GetPubDocuments } \emph{ Gets Publisher documents and sub-directories in a directory } +#' This endpoint looks up all Publisher documents and sub-directories in a given directory. +#' +#' \itemize{ +#' \item \emph{ @param } path character +#' \item \emph{ @returnType } \link{DocumentDirectories} \cr +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 200 | Expected response, returns a list of Publisher documents and directories +#' +#' \item return type : DocumentDirectories +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr #' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid query parameter or value provided +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } -#' \item status code : 503 | Request timed out. Retry the request in some time +#' \item status code : 403 | User is forbidden with current credentials #' #' #' \item response headers : #' #' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | Path not found +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr #' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in some time +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' @@ -136,11 +245,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 400 | Invalid query parameter or value provided #' @@ -148,11 +257,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication #' @@ -160,11 +269,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials #' @@ -172,11 +278,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 404 | Path not found #' @@ -184,11 +290,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json #' @@ -196,11 +302,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting #' @@ -208,11 +324,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in some time #' @@ -220,11 +333,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' @@ -243,11 +353,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 400 | Invalid query parameter or value provided #' @@ -255,11 +365,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication #' @@ -267,11 +377,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials #' @@ -279,11 +386,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 404 | Path not found #' @@ -291,11 +398,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json #' @@ -303,11 +410,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting #' @@ -315,11 +432,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in some time #' @@ -327,11 +441,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' @@ -343,7 +454,7 @@ #' #################### GetPA3Documents #################### #' #' library(factset.analyticsapi.engines) -#' var.path <- 'path_example' # character | The directory to get the documents and sub-directories in +#' var.path <- '' # character | The directory to get the documents and sub-directories in #' #' #Get PA3 documents and sub-directories in a directory #' api.instance <- DocumentsApi$new() @@ -371,10 +482,41 @@ #' } #' #' +#' #################### GetPubDocuments #################### +#' +#' library(factset.analyticsapi.engines) +#' var.path <- '' # character | The directory to get the documents in +#' +#' #Gets Publisher documents and sub-directories in a directory +#' api.instance <- DocumentsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$GetPubDocuments(var.path), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # deserialized response object +#' response.object <- result$content +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' #' #################### GetSPAR3Documents #################### #' #' library(factset.analyticsapi.engines) -#' var.path <- 'path_example' # character | The directory to get the documents in +#' var.path <- '' # character | The directory to get the documents in #' #' #Gets SPAR3 documents and sub-directories in a directory #' api.instance <- DocumentsApi$new() @@ -405,7 +547,7 @@ #' #################### GetVaultDocuments #################### #' #' library(factset.analyticsapi.engines) -#' var.path <- 'path_example' # character | The directory to get the documents in +#' var.path <- '' # character | The directory to get the documents in #' #' #Get Vault documents and sub-directories in a directory #' api.instance <- DocumentsApi$new() @@ -516,6 +658,72 @@ DocumentsApi <- R6::R6Class( rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) } }, + GetPubDocuments = function(path, ...){ + apiResponse <- self$GetPubDocumentsWithHttpInfo(path, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + GetPubDocumentsWithHttpInfo = function(path, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`path`)) { + rlang::abort(message = "Missing required parameter `path`.", .subclass = "ApiException", ApiException = ApiException$new(status = 0, reason = "Missing required parameter `path`.")) + } + + urlPath <- "/analytics/lookups/v2/engines/pub/documents/{path}" + if (!missing(`path`)) { + urlPath <- gsub(paste0("\\{", "path", "\\}"), URLencode(as.character(`path`), reserved = TRUE), urlPath) + } + + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "DocumentDirectories", loadNamespace("factset.analyticsapi.engines")), + error = function(e){ + rlang::abort(message = "Failed to deserialize response", .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + }, GetSPAR3Documents = function(path, ...){ apiResponse <- self$GetSPAR3DocumentsWithHttpInfo(path, ...) resp <- apiResponse$response diff --git a/auto-generated-sdk/R/event_summary.R b/auto-generated-sdk/R/event_summary.R new file mode 100644 index 0000000..e18df35 --- /dev/null +++ b/auto-generated-sdk/R/event_summary.R @@ -0,0 +1,108 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title EventSummary +#' @description EventSummary Class +#' @format An \code{R6Class} generator object +#' @field message character [optional] +#' +#' @field submissiondatetime character [optional] +#' +#' @field type character [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +EventSummary <- R6::R6Class( + 'EventSummary', + public = list( + `message` = NULL, + `submissiondatetime` = NULL, + `type` = NULL, + initialize = function(`message`=NULL, `submissiondatetime`=NULL, `type`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`message`)) { + stopifnot(is.character(`message`), length(`message`) == 1) + self$`message` <- `message` + } + if (!is.null(`submissiondatetime`)) { + stopifnot(is.character(`submissiondatetime`), length(`submissiondatetime`) == 1) + self$`submissiondatetime` <- `submissiondatetime` + } + if (!is.null(`type`)) { + stopifnot(is.character(`type`), length(`type`) == 1) + self$`type` <- `type` + } + }, + toJSON = function() { + EventSummaryObject <- list() + if (!is.null(self$`message`)) { + EventSummaryObject[['message']] <- + self$`message` + } + if (!is.null(self$`submissiondatetime`)) { + EventSummaryObject[['submissiondatetime']] <- + self$`submissiondatetime` + } + if (!is.null(self$`type`)) { + EventSummaryObject[['type']] <- + self$`type` + } + + EventSummaryObject + }, + fromJSON = function(EventSummaryJson) { + EventSummaryObject <- jsonlite::fromJSON(EventSummaryJson) + if (!is.null(EventSummaryObject$`message`)) { + self$`message` <- EventSummaryObject$`message` + } + if (!is.null(EventSummaryObject$`submissiondatetime`)) { + self$`submissiondatetime` <- EventSummaryObject$`submissiondatetime` + } + if (!is.null(EventSummaryObject$`type`)) { + self$`type` <- EventSummaryObject$`type` + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`message`)) { + sprintf( + '"message": + "%s" + ', + self$`message` + )}, + if (!is.null(self$`submissiondatetime`)) { + sprintf( + '"submissiondatetime": + "%s" + ', + self$`submissiondatetime` + )}, + if (!is.null(self$`type`)) { + sprintf( + '"type": + "%s" + ', + self$`type` + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(EventSummaryJson) { + EventSummaryObject <- jsonlite::fromJSON(EventSummaryJson) + self$`message` <- EventSummaryObject$`message` + self$`submissiondatetime` <- EventSummaryObject$`submissiondatetime` + self$`type` <- EventSummaryObject$`type` + self + } + ) +) diff --git a/auto-generated-sdk/R/fi_calculation_parameters.R b/auto-generated-sdk/R/fi_calculation_parameters.R new file mode 100644 index 0000000..e6d7363 --- /dev/null +++ b/auto-generated-sdk/R/fi_calculation_parameters.R @@ -0,0 +1,112 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title FICalculationParameters +#' @description FICalculationParameters Class +#' @format An \code{R6Class} generator object +#' @field securities list( \link{FISecurity} ) +#' +#' @field calculations list( character ) +#' +#' @field jobSettings \link{FIJobSettings} +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +FICalculationParameters <- R6::R6Class( + 'FICalculationParameters', + public = list( + `securities` = NULL, + `calculations` = NULL, + `jobSettings` = NULL, + initialize = function(`securities`, `calculations`, `jobSettings`, ...){ + local.optional.var <- list(...) + if (!missing(`securities`)) { + stopifnot(is.vector(`securities`), length(`securities`) != 0) + sapply(`securities`, function(x) stopifnot(R6::is.R6(x))) + self$`securities` <- `securities` + } + if (!missing(`calculations`)) { + stopifnot(is.vector(`calculations`), length(`calculations`) != 0) + sapply(`calculations`, function(x) stopifnot(is.character(x))) + self$`calculations` <- `calculations` + } + if (!missing(`jobSettings`)) { + stopifnot(R6::is.R6(`jobSettings`)) + self$`jobSettings` <- `jobSettings` + } + }, + toJSON = function() { + FICalculationParametersObject <- list() + if (!is.null(self$`securities`)) { + FICalculationParametersObject[['securities']] <- + lapply(self$`securities`, function(x) x$toJSON()) + } + if (!is.null(self$`calculations`)) { + FICalculationParametersObject[['calculations']] <- + self$`calculations` + } + if (!is.null(self$`jobSettings`)) { + FICalculationParametersObject[['jobSettings']] <- + self$`jobSettings`$toJSON() + } + + FICalculationParametersObject + }, + fromJSON = function(FICalculationParametersJson) { + FICalculationParametersObject <- jsonlite::fromJSON(FICalculationParametersJson) + if (!is.null(FICalculationParametersObject$`securities`)) { + self$`securities` <- ApiClient$new()$deserializeObj(FICalculationParametersObject$`securities`, "array[FISecurity]", loadNamespace("factset.analyticsapi.engines")) + } + if (!is.null(FICalculationParametersObject$`calculations`)) { + self$`calculations` <- ApiClient$new()$deserializeObj(FICalculationParametersObject$`calculations`, "array[character]", loadNamespace("factset.analyticsapi.engines")) + } + if (!is.null(FICalculationParametersObject$`jobSettings`)) { + jobSettingsObject <- FIJobSettings$new() + jobSettingsObject$fromJSON(jsonlite::toJSON(FICalculationParametersObject$jobSettings, auto_unbox = TRUE, digits = NA)) + self$`jobSettings` <- jobSettingsObject + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`securities`)) { + sprintf( + '"securities": + [%s] +', + paste(sapply(self$`securities`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") + )}, + if (!is.null(self$`calculations`)) { + sprintf( + '"calculations": + [%s] + ', + paste(unlist(lapply(self$`calculations`, function(x) paste0('"', x, '"'))), collapse=",") + )}, + if (!is.null(self$`jobSettings`)) { + sprintf( + '"jobSettings": + %s + ', + jsonlite::toJSON(self$`jobSettings`$toJSON(), auto_unbox=TRUE, digits = NA) + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(FICalculationParametersJson) { + FICalculationParametersObject <- jsonlite::fromJSON(FICalculationParametersJson) + self$`securities` <- ApiClient$new()$deserializeObj(FICalculationParametersObject$`securities`, "array[FISecurity]", loadNamespace("factset.analyticsapi.engines")) + self$`calculations` <- ApiClient$new()$deserializeObj(FICalculationParametersObject$`calculations`, "array[character]", loadNamespace("factset.analyticsapi.engines")) + self$`jobSettings` <- FIJobSettings$new()$fromJSON(jsonlite::toJSON(FICalculationParametersObject$jobSettings, auto_unbox = TRUE, digits = NA)) + self + } + ) +) diff --git a/auto-generated-sdk/R/fi_calculations_api.R b/auto-generated-sdk/R/fi_calculations_api.R new file mode 100644 index 0000000..cd1de38 --- /dev/null +++ b/auto-generated-sdk/R/fi_calculations_api.R @@ -0,0 +1,659 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title FICalculations operations +#' @description factset.analyticsapi.engines.FICalculations +#' @format An \code{R6Class} generator object +#' @field apiClient Handles the client-server communication. +#' +#' @section Methods: +#' \describe{ +#' \strong{ CancelFICalculationById } \emph{ Cancel FI calculation by id } +#' This is the endpoint to cancel a previously submitted calculation. Instead of doing a GET on the polling URL, cancel the request by doing a DELETE. +#' +#' \itemize{ +#' \item \emph{ @param } id character +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 204 | Expected response, calculation was canceled successfully. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid identifier provided. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | There was no request for the calculation identifier provided, or the request was already canceled for the provided identifier. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in sometime. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' \strong{ GetFICalculationById } \emph{ Get FI calculation by id } +#' This is the endpoint to check on the progress of a previously requested calculation. If the calculation has finished computing, the body of the response will contain the requested document in JSON. Otherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. +#' +#' \itemize{ +#' \item \emph{ @param } id character +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 200 | Expected response once calculation is completed, returns JSON in the format specified in the Run Calculations endpoint. +#' +#' \item return type : object +#' \item response headers : +#' +#' \tabular{ll}{ +#' Content-Encoding \tab Standard HTTP header. Header value based on Accept-Encoding Request header. \cr +#' Content-Type \tab Standard HTTP header. \cr +#' Transfer-Encoding \tab Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 202 | Expected response returned if the calculation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-FactSet-Api-PickUp-Progress \tab FactSet's progress header. \cr +#' Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid identifier provided. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in sometime. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' \strong{ RunFICalculation } \emph{ Run FI calculation } +#' This endpoint creates a new FI calculation. This must be used first before get status or cancelling endpoints with a calculation id. A successful response will contain the resulting FI calculation or a polling URL in location header if the request takes too long. +#' +#' \itemize{ +#' \item \emph{ @param } x.factset.content.organization character +#' \item \emph{ @param } x.factset.content.type character +#' \item \emph{ @param } fi.calculation.parameters \link{FICalculationParameters} +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 202 | Expected response, contains the poll URL in the Location header. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' Location \tab URL to poll for the resulting calculation \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Calculations-Limit \tab Maximum FI request limit. \cr +#' X-FactSet-Api-Calculations-Remaining \tab Number of FI requests remaining till request limit reached. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 201 | Expected response if calculation is completed within 30 seconds, returns JSON in the format specified in the Run Calculations endpoint. +#' +#' \item return type : object +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Calculations-Limit \tab Maximum FI request limit. \cr +#' X-FactSet-Api-Calculations-Remaining \tab Number of FI requests remaining till request limit reached. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid POST body. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Calculations-Limit \tab Maximum FI request limit. \cr +#' X-FactSet-Api-Calculations-Remaining \tab Number of FI requests remaining till request limit reached. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Calculations-Limit \tab Maximum FI request limit. \cr +#' X-FactSet-Api-Calculations-Remaining \tab Number of FI requests remaining till request limit reached. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Calculations-Limit \tab Maximum FI request limit. \cr +#' X-FactSet-Api-Calculations-Remaining \tab Number of FI requests remaining till request limit reached. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | One or more calculation settings were unavailable. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Calculations-Limit \tab Maximum FI request limit. \cr +#' X-FactSet-Api-Calculations-Remaining \tab Number of FI requests remaining till request limit reached. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 415 | Missing/Invalid Content-Type header. Header needs to be set to application/json. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Calculations-Limit \tab Maximum FI request limit. \cr +#' X-FactSet-Api-Calculations-Remaining \tab Number of FI requests remaining till request limit reached. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Calculations-Limit \tab Maximum FI request limit. \cr +#' X-FactSet-Api-Calculations-Remaining \tab Number of FI requests remaining till request limit reached. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Calculations-Limit \tab Maximum FI request limit. \cr +#' X-FactSet-Api-Calculations-Remaining \tab Number of FI requests remaining till request limit reached. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in sometime. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Calculations-Limit \tab Maximum FI request limit. \cr +#' X-FactSet-Api-Calculations-Remaining \tab Number of FI requests remaining till request limit reached. \cr +#' } +#' } +#' +#' } +#' +#' +#' @examples +#' \dontrun{ +#' #################### CancelFICalculationById #################### +#' +#' library(factset.analyticsapi.engines) +#' var.id <- 'id_example' # character | from url, provided from the location header in the Run FI Calculation endpoint +#' +#' #Cancel FI calculation by id +#' api.instance <- FICalculationsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$CancelFICalculationById(var.id), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' #################### GetFICalculationById #################### +#' +#' library(factset.analyticsapi.engines) +#' var.id <- 'id_example' # character | from url, provided from the location header in the Run FI Calculation endpoint +#' +#' #Get FI calculation by id +#' api.instance <- FICalculationsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$GetFICalculationById(var.id), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # deserialized response object +#' response.object <- result$content +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' #################### RunFICalculation #################### +#' +#' library(factset.analyticsapi.engines) +#' var.x.factset.content.organization <- 'x.factset.content.organization_example' # character | For specifying the format of the calculation result. Accepted values are \"column\" or \"row\" or \"simplifiedrow\" +#' var.x.factset.content.type <- 'x.factset.content.type_example' # character | For specifying the content type of the calculation result. Accepted values are either \"application/json\" or \"application/x-protobuf\" +#' var.fi.calculation.parameters <- FICalculationParameters$new() # FICalculationParameters | +#' +#' #Run FI calculation +#' api.instance <- FICalculationsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$RunFICalculation(x.factset.content.organization=var.x.factset.content.organization, x.factset.content.type=var.x.factset.content.type, fi.calculation.parameters=var.fi.calculation.parameters), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # deserialized response object +#' response.object <- result$content +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' } +#' @importFrom R6 R6Class +#' @importFrom base64enc base64encode +#' @importFrom rlang abort +#' @export +FICalculationsApi <- R6::R6Class( + 'FICalculationsApi', + public = list( + apiClient = NULL, + initialize = function(apiClient){ + if (!missing(apiClient)) { + self$apiClient <- apiClient + } + else { + self$apiClient <- ApiClient$new() + } + }, + CancelFICalculationById = function(id, ...){ + apiResponse <- self$CancelFICalculationByIdWithHttpInfo(id, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + CancelFICalculationByIdWithHttpInfo = function(id, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`id`)) { + rlang::abort(message = "Missing required parameter `id`.", .subclass = "ApiException", ApiException = ApiException$new(status = 0, reason = "Missing required parameter `id`.")) + } + + urlPath <- "/analytics/engines/fi/v1/calculations/{id}" + if (!missing(`id`)) { + urlPath <- gsub(paste0("\\{", "id", "\\}"), URLencode(as.character(`id`), reserved = TRUE), urlPath) + } + + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "DELETE", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + ApiResponse$new(NULL, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + }, + GetFICalculationById = function(id, ...){ + apiResponse <- self$GetFICalculationByIdWithHttpInfo(id, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + GetFICalculationByIdWithHttpInfo = function(id, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`id`)) { + rlang::abort(message = "Missing required parameter `id`.", .subclass = "ApiException", ApiException = ApiException$new(status = 0, reason = "Missing required parameter `id`.")) + } + + urlPath <- "/analytics/engines/fi/v1/calculations/{id}" + if (!missing(`id`)) { + urlPath <- gsub(paste0("\\{", "id", "\\}"), URLencode(as.character(`id`), reserved = TRUE), urlPath) + } + + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "object", loadNamespace("factset.analyticsapi.engines")), + error = function(e){ + rlang::abort(message = "Failed to deserialize response", .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + }, + RunFICalculation = function(x.factset.content.organization=NULL, x.factset.content.type=NULL, fi.calculation.parameters=NULL, ...){ + apiResponse <- self$RunFICalculationWithHttpInfo(x.factset.content.organization, x.factset.content.type, fi.calculation.parameters, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + RunFICalculationWithHttpInfo = function(x.factset.content.organization=NULL, x.factset.content.type=NULL, fi.calculation.parameters=NULL, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + headerParams['x-factset-content-organization'] <- `x.factset.content.organization` + + headerParams['x-factset-content-type'] <- `x.factset.content.type` + + if (!missing(`fi.calculation.parameters`)) { + body <- `fi.calculation.parameters`$toJSONString() + } else { + body <- NULL + } + + urlPath <- "/analytics/engines/fi/v1/calculations" + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "POST", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "object", loadNamespace("factset.analyticsapi.engines")), + error = function(e){ + rlang::abort(message = "Failed to deserialize response", .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + } + ) +) diff --git a/auto-generated-sdk/R/fi_job_settings.R b/auto-generated-sdk/R/fi_job_settings.R new file mode 100644 index 0000000..d720027 --- /dev/null +++ b/auto-generated-sdk/R/fi_job_settings.R @@ -0,0 +1,87 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title FIJobSettings +#' @description FIJobSettings Class +#' @format An \code{R6Class} generator object +#' @field yieldCurveDate character +#' +#' @field partialDurationMonths list( integer ) [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +FIJobSettings <- R6::R6Class( + 'FIJobSettings', + public = list( + `yieldCurveDate` = NULL, + `partialDurationMonths` = NULL, + initialize = function(`yieldCurveDate`, `partialDurationMonths`=NULL, ...){ + local.optional.var <- list(...) + if (!missing(`yieldCurveDate`)) { + stopifnot(is.character(`yieldCurveDate`), length(`yieldCurveDate`) == 1) + self$`yieldCurveDate` <- `yieldCurveDate` + } + if (!is.null(`partialDurationMonths`)) { + stopifnot(is.vector(`partialDurationMonths`), length(`partialDurationMonths`) != 0) + sapply(`partialDurationMonths`, function(x) stopifnot(is.character(x))) + self$`partialDurationMonths` <- `partialDurationMonths` + } + }, + toJSON = function() { + FIJobSettingsObject <- list() + if (!is.null(self$`yieldCurveDate`)) { + FIJobSettingsObject[['yieldCurveDate']] <- + self$`yieldCurveDate` + } + if (!is.null(self$`partialDurationMonths`)) { + FIJobSettingsObject[['partialDurationMonths']] <- + self$`partialDurationMonths` + } + + FIJobSettingsObject + }, + fromJSON = function(FIJobSettingsJson) { + FIJobSettingsObject <- jsonlite::fromJSON(FIJobSettingsJson) + if (!is.null(FIJobSettingsObject$`yieldCurveDate`)) { + self$`yieldCurveDate` <- FIJobSettingsObject$`yieldCurveDate` + } + if (!is.null(FIJobSettingsObject$`partialDurationMonths`)) { + self$`partialDurationMonths` <- ApiClient$new()$deserializeObj(FIJobSettingsObject$`partialDurationMonths`, "array[integer]", loadNamespace("factset.analyticsapi.engines")) + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`yieldCurveDate`)) { + sprintf( + '"yieldCurveDate": + "%s" + ', + self$`yieldCurveDate` + )}, + if (!is.null(self$`partialDurationMonths`)) { + sprintf( + '"partialDurationMonths": + [%s] + ', + paste(unlist(lapply(self$`partialDurationMonths`, function(x) paste0('"', x, '"'))), collapse=",") + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(FIJobSettingsJson) { + FIJobSettingsObject <- jsonlite::fromJSON(FIJobSettingsJson) + self$`yieldCurveDate` <- FIJobSettingsObject$`yieldCurveDate` + self$`partialDurationMonths` <- ApiClient$new()$deserializeObj(FIJobSettingsObject$`partialDurationMonths`, "array[integer]", loadNamespace("factset.analyticsapi.engines")) + self + } + ) +) diff --git a/auto-generated-sdk/R/fi_security.R b/auto-generated-sdk/R/fi_security.R new file mode 100644 index 0000000..91a8494 --- /dev/null +++ b/auto-generated-sdk/R/fi_security.R @@ -0,0 +1,174 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title FISecurity +#' @description FISecurity Class +#' @format An \code{R6Class} generator object +#' @field calcFromMethod character +#' +#' @field calcFromValue numeric +#' +#' @field face numeric +#' +#' @field symbol character +#' +#' @field settlementDate character +#' +#' @field discountCurve character +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +FISecurity <- R6::R6Class( + 'FISecurity', + public = list( + `calcFromMethod` = NULL, + `calcFromValue` = NULL, + `face` = NULL, + `symbol` = NULL, + `settlementDate` = NULL, + `discountCurve` = NULL, + initialize = function(`calcFromMethod`, `calcFromValue`, `face`, `symbol`, `settlementDate`, `discountCurve`, ...){ + local.optional.var <- list(...) + if (!missing(`calcFromMethod`)) { + stopifnot(is.character(`calcFromMethod`), length(`calcFromMethod`) == 1) + self$`calcFromMethod` <- `calcFromMethod` + } + if (!missing(`calcFromValue`)) { + stopifnot(is.numeric(`calcFromValue`), length(`calcFromValue`) == 1) + self$`calcFromValue` <- `calcFromValue` + } + if (!missing(`face`)) { + stopifnot(is.numeric(`face`), length(`face`) == 1) + self$`face` <- `face` + } + if (!missing(`symbol`)) { + stopifnot(is.character(`symbol`), length(`symbol`) == 1) + self$`symbol` <- `symbol` + } + if (!missing(`settlementDate`)) { + stopifnot(is.character(`settlementDate`), length(`settlementDate`) == 1) + self$`settlementDate` <- `settlementDate` + } + if (!missing(`discountCurve`)) { + stopifnot(is.character(`discountCurve`), length(`discountCurve`) == 1) + self$`discountCurve` <- `discountCurve` + } + }, + toJSON = function() { + FISecurityObject <- list() + if (!is.null(self$`calcFromMethod`)) { + FISecurityObject[['calcFromMethod']] <- + self$`calcFromMethod` + } + if (!is.null(self$`calcFromValue`)) { + FISecurityObject[['calcFromValue']] <- + self$`calcFromValue` + } + if (!is.null(self$`face`)) { + FISecurityObject[['face']] <- + self$`face` + } + if (!is.null(self$`symbol`)) { + FISecurityObject[['symbol']] <- + self$`symbol` + } + if (!is.null(self$`settlementDate`)) { + FISecurityObject[['settlementDate']] <- + self$`settlementDate` + } + if (!is.null(self$`discountCurve`)) { + FISecurityObject[['discountCurve']] <- + self$`discountCurve` + } + + FISecurityObject + }, + fromJSON = function(FISecurityJson) { + FISecurityObject <- jsonlite::fromJSON(FISecurityJson) + if (!is.null(FISecurityObject$`calcFromMethod`)) { + self$`calcFromMethod` <- FISecurityObject$`calcFromMethod` + } + if (!is.null(FISecurityObject$`calcFromValue`)) { + self$`calcFromValue` <- FISecurityObject$`calcFromValue` + } + if (!is.null(FISecurityObject$`face`)) { + self$`face` <- FISecurityObject$`face` + } + if (!is.null(FISecurityObject$`symbol`)) { + self$`symbol` <- FISecurityObject$`symbol` + } + if (!is.null(FISecurityObject$`settlementDate`)) { + self$`settlementDate` <- FISecurityObject$`settlementDate` + } + if (!is.null(FISecurityObject$`discountCurve`)) { + self$`discountCurve` <- FISecurityObject$`discountCurve` + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`calcFromMethod`)) { + sprintf( + '"calcFromMethod": + "%s" + ', + self$`calcFromMethod` + )}, + if (!is.null(self$`calcFromValue`)) { + sprintf( + '"calcFromValue": + %d + ', + self$`calcFromValue` + )}, + if (!is.null(self$`face`)) { + sprintf( + '"face": + %d + ', + self$`face` + )}, + if (!is.null(self$`symbol`)) { + sprintf( + '"symbol": + "%s" + ', + self$`symbol` + )}, + if (!is.null(self$`settlementDate`)) { + sprintf( + '"settlementDate": + "%s" + ', + self$`settlementDate` + )}, + if (!is.null(self$`discountCurve`)) { + sprintf( + '"discountCurve": + "%s" + ', + self$`discountCurve` + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(FISecurityJson) { + FISecurityObject <- jsonlite::fromJSON(FISecurityJson) + self$`calcFromMethod` <- FISecurityObject$`calcFromMethod` + self$`calcFromValue` <- FISecurityObject$`calcFromValue` + self$`face` <- FISecurityObject$`face` + self$`symbol` <- FISecurityObject$`symbol` + self$`settlementDate` <- FISecurityObject$`settlementDate` + self$`discountCurve` <- FISecurityObject$`discountCurve` + self + } + ) +) diff --git a/auto-generated-sdk/R/fiab_calculation_parameters.R b/auto-generated-sdk/R/fiab_calculation_parameters.R new file mode 100644 index 0000000..0f348b6 --- /dev/null +++ b/auto-generated-sdk/R/fiab_calculation_parameters.R @@ -0,0 +1,156 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title FIABCalculationParameters +#' @description FIABCalculationParameters Class +#' @format An \code{R6Class} generator object +#' @field fiabdocument character [optional] +#' +#' @field account \link{FIABIdentifier} +#' +#' @field dates \link{FIABDateParameters} +#' +#' @field msl character [optional] +#' +#' @field fisettingsdocument character [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +FIABCalculationParameters <- R6::R6Class( + 'FIABCalculationParameters', + public = list( + `fiabdocument` = NULL, + `account` = NULL, + `dates` = NULL, + `msl` = NULL, + `fisettingsdocument` = NULL, + initialize = function(`account`, `dates`, `fiabdocument`=NULL, `msl`=NULL, `fisettingsdocument`=NULL, ...){ + local.optional.var <- list(...) + if (!missing(`account`)) { + stopifnot(R6::is.R6(`account`)) + self$`account` <- `account` + } + if (!missing(`dates`)) { + stopifnot(R6::is.R6(`dates`)) + self$`dates` <- `dates` + } + if (!is.null(`fiabdocument`)) { + stopifnot(is.character(`fiabdocument`), length(`fiabdocument`) == 1) + self$`fiabdocument` <- `fiabdocument` + } + if (!is.null(`msl`)) { + stopifnot(is.character(`msl`), length(`msl`) == 1) + self$`msl` <- `msl` + } + if (!is.null(`fisettingsdocument`)) { + stopifnot(is.character(`fisettingsdocument`), length(`fisettingsdocument`) == 1) + self$`fisettingsdocument` <- `fisettingsdocument` + } + }, + toJSON = function() { + FIABCalculationParametersObject <- list() + if (!is.null(self$`fiabdocument`)) { + FIABCalculationParametersObject[['fiabdocument']] <- + self$`fiabdocument` + } + if (!is.null(self$`account`)) { + FIABCalculationParametersObject[['account']] <- + self$`account`$toJSON() + } + if (!is.null(self$`dates`)) { + FIABCalculationParametersObject[['dates']] <- + self$`dates`$toJSON() + } + if (!is.null(self$`msl`)) { + FIABCalculationParametersObject[['msl']] <- + self$`msl` + } + if (!is.null(self$`fisettingsdocument`)) { + FIABCalculationParametersObject[['fisettingsdocument']] <- + self$`fisettingsdocument` + } + + FIABCalculationParametersObject + }, + fromJSON = function(FIABCalculationParametersJson) { + FIABCalculationParametersObject <- jsonlite::fromJSON(FIABCalculationParametersJson) + if (!is.null(FIABCalculationParametersObject$`fiabdocument`)) { + self$`fiabdocument` <- FIABCalculationParametersObject$`fiabdocument` + } + if (!is.null(FIABCalculationParametersObject$`account`)) { + accountObject <- FIABIdentifier$new() + accountObject$fromJSON(jsonlite::toJSON(FIABCalculationParametersObject$account, auto_unbox = TRUE, digits = NA)) + self$`account` <- accountObject + } + if (!is.null(FIABCalculationParametersObject$`dates`)) { + datesObject <- FIABDateParameters$new() + datesObject$fromJSON(jsonlite::toJSON(FIABCalculationParametersObject$dates, auto_unbox = TRUE, digits = NA)) + self$`dates` <- datesObject + } + if (!is.null(FIABCalculationParametersObject$`msl`)) { + self$`msl` <- FIABCalculationParametersObject$`msl` + } + if (!is.null(FIABCalculationParametersObject$`fisettingsdocument`)) { + self$`fisettingsdocument` <- FIABCalculationParametersObject$`fisettingsdocument` + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`fiabdocument`)) { + sprintf( + '"fiabdocument": + "%s" + ', + self$`fiabdocument` + )}, + if (!is.null(self$`account`)) { + sprintf( + '"account": + %s + ', + jsonlite::toJSON(self$`account`$toJSON(), auto_unbox=TRUE, digits = NA) + )}, + if (!is.null(self$`dates`)) { + sprintf( + '"dates": + %s + ', + jsonlite::toJSON(self$`dates`$toJSON(), auto_unbox=TRUE, digits = NA) + )}, + if (!is.null(self$`msl`)) { + sprintf( + '"msl": + "%s" + ', + self$`msl` + )}, + if (!is.null(self$`fisettingsdocument`)) { + sprintf( + '"fisettingsdocument": + "%s" + ', + self$`fisettingsdocument` + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(FIABCalculationParametersJson) { + FIABCalculationParametersObject <- jsonlite::fromJSON(FIABCalculationParametersJson) + self$`fiabdocument` <- FIABCalculationParametersObject$`fiabdocument` + self$`account` <- FIABIdentifier$new()$fromJSON(jsonlite::toJSON(FIABCalculationParametersObject$account, auto_unbox = TRUE, digits = NA)) + self$`dates` <- FIABDateParameters$new()$fromJSON(jsonlite::toJSON(FIABCalculationParametersObject$dates, auto_unbox = TRUE, digits = NA)) + self$`msl` <- FIABCalculationParametersObject$`msl` + self$`fisettingsdocument` <- FIABCalculationParametersObject$`fisettingsdocument` + self + } + ) +) diff --git a/auto-generated-sdk/R/fiab_calculation_status.R b/auto-generated-sdk/R/fiab_calculation_status.R new file mode 100644 index 0000000..160f444 --- /dev/null +++ b/auto-generated-sdk/R/fiab_calculation_status.R @@ -0,0 +1,175 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title FIABCalculationStatus +#' @description FIABCalculationStatus Class +#' @format An \code{R6Class} generator object +#' @field id character [optional] +#' +#' @field status character [optional] +#' +#' @field startdatetime character [optional] +#' +#' @field completiondatetime character [optional] +#' +#' @field progress integer [optional] +#' +#' @field batchevents list( \link{EventSummary} ) [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +FIABCalculationStatus <- R6::R6Class( + 'FIABCalculationStatus', + public = list( + `id` = NULL, + `status` = NULL, + `startdatetime` = NULL, + `completiondatetime` = NULL, + `progress` = NULL, + `batchevents` = NULL, + initialize = function(`id`=NULL, `status`=NULL, `startdatetime`=NULL, `completiondatetime`=NULL, `progress`=NULL, `batchevents`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`id`)) { + stopifnot(is.character(`id`), length(`id`) == 1) + self$`id` <- `id` + } + if (!is.null(`status`)) { + stopifnot(is.character(`status`), length(`status`) == 1) + self$`status` <- `status` + } + if (!is.null(`startdatetime`)) { + stopifnot(is.character(`startdatetime`), length(`startdatetime`) == 1) + self$`startdatetime` <- `startdatetime` + } + if (!is.null(`completiondatetime`)) { + stopifnot(is.character(`completiondatetime`), length(`completiondatetime`) == 1) + self$`completiondatetime` <- `completiondatetime` + } + if (!is.null(`progress`)) { + stopifnot(is.numeric(`progress`), length(`progress`) == 1) + self$`progress` <- `progress` + } + if (!is.null(`batchevents`)) { + stopifnot(is.vector(`batchevents`), length(`batchevents`) != 0) + sapply(`batchevents`, function(x) stopifnot(R6::is.R6(x))) + self$`batchevents` <- `batchevents` + } + }, + toJSON = function() { + FIABCalculationStatusObject <- list() + if (!is.null(self$`id`)) { + FIABCalculationStatusObject[['id']] <- + self$`id` + } + if (!is.null(self$`status`)) { + FIABCalculationStatusObject[['status']] <- + self$`status` + } + if (!is.null(self$`startdatetime`)) { + FIABCalculationStatusObject[['startdatetime']] <- + self$`startdatetime` + } + if (!is.null(self$`completiondatetime`)) { + FIABCalculationStatusObject[['completiondatetime']] <- + self$`completiondatetime` + } + if (!is.null(self$`progress`)) { + FIABCalculationStatusObject[['progress']] <- + self$`progress` + } + if (!is.null(self$`batchevents`)) { + FIABCalculationStatusObject[['batchevents']] <- + lapply(self$`batchevents`, function(x) x$toJSON()) + } + + FIABCalculationStatusObject + }, + fromJSON = function(FIABCalculationStatusJson) { + FIABCalculationStatusObject <- jsonlite::fromJSON(FIABCalculationStatusJson) + if (!is.null(FIABCalculationStatusObject$`id`)) { + self$`id` <- FIABCalculationStatusObject$`id` + } + if (!is.null(FIABCalculationStatusObject$`status`)) { + self$`status` <- FIABCalculationStatusObject$`status` + } + if (!is.null(FIABCalculationStatusObject$`startdatetime`)) { + self$`startdatetime` <- FIABCalculationStatusObject$`startdatetime` + } + if (!is.null(FIABCalculationStatusObject$`completiondatetime`)) { + self$`completiondatetime` <- FIABCalculationStatusObject$`completiondatetime` + } + if (!is.null(FIABCalculationStatusObject$`progress`)) { + self$`progress` <- FIABCalculationStatusObject$`progress` + } + if (!is.null(FIABCalculationStatusObject$`batchevents`)) { + self$`batchevents` <- ApiClient$new()$deserializeObj(FIABCalculationStatusObject$`batchevents`, "array[EventSummary]", loadNamespace("factset.analyticsapi.engines")) + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`id`)) { + sprintf( + '"id": + "%s" + ', + self$`id` + )}, + if (!is.null(self$`status`)) { + sprintf( + '"status": + "%s" + ', + self$`status` + )}, + if (!is.null(self$`startdatetime`)) { + sprintf( + '"startdatetime": + "%s" + ', + self$`startdatetime` + )}, + if (!is.null(self$`completiondatetime`)) { + sprintf( + '"completiondatetime": + "%s" + ', + self$`completiondatetime` + )}, + if (!is.null(self$`progress`)) { + sprintf( + '"progress": + %d + ', + self$`progress` + )}, + if (!is.null(self$`batchevents`)) { + sprintf( + '"batchevents": + [%s] +', + paste(sapply(self$`batchevents`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(FIABCalculationStatusJson) { + FIABCalculationStatusObject <- jsonlite::fromJSON(FIABCalculationStatusJson) + self$`id` <- FIABCalculationStatusObject$`id` + self$`status` <- FIABCalculationStatusObject$`status` + self$`startdatetime` <- FIABCalculationStatusObject$`startdatetime` + self$`completiondatetime` <- FIABCalculationStatusObject$`completiondatetime` + self$`progress` <- FIABCalculationStatusObject$`progress` + self$`batchevents` <- ApiClient$new()$deserializeObj(FIABCalculationStatusObject$`batchevents`, "array[EventSummary]", loadNamespace("factset.analyticsapi.engines")) + self + } + ) +) diff --git a/auto-generated-sdk/R/fiab_calculation_status_summary.R b/auto-generated-sdk/R/fiab_calculation_status_summary.R new file mode 100644 index 0000000..1d65262 --- /dev/null +++ b/auto-generated-sdk/R/fiab_calculation_status_summary.R @@ -0,0 +1,86 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title FIABCalculationStatusSummary +#' @description FIABCalculationStatusSummary Class +#' @format An \code{R6Class} generator object +#' @field requesttime character [optional] +#' +#' @field lastpolltime character [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +FIABCalculationStatusSummary <- R6::R6Class( + 'FIABCalculationStatusSummary', + public = list( + `requesttime` = NULL, + `lastpolltime` = NULL, + initialize = function(`requesttime`=NULL, `lastpolltime`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`requesttime`)) { + stopifnot(is.character(`requesttime`), length(`requesttime`) == 1) + self$`requesttime` <- `requesttime` + } + if (!is.null(`lastpolltime`)) { + stopifnot(is.character(`lastpolltime`), length(`lastpolltime`) == 1) + self$`lastpolltime` <- `lastpolltime` + } + }, + toJSON = function() { + FIABCalculationStatusSummaryObject <- list() + if (!is.null(self$`requesttime`)) { + FIABCalculationStatusSummaryObject[['requesttime']] <- + self$`requesttime` + } + if (!is.null(self$`lastpolltime`)) { + FIABCalculationStatusSummaryObject[['lastpolltime']] <- + self$`lastpolltime` + } + + FIABCalculationStatusSummaryObject + }, + fromJSON = function(FIABCalculationStatusSummaryJson) { + FIABCalculationStatusSummaryObject <- jsonlite::fromJSON(FIABCalculationStatusSummaryJson) + if (!is.null(FIABCalculationStatusSummaryObject$`requesttime`)) { + self$`requesttime` <- FIABCalculationStatusSummaryObject$`requesttime` + } + if (!is.null(FIABCalculationStatusSummaryObject$`lastpolltime`)) { + self$`lastpolltime` <- FIABCalculationStatusSummaryObject$`lastpolltime` + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`requesttime`)) { + sprintf( + '"requesttime": + "%s" + ', + self$`requesttime` + )}, + if (!is.null(self$`lastpolltime`)) { + sprintf( + '"lastpolltime": + "%s" + ', + self$`lastpolltime` + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(FIABCalculationStatusSummaryJson) { + FIABCalculationStatusSummaryObject <- jsonlite::fromJSON(FIABCalculationStatusSummaryJson) + self$`requesttime` <- FIABCalculationStatusSummaryObject$`requesttime` + self$`lastpolltime` <- FIABCalculationStatusSummaryObject$`lastpolltime` + self + } + ) +) diff --git a/auto-generated-sdk/R/fiab_calculations_api.R b/auto-generated-sdk/R/fiab_calculations_api.R new file mode 100644 index 0000000..282370e --- /dev/null +++ b/auto-generated-sdk/R/fiab_calculations_api.R @@ -0,0 +1,619 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title FIABCalculations operations +#' @description factset.analyticsapi.engines.FIABCalculations +#' @format An \code{R6Class} generator object +#' @field apiClient Handles the client-server communication. +#' +#' @section Methods: +#' \describe{ +#' \strong{ GetFIABCalculationById } \emph{ Get FIAB calculation by id } +#' This is the endpoint to check on the progress of a previously requested calculation. +#' +#' \itemize{ +#' \item \emph{ @param } id character +#' \item \emph{ @returnType } \link{FIABCalculationStatus} \cr +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 200 | Expected response, returns status information of the entire calculation if it is complete. +#' +#' \item return type : FIABCalculationStatus +#' \item response headers : +#' +#' \tabular{ll}{ +#' Content-Encoding \tab Standard HTTP header. Header value based on Accept-Encoding Request header. \cr +#' Content-Type \tab Standard HTTP header. \cr +#' Transfer-Encoding \tab Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 202 | Expected response, returns status information of the entire calculation if it is not complete. +#' +#' \item return type : FIABCalculationStatus +#' \item response headers : +#' +#' \tabular{ll}{ +#' Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid identifier provided. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in sometime. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' \strong{ GetFIABCalculationStatusSummaries } \emph{ Get all FIAB calculation summaries } +#' This endpoints returns all FIAB calculation requests. +#' +#' \itemize{ +#' \item \emph{ @returnType } named list( \link{FIABCalculationStatusSummary} ) \cr +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 200 | List of active FIAB calculation requests. +#' +#' \item return type : map(FIABCalculationStatusSummary) +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in sometime. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' \strong{ RunFIABCalculation } \emph{ Run FIAB calculation } +#' This endpoint creates a new FIAB calculation. This must be used first before get status or cancelling endpoints with a calculation id. A successful response will contain the URL to check the status of the calculation request. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the FIAB template. +#' +#' \itemize{ +#' \item \emph{ @param } fiab.calculation.parameters \link{FIABCalculationParameters} +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 202 | Expected response, contains the URL in the Location header to check the status of the calculation. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' Location \tab URL to check status of the request. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Calculations-Limit \tab Maximum FIAB request limit. \cr +#' X-FactSet-Api-Calculations-Remaining \tab Number of FIAB requests remaining till request limit reached. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid POST body. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' Location \tab URL to check status of the request. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Calculations-Limit \tab Maximum FIAB request limit. \cr +#' X-FactSet-Api-Calculations-Remaining \tab Number of FIAB requests remaining till request limit reached. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' Location \tab URL to check status of the request. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Calculations-Limit \tab Maximum FIAB request limit. \cr +#' X-FactSet-Api-Calculations-Remaining \tab Number of FIAB requests remaining till request limit reached. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' Location \tab URL to check status of the request. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Calculations-Limit \tab Maximum FIAB request limit. \cr +#' X-FactSet-Api-Calculations-Remaining \tab Number of FIAB requests remaining till request limit reached. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 415 | Missing/Invalid Content-Type header. Header needs to be set to application/json. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' Location \tab URL to check status of the request. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Calculations-Limit \tab Maximum FIAB request limit. \cr +#' X-FactSet-Api-Calculations-Remaining \tab Number of FIAB requests remaining till request limit reached. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Cancel older requests using Cancel FIAB Calculation endpoint or wait for older requests to finish / expire. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' Location \tab URL to check status of the request. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Calculations-Limit \tab Maximum FIAB request limit. \cr +#' X-FactSet-Api-Calculations-Remaining \tab Number of FIAB requests remaining till request limit reached. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' Location \tab URL to check status of the request. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Calculations-Limit \tab Maximum FIAB request limit. \cr +#' X-FactSet-Api-Calculations-Remaining \tab Number of FIAB requests remaining till request limit reached. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in sometime. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' Location \tab URL to check status of the request. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-FactSet-Api-Calculations-Limit \tab Maximum FIAB request limit. \cr +#' X-FactSet-Api-Calculations-Remaining \tab Number of FIAB requests remaining till request limit reached. \cr +#' } +#' } +#' +#' } +#' +#' +#' @examples +#' \dontrun{ +#' #################### GetFIABCalculationById #################### +#' +#' library(factset.analyticsapi.engines) +#' var.id <- 'id_example' # character | from url, provided from the location header in the Run FIAB Calculation endpoint +#' +#' #Get FIAB calculation by id +#' api.instance <- FIABCalculationsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$GetFIABCalculationById(var.id), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # deserialized response object +#' response.object <- result$content +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' #################### GetFIABCalculationStatusSummaries #################### +#' +#' library(factset.analyticsapi.engines) +#' +#' #Get all FIAB calculation summaries +#' api.instance <- FIABCalculationsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$GetFIABCalculationStatusSummaries(), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # deserialized response object +#' response.object <- result$content +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' #################### RunFIABCalculation #################### +#' +#' library(factset.analyticsapi.engines) +#' var.fiab.calculation.parameters <- FIABCalculationParameters$new() # FIABCalculationParameters | +#' +#' #Run FIAB calculation +#' api.instance <- FIABCalculationsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$RunFIABCalculation(fiab.calculation.parameters=var.fiab.calculation.parameters), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' } +#' @importFrom R6 R6Class +#' @importFrom base64enc base64encode +#' @importFrom rlang abort +#' @export +FIABCalculationsApi <- R6::R6Class( + 'FIABCalculationsApi', + public = list( + apiClient = NULL, + initialize = function(apiClient){ + if (!missing(apiClient)) { + self$apiClient <- apiClient + } + else { + self$apiClient <- ApiClient$new() + } + }, + GetFIABCalculationById = function(id, ...){ + apiResponse <- self$GetFIABCalculationByIdWithHttpInfo(id, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + GetFIABCalculationByIdWithHttpInfo = function(id, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`id`)) { + rlang::abort(message = "Missing required parameter `id`.", .subclass = "ApiException", ApiException = ApiException$new(status = 0, reason = "Missing required parameter `id`.")) + } + + urlPath <- "/analytics/engines/fiab/v1/calculations/{id}" + if (!missing(`id`)) { + urlPath <- gsub(paste0("\\{", "id", "\\}"), URLencode(as.character(`id`), reserved = TRUE), urlPath) + } + + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "FIABCalculationStatus", loadNamespace("factset.analyticsapi.engines")), + error = function(e){ + rlang::abort(message = "Failed to deserialize response", .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + }, + GetFIABCalculationStatusSummaries = function(...){ + apiResponse <- self$GetFIABCalculationStatusSummariesWithHttpInfo(...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + GetFIABCalculationStatusSummariesWithHttpInfo = function(...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + urlPath <- "/analytics/engines/fiab/v1/calculations" + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "map(FIABCalculationStatusSummary)", loadNamespace("factset.analyticsapi.engines")), + error = function(e){ + rlang::abort(message = "Failed to deserialize response", .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + }, + RunFIABCalculation = function(fiab.calculation.parameters=NULL, ...){ + apiResponse <- self$RunFIABCalculationWithHttpInfo(fiab.calculation.parameters, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + RunFIABCalculationWithHttpInfo = function(fiab.calculation.parameters=NULL, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (!missing(`fiab.calculation.parameters`)) { + body <- `fiab.calculation.parameters`$toJSONString() + } else { + body <- NULL + } + + urlPath <- "/analytics/engines/fiab/v1/calculations" + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "POST", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + ApiResponse$new(NULL, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + } + ) +) diff --git a/auto-generated-sdk/R/fiab_date_parameters.R b/auto-generated-sdk/R/fiab_date_parameters.R new file mode 100644 index 0000000..4f330b6 --- /dev/null +++ b/auto-generated-sdk/R/fiab_date_parameters.R @@ -0,0 +1,86 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title FIABDateParameters +#' @description FIABDateParameters Class +#' @format An \code{R6Class} generator object +#' @field startdate character +#' +#' @field enddate character +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +FIABDateParameters <- R6::R6Class( + 'FIABDateParameters', + public = list( + `startdate` = NULL, + `enddate` = NULL, + initialize = function(`startdate`, `enddate`, ...){ + local.optional.var <- list(...) + if (!missing(`startdate`)) { + stopifnot(is.character(`startdate`), length(`startdate`) == 1) + self$`startdate` <- `startdate` + } + if (!missing(`enddate`)) { + stopifnot(is.character(`enddate`), length(`enddate`) == 1) + self$`enddate` <- `enddate` + } + }, + toJSON = function() { + FIABDateParametersObject <- list() + if (!is.null(self$`startdate`)) { + FIABDateParametersObject[['startdate']] <- + self$`startdate` + } + if (!is.null(self$`enddate`)) { + FIABDateParametersObject[['enddate']] <- + self$`enddate` + } + + FIABDateParametersObject + }, + fromJSON = function(FIABDateParametersJson) { + FIABDateParametersObject <- jsonlite::fromJSON(FIABDateParametersJson) + if (!is.null(FIABDateParametersObject$`startdate`)) { + self$`startdate` <- FIABDateParametersObject$`startdate` + } + if (!is.null(FIABDateParametersObject$`enddate`)) { + self$`enddate` <- FIABDateParametersObject$`enddate` + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`startdate`)) { + sprintf( + '"startdate": + "%s" + ', + self$`startdate` + )}, + if (!is.null(self$`enddate`)) { + sprintf( + '"enddate": + "%s" + ', + self$`enddate` + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(FIABDateParametersJson) { + FIABDateParametersObject <- jsonlite::fromJSON(FIABDateParametersJson) + self$`startdate` <- FIABDateParametersObject$`startdate` + self$`enddate` <- FIABDateParametersObject$`enddate` + self + } + ) +) diff --git a/auto-generated-sdk/R/fiab_identifier.R b/auto-generated-sdk/R/fiab_identifier.R new file mode 100644 index 0000000..d56dc71 --- /dev/null +++ b/auto-generated-sdk/R/fiab_identifier.R @@ -0,0 +1,64 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title FIABIdentifier +#' @description FIABIdentifier Class +#' @format An \code{R6Class} generator object +#' @field id character +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +FIABIdentifier <- R6::R6Class( + 'FIABIdentifier', + public = list( + `id` = NULL, + initialize = function(`id`, ...){ + local.optional.var <- list(...) + if (!missing(`id`)) { + stopifnot(is.character(`id`), length(`id`) == 1) + self$`id` <- `id` + } + }, + toJSON = function() { + FIABIdentifierObject <- list() + if (!is.null(self$`id`)) { + FIABIdentifierObject[['id']] <- + self$`id` + } + + FIABIdentifierObject + }, + fromJSON = function(FIABIdentifierJson) { + FIABIdentifierObject <- jsonlite::fromJSON(FIABIdentifierJson) + if (!is.null(FIABIdentifierObject$`id`)) { + self$`id` <- FIABIdentifierObject$`id` + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`id`)) { + sprintf( + '"id": + "%s" + ', + self$`id` + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(FIABIdentifierJson) { + FIABIdentifierObject <- jsonlite::fromJSON(FIABIdentifierJson) + self$`id` <- FIABIdentifierObject$`id` + self + } + ) +) diff --git a/auto-generated-sdk/R/frequencies_api.R b/auto-generated-sdk/R/frequencies_api.R index 8a786a5..8a744eb 100644 --- a/auto-generated-sdk/R/frequencies_api.R +++ b/auto-generated-sdk/R/frequencies_api.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech @@ -28,11 +28,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication. #' @@ -40,11 +40,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials #' @@ -52,11 +49,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. #' @@ -64,11 +61,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. #' @@ -76,11 +83,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in sometime. #' @@ -88,11 +92,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' @@ -110,11 +111,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication. #' @@ -122,11 +123,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials #' @@ -134,11 +132,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. #' @@ -146,11 +144,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. #' @@ -158,11 +166,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in sometime. #' @@ -170,11 +175,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' @@ -192,11 +194,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication. #' @@ -204,11 +206,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials #' @@ -216,11 +215,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. #' @@ -228,11 +227,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. #' @@ -240,11 +249,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in sometime. #' @@ -252,11 +258,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' diff --git a/auto-generated-sdk/R/frequency.R b/auto-generated-sdk/R/frequency.R index 076510a..47d21f0 100644 --- a/auto-generated-sdk/R/frequency.R +++ b/auto-generated-sdk/R/frequency.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/group.R b/auto-generated-sdk/R/group.R index 9364aae..39c7eff 100644 --- a/auto-generated-sdk/R/group.R +++ b/auto-generated-sdk/R/group.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/groups_api.R b/auto-generated-sdk/R/groups_api.R index f18d564..221ef24 100644 --- a/auto-generated-sdk/R/groups_api.R +++ b/auto-generated-sdk/R/groups_api.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech @@ -28,12 +28,12 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' Age \tab Standard HTTP header. Header will specify the age of groupings list cached response. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 401 | Missing or invalid authentication. #' @@ -41,11 +41,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 403 | User is forbidden with current credentials #' @@ -53,11 +50,11 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' } #' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. #' @@ -65,11 +62,21 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr #' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr #' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr #' } #' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting #' @@ -77,11 +84,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' \item status code : 503 | Request timed out. Retry the request in sometime. #' @@ -89,11 +93,8 @@ #' \item response headers : #' #' \tabular{ll}{ -#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr #' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr #' } #' } #' diff --git a/auto-generated-sdk/R/optimal_portfolio.R b/auto-generated-sdk/R/optimal_portfolio.R new file mode 100644 index 0000000..e47e207 --- /dev/null +++ b/auto-generated-sdk/R/optimal_portfolio.R @@ -0,0 +1,129 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title OptimalPortfolio +#' @description OptimalPortfolio Class +#' @format An \code{R6Class} generator object +#' @field acctname character [optional] +#' +#' @field excludezero character [optional] +#' +#' @field archivedate character [optional] +#' +#' @field ifexists character [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +OptimalPortfolio <- R6::R6Class( + 'OptimalPortfolio', + public = list( + `acctname` = NULL, + `excludezero` = NULL, + `archivedate` = NULL, + `ifexists` = NULL, + initialize = function(`acctname`=NULL, `excludezero`=NULL, `archivedate`=NULL, `ifexists`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`acctname`)) { + stopifnot(is.character(`acctname`), length(`acctname`) == 1) + self$`acctname` <- `acctname` + } + if (!is.null(`excludezero`)) { + self$`excludezero` <- `excludezero` + } + if (!is.null(`archivedate`)) { + stopifnot(is.character(`archivedate`), length(`archivedate`) == 1) + self$`archivedate` <- `archivedate` + } + if (!is.null(`ifexists`)) { + stopifnot(is.character(`ifexists`), length(`ifexists`) == 1) + self$`ifexists` <- `ifexists` + } + }, + toJSON = function() { + OptimalPortfolioObject <- list() + if (!is.null(self$`acctname`)) { + OptimalPortfolioObject[['acctname']] <- + self$`acctname` + } + if (!is.null(self$`excludezero`)) { + OptimalPortfolioObject[['excludezero']] <- + self$`excludezero` + } + if (!is.null(self$`archivedate`)) { + OptimalPortfolioObject[['archivedate']] <- + self$`archivedate` + } + if (!is.null(self$`ifexists`)) { + OptimalPortfolioObject[['ifexists']] <- + self$`ifexists` + } + + OptimalPortfolioObject + }, + fromJSON = function(OptimalPortfolioJson) { + OptimalPortfolioObject <- jsonlite::fromJSON(OptimalPortfolioJson) + if (!is.null(OptimalPortfolioObject$`acctname`)) { + self$`acctname` <- OptimalPortfolioObject$`acctname` + } + if (!is.null(OptimalPortfolioObject$`excludezero`)) { + self$`excludezero` <- OptimalPortfolioObject$`excludezero` + } + if (!is.null(OptimalPortfolioObject$`archivedate`)) { + self$`archivedate` <- OptimalPortfolioObject$`archivedate` + } + if (!is.null(OptimalPortfolioObject$`ifexists`)) { + self$`ifexists` <- OptimalPortfolioObject$`ifexists` + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`acctname`)) { + sprintf( + '"acctname": + "%s" + ', + self$`acctname` + )}, + if (!is.null(self$`excludezero`)) { + sprintf( + '"excludezero": + "%s" + ', + self$`excludezero` + )}, + if (!is.null(self$`archivedate`)) { + sprintf( + '"archivedate": + "%s" + ', + self$`archivedate` + )}, + if (!is.null(self$`ifexists`)) { + sprintf( + '"ifexists": + "%s" + ', + self$`ifexists` + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(OptimalPortfolioJson) { + OptimalPortfolioObject <- jsonlite::fromJSON(OptimalPortfolioJson) + self$`acctname` <- OptimalPortfolioObject$`acctname` + self$`excludezero` <- OptimalPortfolioObject$`excludezero` + self$`archivedate` <- OptimalPortfolioObject$`archivedate` + self$`ifexists` <- OptimalPortfolioObject$`ifexists` + self + } + ) +) diff --git a/auto-generated-sdk/R/optimization.R b/auto-generated-sdk/R/optimization.R new file mode 100644 index 0000000..050e9a9 --- /dev/null +++ b/auto-generated-sdk/R/optimization.R @@ -0,0 +1,108 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title Optimization +#' @description Optimization Class +#' @format An \code{R6Class} generator object +#' @field riskmodeldate character [optional] +#' +#' @field backtestdate character [optional] +#' +#' @field cashflow character [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +Optimization <- R6::R6Class( + 'Optimization', + public = list( + `riskmodeldate` = NULL, + `backtestdate` = NULL, + `cashflow` = NULL, + initialize = function(`riskmodeldate`=NULL, `backtestdate`=NULL, `cashflow`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`riskmodeldate`)) { + stopifnot(is.character(`riskmodeldate`), length(`riskmodeldate`) == 1) + self$`riskmodeldate` <- `riskmodeldate` + } + if (!is.null(`backtestdate`)) { + stopifnot(is.character(`backtestdate`), length(`backtestdate`) == 1) + self$`backtestdate` <- `backtestdate` + } + if (!is.null(`cashflow`)) { + stopifnot(is.character(`cashflow`), length(`cashflow`) == 1) + self$`cashflow` <- `cashflow` + } + }, + toJSON = function() { + OptimizationObject <- list() + if (!is.null(self$`riskmodeldate`)) { + OptimizationObject[['riskmodeldate']] <- + self$`riskmodeldate` + } + if (!is.null(self$`backtestdate`)) { + OptimizationObject[['backtestdate']] <- + self$`backtestdate` + } + if (!is.null(self$`cashflow`)) { + OptimizationObject[['cashflow']] <- + self$`cashflow` + } + + OptimizationObject + }, + fromJSON = function(OptimizationJson) { + OptimizationObject <- jsonlite::fromJSON(OptimizationJson) + if (!is.null(OptimizationObject$`riskmodeldate`)) { + self$`riskmodeldate` <- OptimizationObject$`riskmodeldate` + } + if (!is.null(OptimizationObject$`backtestdate`)) { + self$`backtestdate` <- OptimizationObject$`backtestdate` + } + if (!is.null(OptimizationObject$`cashflow`)) { + self$`cashflow` <- OptimizationObject$`cashflow` + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`riskmodeldate`)) { + sprintf( + '"riskmodeldate": + "%s" + ', + self$`riskmodeldate` + )}, + if (!is.null(self$`backtestdate`)) { + sprintf( + '"backtestdate": + "%s" + ', + self$`backtestdate` + )}, + if (!is.null(self$`cashflow`)) { + sprintf( + '"cashflow": + "%s" + ', + self$`cashflow` + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(OptimizationJson) { + OptimizationObject <- jsonlite::fromJSON(OptimizationJson) + self$`riskmodeldate` <- OptimizationObject$`riskmodeldate` + self$`backtestdate` <- OptimizationObject$`backtestdate` + self$`cashflow` <- OptimizationObject$`cashflow` + self + } + ) +) diff --git a/auto-generated-sdk/R/optimizations_api.R b/auto-generated-sdk/R/optimizations_api.R new file mode 100644 index 0000000..5daf5b8 --- /dev/null +++ b/auto-generated-sdk/R/optimizations_api.R @@ -0,0 +1,615 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title Optimizations operations +#' @description factset.analyticsapi.engines.Optimizations +#' @format An \code{R6Class} generator object +#' @field apiClient Handles the client-server communication. +#' +#' @section Methods: +#' \describe{ +#' \strong{ CancelAxiomaOptimizationById } \emph{ Cancel Axioma optimization by id } +#' This is the endpoint to cancel a previously submitted optimization. Instead of doing a GET on the polling URL, cancel the request by doing a DELETE. +#' +#' \itemize{ +#' \item \emph{ @param } id character +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 204 | Expected response, optimization was canceled successfully. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid identifier provided. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | There was no request for the optimization identifier provided, or the request was already canceled for the provided identifier. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in sometime. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' \strong{ GetAxiomaOptimizationById } \emph{ Get Axioma optimization by id } +#' This is the endpoint to check on the progress of a previously requested optimization. If the optimization has finished computing, the body of the response will contain result in JSON. Otherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. +#' +#' \itemize{ +#' \item \emph{ @param } id character +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 200 | Expected response once optimization is completed, returns JSON in the format specified in the Run Optimization endpoint. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' Content-Encoding \tab Standard HTTP header. Header value based on Accept-Encoding Request header. \cr +#' Content-Type \tab Standard HTTP header. \cr +#' Transfer-Encoding \tab Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. \cr +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 202 | Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-FactSet-Api-PickUp-Progress \tab FactSet’s progress header. \cr +#' Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid identifier provided. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in sometime. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' \strong{ RunAxiomaOptimization } \emph{ Run Axioma optimization } +#' This endpoint runs Axioma optimization specified in the POST body parameters. It must be used first before polling or cancelling endpoints. A successful response will contain the URL to poll for the result of the optimization. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the strategy document. +#' +#' \itemize{ +#' \item \emph{ @param } axioma.equity.optimization.parameters \link{AxiomaEquityOptimizationParameters} +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 202 | Expected response, contains the URL in the Location header to check the status of the optimization. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' Location \tab URL to poll for the resulting optimization \cr +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 201 | Expected response if optimization is completed within 30 seconds, returns JSON in the format specified in the Run optimization endpoint. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid POST body. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | One or more optimization settings were unavailable. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 415 | Missing/Invalid Content-Type header. Header needs to be set to application/json. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in sometime. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' } +#' +#' +#' @examples +#' \dontrun{ +#' #################### CancelAxiomaOptimizationById #################### +#' +#' library(factset.analyticsapi.engines) +#' var.id <- 'id_example' # character | from url, provided from the location header in the Run Optimization endpoint +#' +#' #Cancel Axioma optimization by id +#' api.instance <- OptimizationsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$CancelAxiomaOptimizationById(var.id), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' #################### GetAxiomaOptimizationById #################### +#' +#' library(factset.analyticsapi.engines) +#' var.id <- 'id_example' # character | from url, provided from the location header in the Run Optimization endpoint +#' +#' #Get Axioma optimization by id +#' api.instance <- OptimizationsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$GetAxiomaOptimizationById(var.id), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' #################### RunAxiomaOptimization #################### +#' +#' library(factset.analyticsapi.engines) +#' var.axioma.equity.optimization.parameters <- AxiomaEquityOptimizationParameters$new() # AxiomaEquityOptimizationParameters | +#' +#' #Run Axioma optimization +#' api.instance <- OptimizationsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$RunAxiomaOptimization(axioma.equity.optimization.parameters=var.axioma.equity.optimization.parameters), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' } +#' @importFrom R6 R6Class +#' @importFrom base64enc base64encode +#' @importFrom rlang abort +#' @export +OptimizationsApi <- R6::R6Class( + 'OptimizationsApi', + public = list( + apiClient = NULL, + initialize = function(apiClient){ + if (!missing(apiClient)) { + self$apiClient <- apiClient + } + else { + self$apiClient <- ApiClient$new() + } + }, + CancelAxiomaOptimizationById = function(id, ...){ + apiResponse <- self$CancelAxiomaOptimizationByIdWithHttpInfo(id, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + CancelAxiomaOptimizationByIdWithHttpInfo = function(id, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`id`)) { + rlang::abort(message = "Missing required parameter `id`.", .subclass = "ApiException", ApiException = ApiException$new(status = 0, reason = "Missing required parameter `id`.")) + } + + urlPath <- "/analytics/engines/axp/v1/optimizations/{id}" + if (!missing(`id`)) { + urlPath <- gsub(paste0("\\{", "id", "\\}"), URLencode(as.character(`id`), reserved = TRUE), urlPath) + } + + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "DELETE", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + ApiResponse$new(NULL, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + }, + GetAxiomaOptimizationById = function(id, ...){ + apiResponse <- self$GetAxiomaOptimizationByIdWithHttpInfo(id, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + GetAxiomaOptimizationByIdWithHttpInfo = function(id, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`id`)) { + rlang::abort(message = "Missing required parameter `id`.", .subclass = "ApiException", ApiException = ApiException$new(status = 0, reason = "Missing required parameter `id`.")) + } + + urlPath <- "/analytics/engines/axp/v1/optimizations/{id}" + if (!missing(`id`)) { + urlPath <- gsub(paste0("\\{", "id", "\\}"), URLencode(as.character(`id`), reserved = TRUE), urlPath) + } + + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + ApiResponse$new(NULL, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + }, + RunAxiomaOptimization = function(axioma.equity.optimization.parameters=NULL, ...){ + apiResponse <- self$RunAxiomaOptimizationWithHttpInfo(axioma.equity.optimization.parameters, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + RunAxiomaOptimizationWithHttpInfo = function(axioma.equity.optimization.parameters=NULL, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (!missing(`axioma.equity.optimization.parameters`)) { + body <- `axioma.equity.optimization.parameters`$toJSONString() + } else { + body <- NULL + } + + urlPath <- "/analytics/engines/axp/v1/optimizations" + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "POST", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + ApiResponse$new(NULL, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + } + ) +) diff --git a/auto-generated-sdk/R/optimizer_account.R b/auto-generated-sdk/R/optimizer_account.R new file mode 100644 index 0000000..b92acb6 --- /dev/null +++ b/auto-generated-sdk/R/optimizer_account.R @@ -0,0 +1,88 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title OptimizerAccount +#' @description OptimizerAccount Class +#' @format An \code{R6Class} generator object +#' @field id character [optional] +#' +#' @field overrides \link{OptimizerAccountOverrides} [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +OptimizerAccount <- R6::R6Class( + 'OptimizerAccount', + public = list( + `id` = NULL, + `overrides` = NULL, + initialize = function(`id`=NULL, `overrides`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`id`)) { + stopifnot(is.character(`id`), length(`id`) == 1) + self$`id` <- `id` + } + if (!is.null(`overrides`)) { + stopifnot(R6::is.R6(`overrides`)) + self$`overrides` <- `overrides` + } + }, + toJSON = function() { + OptimizerAccountObject <- list() + if (!is.null(self$`id`)) { + OptimizerAccountObject[['id']] <- + self$`id` + } + if (!is.null(self$`overrides`)) { + OptimizerAccountObject[['overrides']] <- + self$`overrides`$toJSON() + } + + OptimizerAccountObject + }, + fromJSON = function(OptimizerAccountJson) { + OptimizerAccountObject <- jsonlite::fromJSON(OptimizerAccountJson) + if (!is.null(OptimizerAccountObject$`id`)) { + self$`id` <- OptimizerAccountObject$`id` + } + if (!is.null(OptimizerAccountObject$`overrides`)) { + overridesObject <- OptimizerAccountOverrides$new() + overridesObject$fromJSON(jsonlite::toJSON(OptimizerAccountObject$overrides, auto_unbox = TRUE, digits = NA)) + self$`overrides` <- overridesObject + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`id`)) { + sprintf( + '"id": + "%s" + ', + self$`id` + )}, + if (!is.null(self$`overrides`)) { + sprintf( + '"overrides": + %s + ', + jsonlite::toJSON(self$`overrides`$toJSON(), auto_unbox=TRUE, digits = NA) + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(OptimizerAccountJson) { + OptimizerAccountObject <- jsonlite::fromJSON(OptimizerAccountJson) + self$`id` <- OptimizerAccountObject$`id` + self$`overrides` <- OptimizerAccountOverrides$new()$fromJSON(jsonlite::toJSON(OptimizerAccountObject$overrides, auto_unbox = TRUE, digits = NA)) + self + } + ) +) diff --git a/auto-generated-sdk/R/optimizer_account_overrides.R b/auto-generated-sdk/R/optimizer_account_overrides.R new file mode 100644 index 0000000..9629d41 --- /dev/null +++ b/auto-generated-sdk/R/optimizer_account_overrides.R @@ -0,0 +1,130 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title OptimizerAccountOverrides +#' @description OptimizerAccountOverrides Class +#' @format An \code{R6Class} generator object +#' @field portfolio character [optional] +#' +#' @field benchmark character [optional] +#' +#' @field riskmodelid character [optional] +#' +#' @field currency character [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +OptimizerAccountOverrides <- R6::R6Class( + 'OptimizerAccountOverrides', + public = list( + `portfolio` = NULL, + `benchmark` = NULL, + `riskmodelid` = NULL, + `currency` = NULL, + initialize = function(`portfolio`=NULL, `benchmark`=NULL, `riskmodelid`=NULL, `currency`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`portfolio`)) { + stopifnot(is.character(`portfolio`), length(`portfolio`) == 1) + self$`portfolio` <- `portfolio` + } + if (!is.null(`benchmark`)) { + stopifnot(is.character(`benchmark`), length(`benchmark`) == 1) + self$`benchmark` <- `benchmark` + } + if (!is.null(`riskmodelid`)) { + stopifnot(is.character(`riskmodelid`), length(`riskmodelid`) == 1) + self$`riskmodelid` <- `riskmodelid` + } + if (!is.null(`currency`)) { + stopifnot(is.character(`currency`), length(`currency`) == 1) + self$`currency` <- `currency` + } + }, + toJSON = function() { + OptimizerAccountOverridesObject <- list() + if (!is.null(self$`portfolio`)) { + OptimizerAccountOverridesObject[['portfolio']] <- + self$`portfolio` + } + if (!is.null(self$`benchmark`)) { + OptimizerAccountOverridesObject[['benchmark']] <- + self$`benchmark` + } + if (!is.null(self$`riskmodelid`)) { + OptimizerAccountOverridesObject[['riskmodelid']] <- + self$`riskmodelid` + } + if (!is.null(self$`currency`)) { + OptimizerAccountOverridesObject[['currency']] <- + self$`currency` + } + + OptimizerAccountOverridesObject + }, + fromJSON = function(OptimizerAccountOverridesJson) { + OptimizerAccountOverridesObject <- jsonlite::fromJSON(OptimizerAccountOverridesJson) + if (!is.null(OptimizerAccountOverridesObject$`portfolio`)) { + self$`portfolio` <- OptimizerAccountOverridesObject$`portfolio` + } + if (!is.null(OptimizerAccountOverridesObject$`benchmark`)) { + self$`benchmark` <- OptimizerAccountOverridesObject$`benchmark` + } + if (!is.null(OptimizerAccountOverridesObject$`riskmodelid`)) { + self$`riskmodelid` <- OptimizerAccountOverridesObject$`riskmodelid` + } + if (!is.null(OptimizerAccountOverridesObject$`currency`)) { + self$`currency` <- OptimizerAccountOverridesObject$`currency` + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`portfolio`)) { + sprintf( + '"portfolio": + "%s" + ', + self$`portfolio` + )}, + if (!is.null(self$`benchmark`)) { + sprintf( + '"benchmark": + "%s" + ', + self$`benchmark` + )}, + if (!is.null(self$`riskmodelid`)) { + sprintf( + '"riskmodelid": + "%s" + ', + self$`riskmodelid` + )}, + if (!is.null(self$`currency`)) { + sprintf( + '"currency": + "%s" + ', + self$`currency` + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(OptimizerAccountOverridesJson) { + OptimizerAccountOverridesObject <- jsonlite::fromJSON(OptimizerAccountOverridesJson) + self$`portfolio` <- OptimizerAccountOverridesObject$`portfolio` + self$`benchmark` <- OptimizerAccountOverridesObject$`benchmark` + self$`riskmodelid` <- OptimizerAccountOverridesObject$`riskmodelid` + self$`currency` <- OptimizerAccountOverridesObject$`currency` + self + } + ) +) diff --git a/auto-generated-sdk/R/optimizer_optimal_holdings.R b/auto-generated-sdk/R/optimizer_optimal_holdings.R new file mode 100644 index 0000000..d78d531 --- /dev/null +++ b/auto-generated-sdk/R/optimizer_optimal_holdings.R @@ -0,0 +1,106 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title OptimizerOptimalHoldings +#' @description OptimizerOptimalHoldings Class +#' @format An \code{R6Class} generator object +#' @field identifiertype character [optional] +#' +#' @field includecash character [optional] +#' +#' @field excludezero character [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +OptimizerOptimalHoldings <- R6::R6Class( + 'OptimizerOptimalHoldings', + public = list( + `identifiertype` = NULL, + `includecash` = NULL, + `excludezero` = NULL, + initialize = function(`identifiertype`=NULL, `includecash`=NULL, `excludezero`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`identifiertype`)) { + stopifnot(is.character(`identifiertype`), length(`identifiertype`) == 1) + self$`identifiertype` <- `identifiertype` + } + if (!is.null(`includecash`)) { + self$`includecash` <- `includecash` + } + if (!is.null(`excludezero`)) { + self$`excludezero` <- `excludezero` + } + }, + toJSON = function() { + OptimizerOptimalHoldingsObject <- list() + if (!is.null(self$`identifiertype`)) { + OptimizerOptimalHoldingsObject[['identifiertype']] <- + self$`identifiertype` + } + if (!is.null(self$`includecash`)) { + OptimizerOptimalHoldingsObject[['includecash']] <- + self$`includecash` + } + if (!is.null(self$`excludezero`)) { + OptimizerOptimalHoldingsObject[['excludezero']] <- + self$`excludezero` + } + + OptimizerOptimalHoldingsObject + }, + fromJSON = function(OptimizerOptimalHoldingsJson) { + OptimizerOptimalHoldingsObject <- jsonlite::fromJSON(OptimizerOptimalHoldingsJson) + if (!is.null(OptimizerOptimalHoldingsObject$`identifiertype`)) { + self$`identifiertype` <- OptimizerOptimalHoldingsObject$`identifiertype` + } + if (!is.null(OptimizerOptimalHoldingsObject$`includecash`)) { + self$`includecash` <- OptimizerOptimalHoldingsObject$`includecash` + } + if (!is.null(OptimizerOptimalHoldingsObject$`excludezero`)) { + self$`excludezero` <- OptimizerOptimalHoldingsObject$`excludezero` + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`identifiertype`)) { + sprintf( + '"identifiertype": + "%s" + ', + self$`identifiertype` + )}, + if (!is.null(self$`includecash`)) { + sprintf( + '"includecash": + "%s" + ', + self$`includecash` + )}, + if (!is.null(self$`excludezero`)) { + sprintf( + '"excludezero": + "%s" + ', + self$`excludezero` + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(OptimizerOptimalHoldingsJson) { + OptimizerOptimalHoldingsObject <- jsonlite::fromJSON(OptimizerOptimalHoldingsJson) + self$`identifiertype` <- OptimizerOptimalHoldingsObject$`identifiertype` + self$`includecash` <- OptimizerOptimalHoldingsObject$`includecash` + self$`excludezero` <- OptimizerOptimalHoldingsObject$`excludezero` + self + } + ) +) diff --git a/auto-generated-sdk/R/optimizer_output_types.R b/auto-generated-sdk/R/optimizer_output_types.R new file mode 100644 index 0000000..1007c2f --- /dev/null +++ b/auto-generated-sdk/R/optimizer_output_types.R @@ -0,0 +1,114 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title OptimizerOutputTypes +#' @description OptimizerOutputTypes Class +#' @format An \code{R6Class} generator object +#' @field trades \link{OptimizerTradesList} [optional] +#' +#' @field optimal \link{OptimizerOptimalHoldings} [optional] +#' +#' @field account \link{OptimalPortfolio} [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +OptimizerOutputTypes <- R6::R6Class( + 'OptimizerOutputTypes', + public = list( + `trades` = NULL, + `optimal` = NULL, + `account` = NULL, + initialize = function(`trades`=NULL, `optimal`=NULL, `account`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`trades`)) { + stopifnot(R6::is.R6(`trades`)) + self$`trades` <- `trades` + } + if (!is.null(`optimal`)) { + stopifnot(R6::is.R6(`optimal`)) + self$`optimal` <- `optimal` + } + if (!is.null(`account`)) { + stopifnot(R6::is.R6(`account`)) + self$`account` <- `account` + } + }, + toJSON = function() { + OptimizerOutputTypesObject <- list() + if (!is.null(self$`trades`)) { + OptimizerOutputTypesObject[['trades']] <- + self$`trades`$toJSON() + } + if (!is.null(self$`optimal`)) { + OptimizerOutputTypesObject[['optimal']] <- + self$`optimal`$toJSON() + } + if (!is.null(self$`account`)) { + OptimizerOutputTypesObject[['account']] <- + self$`account`$toJSON() + } + + OptimizerOutputTypesObject + }, + fromJSON = function(OptimizerOutputTypesJson) { + OptimizerOutputTypesObject <- jsonlite::fromJSON(OptimizerOutputTypesJson) + if (!is.null(OptimizerOutputTypesObject$`trades`)) { + tradesObject <- OptimizerTradesList$new() + tradesObject$fromJSON(jsonlite::toJSON(OptimizerOutputTypesObject$trades, auto_unbox = TRUE, digits = NA)) + self$`trades` <- tradesObject + } + if (!is.null(OptimizerOutputTypesObject$`optimal`)) { + optimalObject <- OptimizerOptimalHoldings$new() + optimalObject$fromJSON(jsonlite::toJSON(OptimizerOutputTypesObject$optimal, auto_unbox = TRUE, digits = NA)) + self$`optimal` <- optimalObject + } + if (!is.null(OptimizerOutputTypesObject$`account`)) { + accountObject <- OptimalPortfolio$new() + accountObject$fromJSON(jsonlite::toJSON(OptimizerOutputTypesObject$account, auto_unbox = TRUE, digits = NA)) + self$`account` <- accountObject + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`trades`)) { + sprintf( + '"trades": + %s + ', + jsonlite::toJSON(self$`trades`$toJSON(), auto_unbox=TRUE, digits = NA) + )}, + if (!is.null(self$`optimal`)) { + sprintf( + '"optimal": + %s + ', + jsonlite::toJSON(self$`optimal`$toJSON(), auto_unbox=TRUE, digits = NA) + )}, + if (!is.null(self$`account`)) { + sprintf( + '"account": + %s + ', + jsonlite::toJSON(self$`account`$toJSON(), auto_unbox=TRUE, digits = NA) + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(OptimizerOutputTypesJson) { + OptimizerOutputTypesObject <- jsonlite::fromJSON(OptimizerOutputTypesJson) + self$`trades` <- OptimizerTradesList$new()$fromJSON(jsonlite::toJSON(OptimizerOutputTypesObject$trades, auto_unbox = TRUE, digits = NA)) + self$`optimal` <- OptimizerOptimalHoldings$new()$fromJSON(jsonlite::toJSON(OptimizerOutputTypesObject$optimal, auto_unbox = TRUE, digits = NA)) + self$`account` <- OptimalPortfolio$new()$fromJSON(jsonlite::toJSON(OptimizerOutputTypesObject$account, auto_unbox = TRUE, digits = NA)) + self + } + ) +) diff --git a/auto-generated-sdk/R/optimizer_strategy.R b/auto-generated-sdk/R/optimizer_strategy.R new file mode 100644 index 0000000..cb350f3 --- /dev/null +++ b/auto-generated-sdk/R/optimizer_strategy.R @@ -0,0 +1,88 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title OptimizerStrategy +#' @description OptimizerStrategy Class +#' @format An \code{R6Class} generator object +#' @field id character +#' +#' @field overrides \link{OptimizerStrategyOverrides} [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +OptimizerStrategy <- R6::R6Class( + 'OptimizerStrategy', + public = list( + `id` = NULL, + `overrides` = NULL, + initialize = function(`id`, `overrides`=NULL, ...){ + local.optional.var <- list(...) + if (!missing(`id`)) { + stopifnot(is.character(`id`), length(`id`) == 1) + self$`id` <- `id` + } + if (!is.null(`overrides`)) { + stopifnot(R6::is.R6(`overrides`)) + self$`overrides` <- `overrides` + } + }, + toJSON = function() { + OptimizerStrategyObject <- list() + if (!is.null(self$`id`)) { + OptimizerStrategyObject[['id']] <- + self$`id` + } + if (!is.null(self$`overrides`)) { + OptimizerStrategyObject[['overrides']] <- + self$`overrides`$toJSON() + } + + OptimizerStrategyObject + }, + fromJSON = function(OptimizerStrategyJson) { + OptimizerStrategyObject <- jsonlite::fromJSON(OptimizerStrategyJson) + if (!is.null(OptimizerStrategyObject$`id`)) { + self$`id` <- OptimizerStrategyObject$`id` + } + if (!is.null(OptimizerStrategyObject$`overrides`)) { + overridesObject <- OptimizerStrategyOverrides$new() + overridesObject$fromJSON(jsonlite::toJSON(OptimizerStrategyObject$overrides, auto_unbox = TRUE, digits = NA)) + self$`overrides` <- overridesObject + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`id`)) { + sprintf( + '"id": + "%s" + ', + self$`id` + )}, + if (!is.null(self$`overrides`)) { + sprintf( + '"overrides": + %s + ', + jsonlite::toJSON(self$`overrides`$toJSON(), auto_unbox=TRUE, digits = NA) + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(OptimizerStrategyJson) { + OptimizerStrategyObject <- jsonlite::fromJSON(OptimizerStrategyJson) + self$`id` <- OptimizerStrategyObject$`id` + self$`overrides` <- OptimizerStrategyOverrides$new()$fromJSON(jsonlite::toJSON(OptimizerStrategyObject$overrides, auto_unbox = TRUE, digits = NA)) + self + } + ) +) diff --git a/auto-generated-sdk/R/optimizer_strategy_overrides.R b/auto-generated-sdk/R/optimizer_strategy_overrides.R new file mode 100644 index 0000000..2fdc93a --- /dev/null +++ b/auto-generated-sdk/R/optimizer_strategy_overrides.R @@ -0,0 +1,153 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title OptimizerStrategyOverrides +#' @description OptimizerStrategyOverrides Class +#' @format An \code{R6Class} generator object +#' @field objective character [optional] +#' +#' @field constraints named list( character ) [optional] +#' +#' @field alpha character [optional] +#' +#' @field transactioncost character [optional] +#' +#' @field tax character [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +OptimizerStrategyOverrides <- R6::R6Class( + 'OptimizerStrategyOverrides', + public = list( + `objective` = NULL, + `constraints` = NULL, + `alpha` = NULL, + `transactioncost` = NULL, + `tax` = NULL, + initialize = function(`objective`=NULL, `constraints`=NULL, `alpha`=NULL, `transactioncost`=NULL, `tax`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`objective`)) { + stopifnot(is.character(`objective`), length(`objective`) == 1) + self$`objective` <- `objective` + } + if (!is.null(`constraints`)) { + stopifnot(is.vector(`constraints`), length(`constraints`) != 0) + sapply(`constraints`, function(x) stopifnot(is.character(x))) + self$`constraints` <- `constraints` + } + if (!is.null(`alpha`)) { + stopifnot(is.character(`alpha`), length(`alpha`) == 1) + self$`alpha` <- `alpha` + } + if (!is.null(`transactioncost`)) { + stopifnot(is.character(`transactioncost`), length(`transactioncost`) == 1) + self$`transactioncost` <- `transactioncost` + } + if (!is.null(`tax`)) { + stopifnot(is.character(`tax`), length(`tax`) == 1) + self$`tax` <- `tax` + } + }, + toJSON = function() { + OptimizerStrategyOverridesObject <- list() + if (!is.null(self$`objective`)) { + OptimizerStrategyOverridesObject[['objective']] <- + self$`objective` + } + if (!is.null(self$`constraints`)) { + OptimizerStrategyOverridesObject[['constraints']] <- + self$`constraints` + } + if (!is.null(self$`alpha`)) { + OptimizerStrategyOverridesObject[['alpha']] <- + self$`alpha` + } + if (!is.null(self$`transactioncost`)) { + OptimizerStrategyOverridesObject[['transactioncost']] <- + self$`transactioncost` + } + if (!is.null(self$`tax`)) { + OptimizerStrategyOverridesObject[['tax']] <- + self$`tax` + } + + OptimizerStrategyOverridesObject + }, + fromJSON = function(OptimizerStrategyOverridesJson) { + OptimizerStrategyOverridesObject <- jsonlite::fromJSON(OptimizerStrategyOverridesJson) + if (!is.null(OptimizerStrategyOverridesObject$`objective`)) { + self$`objective` <- OptimizerStrategyOverridesObject$`objective` + } + if (!is.null(OptimizerStrategyOverridesObject$`constraints`)) { + self$`constraints` <- ApiClient$new()$deserializeObj(OptimizerStrategyOverridesObject$`constraints`, "map(character)", loadNamespace("factset.analyticsapi.engines")) + } + if (!is.null(OptimizerStrategyOverridesObject$`alpha`)) { + self$`alpha` <- OptimizerStrategyOverridesObject$`alpha` + } + if (!is.null(OptimizerStrategyOverridesObject$`transactioncost`)) { + self$`transactioncost` <- OptimizerStrategyOverridesObject$`transactioncost` + } + if (!is.null(OptimizerStrategyOverridesObject$`tax`)) { + self$`tax` <- OptimizerStrategyOverridesObject$`tax` + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`objective`)) { + sprintf( + '"objective": + "%s" + ', + self$`objective` + )}, + if (!is.null(self$`constraints`)) { + sprintf( + '"constraints": + "%s" + ', + jsonlite::toJSON(lapply(self$`constraints`, function(x){ x }), auto_unbox = TRUE, digits=NA) + )}, + if (!is.null(self$`alpha`)) { + sprintf( + '"alpha": + "%s" + ', + self$`alpha` + )}, + if (!is.null(self$`transactioncost`)) { + sprintf( + '"transactioncost": + "%s" + ', + self$`transactioncost` + )}, + if (!is.null(self$`tax`)) { + sprintf( + '"tax": + "%s" + ', + self$`tax` + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(OptimizerStrategyOverridesJson) { + OptimizerStrategyOverridesObject <- jsonlite::fromJSON(OptimizerStrategyOverridesJson) + self$`objective` <- OptimizerStrategyOverridesObject$`objective` + self$`constraints` <- ApiClient$new()$deserializeObj(OptimizerStrategyOverridesObject$`constraints`, "map(character)", loadNamespace("factset.analyticsapi.engines")) + self$`alpha` <- OptimizerStrategyOverridesObject$`alpha` + self$`transactioncost` <- OptimizerStrategyOverridesObject$`transactioncost` + self$`tax` <- OptimizerStrategyOverridesObject$`tax` + self + } + ) +) diff --git a/auto-generated-sdk/R/optimizer_trades_list.R b/auto-generated-sdk/R/optimizer_trades_list.R new file mode 100644 index 0000000..879ca20 --- /dev/null +++ b/auto-generated-sdk/R/optimizer_trades_list.R @@ -0,0 +1,85 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title OptimizerTradesList +#' @description OptimizerTradesList Class +#' @format An \code{R6Class} generator object +#' @field identifiertype character [optional] +#' +#' @field includecash character [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +OptimizerTradesList <- R6::R6Class( + 'OptimizerTradesList', + public = list( + `identifiertype` = NULL, + `includecash` = NULL, + initialize = function(`identifiertype`=NULL, `includecash`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`identifiertype`)) { + stopifnot(is.character(`identifiertype`), length(`identifiertype`) == 1) + self$`identifiertype` <- `identifiertype` + } + if (!is.null(`includecash`)) { + self$`includecash` <- `includecash` + } + }, + toJSON = function() { + OptimizerTradesListObject <- list() + if (!is.null(self$`identifiertype`)) { + OptimizerTradesListObject[['identifiertype']] <- + self$`identifiertype` + } + if (!is.null(self$`includecash`)) { + OptimizerTradesListObject[['includecash']] <- + self$`includecash` + } + + OptimizerTradesListObject + }, + fromJSON = function(OptimizerTradesListJson) { + OptimizerTradesListObject <- jsonlite::fromJSON(OptimizerTradesListJson) + if (!is.null(OptimizerTradesListObject$`identifiertype`)) { + self$`identifiertype` <- OptimizerTradesListObject$`identifiertype` + } + if (!is.null(OptimizerTradesListObject$`includecash`)) { + self$`includecash` <- OptimizerTradesListObject$`includecash` + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`identifiertype`)) { + sprintf( + '"identifiertype": + "%s" + ', + self$`identifiertype` + )}, + if (!is.null(self$`includecash`)) { + sprintf( + '"includecash": + "%s" + ', + self$`includecash` + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(OptimizerTradesListJson) { + OptimizerTradesListObject <- jsonlite::fromJSON(OptimizerTradesListJson) + self$`identifiertype` <- OptimizerTradesListObject$`identifiertype` + self$`includecash` <- OptimizerTradesListObject$`includecash` + self + } + ) +) diff --git a/auto-generated-sdk/R/pa_calculation_column.R b/auto-generated-sdk/R/pa_calculation_column.R index 959cb0e..c53c9be 100644 --- a/auto-generated-sdk/R/pa_calculation_column.R +++ b/auto-generated-sdk/R/pa_calculation_column.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/pa_calculation_group.R b/auto-generated-sdk/R/pa_calculation_group.R index 82f355c..d14304a 100644 --- a/auto-generated-sdk/R/pa_calculation_group.R +++ b/auto-generated-sdk/R/pa_calculation_group.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/pa_calculation_parameters.R b/auto-generated-sdk/R/pa_calculation_parameters.R index 1d3860a..ab69545 100644 --- a/auto-generated-sdk/R/pa_calculation_parameters.R +++ b/auto-generated-sdk/R/pa_calculation_parameters.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech @@ -24,6 +24,8 @@ #' #' @field columns list( \link{PACalculationColumn} ) [optional] #' +#' @field componentdetail character [optional] +#' #' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON @@ -38,7 +40,8 @@ PACalculationParameters <- R6::R6Class( `groups` = NULL, `currencyisocode` = NULL, `columns` = NULL, - initialize = function(`componentid`, `accounts`=NULL, `benchmarks`=NULL, `dates`=NULL, `groups`=NULL, `currencyisocode`=NULL, `columns`=NULL, ...){ + `componentdetail` = NULL, + initialize = function(`componentid`, `accounts`=NULL, `benchmarks`=NULL, `dates`=NULL, `groups`=NULL, `currencyisocode`=NULL, `columns`=NULL, `componentdetail`=NULL, ...){ local.optional.var <- list(...) if (!missing(`componentid`)) { stopifnot(is.character(`componentid`), length(`componentid`) == 1) @@ -72,6 +75,10 @@ PACalculationParameters <- R6::R6Class( sapply(`columns`, function(x) stopifnot(R6::is.R6(x))) self$`columns` <- `columns` } + if (!is.null(`componentdetail`)) { + stopifnot(is.character(`componentdetail`), length(`componentdetail`) == 1) + self$`componentdetail` <- `componentdetail` + } }, toJSON = function() { PACalculationParametersObject <- list() @@ -103,6 +110,10 @@ PACalculationParameters <- R6::R6Class( PACalculationParametersObject[['columns']] <- lapply(self$`columns`, function(x) x$toJSON()) } + if (!is.null(self$`componentdetail`)) { + PACalculationParametersObject[['componentdetail']] <- + self$`componentdetail` + } PACalculationParametersObject }, @@ -131,6 +142,9 @@ PACalculationParameters <- R6::R6Class( if (!is.null(PACalculationParametersObject$`columns`)) { self$`columns` <- ApiClient$new()$deserializeObj(PACalculationParametersObject$`columns`, "array[PACalculationColumn]", loadNamespace("factset.analyticsapi.engines")) } + if (!is.null(PACalculationParametersObject$`componentdetail`)) { + self$`componentdetail` <- PACalculationParametersObject$`componentdetail` + } }, toJSONString = function() { jsoncontent <- c( @@ -182,6 +196,13 @@ PACalculationParameters <- R6::R6Class( [%s] ', paste(sapply(self$`columns`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") + )}, + if (!is.null(self$`componentdetail`)) { + sprintf( + '"componentdetail": + "%s" + ', + self$`componentdetail` )} ) jsoncontent <- paste(jsoncontent, collapse = ",") @@ -196,6 +217,7 @@ PACalculationParameters <- R6::R6Class( self$`groups` <- ApiClient$new()$deserializeObj(PACalculationParametersObject$`groups`, "array[PACalculationGroup]", loadNamespace("factset.analyticsapi.engines")) self$`currencyisocode` <- PACalculationParametersObject$`currencyisocode` self$`columns` <- ApiClient$new()$deserializeObj(PACalculationParametersObject$`columns`, "array[PACalculationColumn]", loadNamespace("factset.analyticsapi.engines")) + self$`componentdetail` <- PACalculationParametersObject$`componentdetail` self } ) diff --git a/auto-generated-sdk/R/pa_calculations_api.R b/auto-generated-sdk/R/pa_calculations_api.R new file mode 100644 index 0000000..86395b8 --- /dev/null +++ b/auto-generated-sdk/R/pa_calculations_api.R @@ -0,0 +1,639 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title PACalculations operations +#' @description factset.analyticsapi.engines.PACalculations +#' @format An \code{R6Class} generator object +#' @field apiClient Handles the client-server communication. +#' +#' @section Methods: +#' \describe{ +#' \strong{ CancelPACalculationById } \emph{ Cancel PA calculation by id } +#' This is the endpoint to cancel a previously submitted calculation. Instead of doing a GET on the polling URL, cancel the request by doing a DELETE. +#' +#' \itemize{ +#' \item \emph{ @param } id character +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 204 | Expected response, calculation was canceled successfully. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid identifier provided. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | There was no request for the calculation identifier provided, or the request was already canceled for the provided identifier. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in sometime. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' \strong{ GetPACalculationById } \emph{ Get PA calculation by id } +#' This is the endpoint to check on the progress of a previously requested calculation. If the calculation has finished computing, the body of the response will contain the requested document in JSON. Otherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. +#' +#' \itemize{ +#' \item \emph{ @param } id character +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 200 | Expected response once calculation is completed, returns JSON in the format specified in the Run Calculations endpoint. +#' +#' \item return type : object +#' \item response headers : +#' +#' \tabular{ll}{ +#' Content-Encoding \tab Standard HTTP header. Header value based on Accept-Encoding Request header. \cr +#' Content-Type \tab Standard HTTP header. \cr +#' Transfer-Encoding \tab Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 202 | Expected response returned if the calculation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-FactSet-Api-PickUp-Progress \tab FactSet's progress header. \cr +#' Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid identifier provided. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in sometime. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' \strong{ RunPACalculation } \emph{ Run PA Calculation } +#' This endpoint runs the PA calculation specified in the POST body parameters. It must be used first before polling or cancelling endpoints. A successful response will contain the URL to poll for the result of the calculation. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. +#' +#' \itemize{ +#' \item \emph{ @param } x.factset.content.organization character +#' \item \emph{ @param } x.factset.content.type character +#' \item \emph{ @param } pa.calculation.parameters \link{PACalculationParameters} +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 202 | Expected response, contains the poll URL in the Location header. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' Location \tab URL to poll for the resulting calculation \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 201 | Expected response if calculation is completed within 30 seconds, returns JSON in the format specified in the Run Calculations endpoint. +#' +#' \item return type : object +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid POST body. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | One or more calculation settings were unavailable. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 415 | Missing/Invalid Content-Type header. Header needs to be set to application/json. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in sometime. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' } +#' +#' +#' @examples +#' \dontrun{ +#' #################### CancelPACalculationById #################### +#' +#' library(factset.analyticsapi.engines) +#' var.id <- 'id_example' # character | from url, provided from the location header in the Run Calculation endpoint +#' +#' #Cancel PA calculation by id +#' api.instance <- PACalculationsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$CancelPACalculationById(var.id), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' #################### GetPACalculationById #################### +#' +#' library(factset.analyticsapi.engines) +#' var.id <- 'id_example' # character | from url, provided from the location header in the Run Calculation endpoint +#' +#' #Get PA calculation by id +#' api.instance <- PACalculationsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$GetPACalculationById(var.id), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # deserialized response object +#' response.object <- result$content +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' #################### RunPACalculation #################### +#' +#' library(factset.analyticsapi.engines) +#' var.x.factset.content.organization <- 'x.factset.content.organization_example' # character | For specifying the format of the calculation result. Accepted values are \"column\" or \"row\" or \"simplifiedrow\" +#' var.x.factset.content.type <- 'x.factset.content.type_example' # character | For specifying the content type of the calculation result. Accepted values are either \"application/json\" or \"application/x-protobuf\" +#' var.pa.calculation.parameters <- PACalculationParameters$new() # PACalculationParameters | +#' +#' #Run PA Calculation +#' api.instance <- PACalculationsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$RunPACalculation(x.factset.content.organization=var.x.factset.content.organization, x.factset.content.type=var.x.factset.content.type, pa.calculation.parameters=var.pa.calculation.parameters), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # deserialized response object +#' response.object <- result$content +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' } +#' @importFrom R6 R6Class +#' @importFrom base64enc base64encode +#' @importFrom rlang abort +#' @export +PACalculationsApi <- R6::R6Class( + 'PACalculationsApi', + public = list( + apiClient = NULL, + initialize = function(apiClient){ + if (!missing(apiClient)) { + self$apiClient <- apiClient + } + else { + self$apiClient <- ApiClient$new() + } + }, + CancelPACalculationById = function(id, ...){ + apiResponse <- self$CancelPACalculationByIdWithHttpInfo(id, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + CancelPACalculationByIdWithHttpInfo = function(id, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`id`)) { + rlang::abort(message = "Missing required parameter `id`.", .subclass = "ApiException", ApiException = ApiException$new(status = 0, reason = "Missing required parameter `id`.")) + } + + urlPath <- "/analytics/engines/pa/v2/calculations/{id}" + if (!missing(`id`)) { + urlPath <- gsub(paste0("\\{", "id", "\\}"), URLencode(as.character(`id`), reserved = TRUE), urlPath) + } + + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "DELETE", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + ApiResponse$new(NULL, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + }, + GetPACalculationById = function(id, ...){ + apiResponse <- self$GetPACalculationByIdWithHttpInfo(id, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + GetPACalculationByIdWithHttpInfo = function(id, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`id`)) { + rlang::abort(message = "Missing required parameter `id`.", .subclass = "ApiException", ApiException = ApiException$new(status = 0, reason = "Missing required parameter `id`.")) + } + + urlPath <- "/analytics/engines/pa/v2/calculations/{id}" + if (!missing(`id`)) { + urlPath <- gsub(paste0("\\{", "id", "\\}"), URLencode(as.character(`id`), reserved = TRUE), urlPath) + } + + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "object", loadNamespace("factset.analyticsapi.engines")), + error = function(e){ + rlang::abort(message = "Failed to deserialize response", .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + }, + RunPACalculation = function(x.factset.content.organization=NULL, x.factset.content.type=NULL, pa.calculation.parameters=NULL, ...){ + apiResponse <- self$RunPACalculationWithHttpInfo(x.factset.content.organization, x.factset.content.type, pa.calculation.parameters, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + RunPACalculationWithHttpInfo = function(x.factset.content.organization=NULL, x.factset.content.type=NULL, pa.calculation.parameters=NULL, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + headerParams['x-factset-content-organization'] <- `x.factset.content.organization` + + headerParams['x-factset-content-type'] <- `x.factset.content.type` + + if (!missing(`pa.calculation.parameters`)) { + body <- `pa.calculation.parameters`$toJSONString() + } else { + body <- NULL + } + + urlPath <- "/analytics/engines/pa/v2/calculations" + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "POST", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "object", loadNamespace("factset.analyticsapi.engines")), + error = function(e){ + rlang::abort(message = "Failed to deserialize response", .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + } + ) +) diff --git a/auto-generated-sdk/R/pa_component.R b/auto-generated-sdk/R/pa_component.R index 7482456..82f9352 100644 --- a/auto-generated-sdk/R/pa_component.R +++ b/auto-generated-sdk/R/pa_component.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/pa_date_parameters.R b/auto-generated-sdk/R/pa_date_parameters.R index 6bac56e..5ca133a 100644 --- a/auto-generated-sdk/R/pa_date_parameters.R +++ b/auto-generated-sdk/R/pa_date_parameters.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/pa_identifier.R b/auto-generated-sdk/R/pa_identifier.R index 41808b0..176662a 100644 --- a/auto-generated-sdk/R/pa_identifier.R +++ b/auto-generated-sdk/R/pa_identifier.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/pub_calculation_parameters.R b/auto-generated-sdk/R/pub_calculation_parameters.R new file mode 100644 index 0000000..bc27e86 --- /dev/null +++ b/auto-generated-sdk/R/pub_calculation_parameters.R @@ -0,0 +1,112 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title PubCalculationParameters +#' @description PubCalculationParameters Class +#' @format An \code{R6Class} generator object +#' @field document character +#' +#' @field account \link{PubIdentifier} +#' +#' @field dates \link{PubDateParameters} +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +PubCalculationParameters <- R6::R6Class( + 'PubCalculationParameters', + public = list( + `document` = NULL, + `account` = NULL, + `dates` = NULL, + initialize = function(`document`, `account`, `dates`, ...){ + local.optional.var <- list(...) + if (!missing(`document`)) { + stopifnot(is.character(`document`), length(`document`) == 1) + self$`document` <- `document` + } + if (!missing(`account`)) { + stopifnot(R6::is.R6(`account`)) + self$`account` <- `account` + } + if (!missing(`dates`)) { + stopifnot(R6::is.R6(`dates`)) + self$`dates` <- `dates` + } + }, + toJSON = function() { + PubCalculationParametersObject <- list() + if (!is.null(self$`document`)) { + PubCalculationParametersObject[['document']] <- + self$`document` + } + if (!is.null(self$`account`)) { + PubCalculationParametersObject[['account']] <- + self$`account`$toJSON() + } + if (!is.null(self$`dates`)) { + PubCalculationParametersObject[['dates']] <- + self$`dates`$toJSON() + } + + PubCalculationParametersObject + }, + fromJSON = function(PubCalculationParametersJson) { + PubCalculationParametersObject <- jsonlite::fromJSON(PubCalculationParametersJson) + if (!is.null(PubCalculationParametersObject$`document`)) { + self$`document` <- PubCalculationParametersObject$`document` + } + if (!is.null(PubCalculationParametersObject$`account`)) { + accountObject <- PubIdentifier$new() + accountObject$fromJSON(jsonlite::toJSON(PubCalculationParametersObject$account, auto_unbox = TRUE, digits = NA)) + self$`account` <- accountObject + } + if (!is.null(PubCalculationParametersObject$`dates`)) { + datesObject <- PubDateParameters$new() + datesObject$fromJSON(jsonlite::toJSON(PubCalculationParametersObject$dates, auto_unbox = TRUE, digits = NA)) + self$`dates` <- datesObject + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`document`)) { + sprintf( + '"document": + "%s" + ', + self$`document` + )}, + if (!is.null(self$`account`)) { + sprintf( + '"account": + %s + ', + jsonlite::toJSON(self$`account`$toJSON(), auto_unbox=TRUE, digits = NA) + )}, + if (!is.null(self$`dates`)) { + sprintf( + '"dates": + %s + ', + jsonlite::toJSON(self$`dates`$toJSON(), auto_unbox=TRUE, digits = NA) + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(PubCalculationParametersJson) { + PubCalculationParametersObject <- jsonlite::fromJSON(PubCalculationParametersJson) + self$`document` <- PubCalculationParametersObject$`document` + self$`account` <- PubIdentifier$new()$fromJSON(jsonlite::toJSON(PubCalculationParametersObject$account, auto_unbox = TRUE, digits = NA)) + self$`dates` <- PubDateParameters$new()$fromJSON(jsonlite::toJSON(PubCalculationParametersObject$dates, auto_unbox = TRUE, digits = NA)) + self + } + ) +) diff --git a/auto-generated-sdk/R/pub_date_parameters.R b/auto-generated-sdk/R/pub_date_parameters.R new file mode 100644 index 0000000..a18d0d0 --- /dev/null +++ b/auto-generated-sdk/R/pub_date_parameters.R @@ -0,0 +1,86 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title PubDateParameters +#' @description PubDateParameters Class +#' @format An \code{R6Class} generator object +#' @field startdate character [optional] +#' +#' @field enddate character +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +PubDateParameters <- R6::R6Class( + 'PubDateParameters', + public = list( + `startdate` = NULL, + `enddate` = NULL, + initialize = function(`enddate`, `startdate`=NULL, ...){ + local.optional.var <- list(...) + if (!missing(`enddate`)) { + stopifnot(is.character(`enddate`), length(`enddate`) == 1) + self$`enddate` <- `enddate` + } + if (!is.null(`startdate`)) { + stopifnot(is.character(`startdate`), length(`startdate`) == 1) + self$`startdate` <- `startdate` + } + }, + toJSON = function() { + PubDateParametersObject <- list() + if (!is.null(self$`startdate`)) { + PubDateParametersObject[['startdate']] <- + self$`startdate` + } + if (!is.null(self$`enddate`)) { + PubDateParametersObject[['enddate']] <- + self$`enddate` + } + + PubDateParametersObject + }, + fromJSON = function(PubDateParametersJson) { + PubDateParametersObject <- jsonlite::fromJSON(PubDateParametersJson) + if (!is.null(PubDateParametersObject$`startdate`)) { + self$`startdate` <- PubDateParametersObject$`startdate` + } + if (!is.null(PubDateParametersObject$`enddate`)) { + self$`enddate` <- PubDateParametersObject$`enddate` + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`startdate`)) { + sprintf( + '"startdate": + "%s" + ', + self$`startdate` + )}, + if (!is.null(self$`enddate`)) { + sprintf( + '"enddate": + "%s" + ', + self$`enddate` + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(PubDateParametersJson) { + PubDateParametersObject <- jsonlite::fromJSON(PubDateParametersJson) + self$`startdate` <- PubDateParametersObject$`startdate` + self$`enddate` <- PubDateParametersObject$`enddate` + self + } + ) +) diff --git a/auto-generated-sdk/R/pub_identifier.R b/auto-generated-sdk/R/pub_identifier.R new file mode 100644 index 0000000..05bee2f --- /dev/null +++ b/auto-generated-sdk/R/pub_identifier.R @@ -0,0 +1,86 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title PubIdentifier +#' @description PubIdentifier Class +#' @format An \code{R6Class} generator object +#' @field id character +#' +#' @field holdingsmode character [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +PubIdentifier <- R6::R6Class( + 'PubIdentifier', + public = list( + `id` = NULL, + `holdingsmode` = NULL, + initialize = function(`id`, `holdingsmode`=NULL, ...){ + local.optional.var <- list(...) + if (!missing(`id`)) { + stopifnot(is.character(`id`), length(`id`) == 1) + self$`id` <- `id` + } + if (!is.null(`holdingsmode`)) { + stopifnot(is.character(`holdingsmode`), length(`holdingsmode`) == 1) + self$`holdingsmode` <- `holdingsmode` + } + }, + toJSON = function() { + PubIdentifierObject <- list() + if (!is.null(self$`id`)) { + PubIdentifierObject[['id']] <- + self$`id` + } + if (!is.null(self$`holdingsmode`)) { + PubIdentifierObject[['holdingsmode']] <- + self$`holdingsmode` + } + + PubIdentifierObject + }, + fromJSON = function(PubIdentifierJson) { + PubIdentifierObject <- jsonlite::fromJSON(PubIdentifierJson) + if (!is.null(PubIdentifierObject$`id`)) { + self$`id` <- PubIdentifierObject$`id` + } + if (!is.null(PubIdentifierObject$`holdingsmode`)) { + self$`holdingsmode` <- PubIdentifierObject$`holdingsmode` + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`id`)) { + sprintf( + '"id": + "%s" + ', + self$`id` + )}, + if (!is.null(self$`holdingsmode`)) { + sprintf( + '"holdingsmode": + "%s" + ', + self$`holdingsmode` + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(PubIdentifierJson) { + PubIdentifierObject <- jsonlite::fromJSON(PubIdentifierJson) + self$`id` <- PubIdentifierObject$`id` + self$`holdingsmode` <- PubIdentifierObject$`holdingsmode` + self + } + ) +) diff --git a/auto-generated-sdk/R/spar_benchmark.R b/auto-generated-sdk/R/spar_benchmark.R new file mode 100644 index 0000000..1cb5187 --- /dev/null +++ b/auto-generated-sdk/R/spar_benchmark.R @@ -0,0 +1,109 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title SPARBenchmark +#' @description SPARBenchmark Class +#' @format An \code{R6Class} generator object +#' @field id character [optional] +#' +#' @field name character [optional] +#' +#' @field identifiers list( \link{SPARIdentifier} ) [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +SPARBenchmark <- R6::R6Class( + 'SPARBenchmark', + public = list( + `id` = NULL, + `name` = NULL, + `identifiers` = NULL, + initialize = function(`id`=NULL, `name`=NULL, `identifiers`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`id`)) { + stopifnot(is.character(`id`), length(`id`) == 1) + self$`id` <- `id` + } + if (!is.null(`name`)) { + stopifnot(is.character(`name`), length(`name`) == 1) + self$`name` <- `name` + } + if (!is.null(`identifiers`)) { + stopifnot(is.vector(`identifiers`), length(`identifiers`) != 0) + sapply(`identifiers`, function(x) stopifnot(R6::is.R6(x))) + self$`identifiers` <- `identifiers` + } + }, + toJSON = function() { + SPARBenchmarkObject <- list() + if (!is.null(self$`id`)) { + SPARBenchmarkObject[['id']] <- + self$`id` + } + if (!is.null(self$`name`)) { + SPARBenchmarkObject[['name']] <- + self$`name` + } + if (!is.null(self$`identifiers`)) { + SPARBenchmarkObject[['identifiers']] <- + lapply(self$`identifiers`, function(x) x$toJSON()) + } + + SPARBenchmarkObject + }, + fromJSON = function(SPARBenchmarkJson) { + SPARBenchmarkObject <- jsonlite::fromJSON(SPARBenchmarkJson) + if (!is.null(SPARBenchmarkObject$`id`)) { + self$`id` <- SPARBenchmarkObject$`id` + } + if (!is.null(SPARBenchmarkObject$`name`)) { + self$`name` <- SPARBenchmarkObject$`name` + } + if (!is.null(SPARBenchmarkObject$`identifiers`)) { + self$`identifiers` <- ApiClient$new()$deserializeObj(SPARBenchmarkObject$`identifiers`, "array[SPARIdentifier]", loadNamespace("factset.analyticsapi.engines")) + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`id`)) { + sprintf( + '"id": + "%s" + ', + self$`id` + )}, + if (!is.null(self$`name`)) { + sprintf( + '"name": + "%s" + ', + self$`name` + )}, + if (!is.null(self$`identifiers`)) { + sprintf( + '"identifiers": + [%s] +', + paste(sapply(self$`identifiers`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(SPARBenchmarkJson) { + SPARBenchmarkObject <- jsonlite::fromJSON(SPARBenchmarkJson) + self$`id` <- SPARBenchmarkObject$`id` + self$`name` <- SPARBenchmarkObject$`name` + self$`identifiers` <- ApiClient$new()$deserializeObj(SPARBenchmarkObject$`identifiers`, "array[SPARIdentifier]", loadNamespace("factset.analyticsapi.engines")) + self + } + ) +) diff --git a/auto-generated-sdk/R/spar_benchmark_api.R b/auto-generated-sdk/R/spar_benchmark_api.R new file mode 100644 index 0000000..894e987 --- /dev/null +++ b/auto-generated-sdk/R/spar_benchmark_api.R @@ -0,0 +1,243 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title SPARBenchmark operations +#' @description factset.analyticsapi.engines.SPARBenchmark +#' @format An \code{R6Class} generator object +#' @field apiClient Handles the client-server communication. +#' +#' @section Methods: +#' \describe{ +#' \strong{ GetSPARBenchmarkById } \emph{ Get SPAR benchmark details } +#' This endpoint returns the details of a given SPAR benchmark identifier. +#' +#' \itemize{ +#' \item \emph{ @param } id character +#' \item \emph{ @returnType } \link{SPARBenchmark} \cr +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 200 | Expected response, returns the list of prefix and return types for the benchmark. +#' +#' \item return type : SPARBenchmark +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid benchmark identifier. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | Benchmark identifier not found. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in sometime. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' } +#' +#' +#' @examples +#' \dontrun{ +#' #################### GetSPARBenchmarkById #################### +#' +#' library(factset.analyticsapi.engines) +#' var.id <- 'id_example' # character | Benchmark Identifier +#' +#' #Get SPAR benchmark details +#' api.instance <- SPARBenchmarkApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$GetSPARBenchmarkById(var.id), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # deserialized response object +#' response.object <- result$content +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' } +#' @importFrom R6 R6Class +#' @importFrom base64enc base64encode +#' @importFrom rlang abort +#' @export +SPARBenchmarkApi <- R6::R6Class( + 'SPARBenchmarkApi', + public = list( + apiClient = NULL, + initialize = function(apiClient){ + if (!missing(apiClient)) { + self$apiClient <- apiClient + } + else { + self$apiClient <- ApiClient$new() + } + }, + GetSPARBenchmarkById = function(id, ...){ + apiResponse <- self$GetSPARBenchmarkByIdWithHttpInfo(id, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + GetSPARBenchmarkByIdWithHttpInfo = function(id, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`id`)) { + rlang::abort(message = "Missing required parameter `id`.", .subclass = "ApiException", ApiException = ApiException$new(status = 0, reason = "Missing required parameter `id`.")) + } + + queryParams['id'] <- id + + urlPath <- "/analytics/lookups/v2/engines/spar/benchmarks" + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "SPARBenchmark", loadNamespace("factset.analyticsapi.engines")), + error = function(e){ + rlang::abort(message = "Failed to deserialize response", .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + } + ) +) diff --git a/auto-generated-sdk/R/spar_calculation_parameters.R b/auto-generated-sdk/R/spar_calculation_parameters.R index b8ba7e6..d2ba0ba 100644 --- a/auto-generated-sdk/R/spar_calculation_parameters.R +++ b/auto-generated-sdk/R/spar_calculation_parameters.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/spar_calculations_api.R b/auto-generated-sdk/R/spar_calculations_api.R new file mode 100644 index 0000000..1f4a356 --- /dev/null +++ b/auto-generated-sdk/R/spar_calculations_api.R @@ -0,0 +1,628 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title SPARCalculations operations +#' @description factset.analyticsapi.engines.SPARCalculations +#' @format An \code{R6Class} generator object +#' @field apiClient Handles the client-server communication. +#' +#' @section Methods: +#' \describe{ +#' \strong{ CancelSPARCalculationById } \emph{ Cancel SPAR calculation } +#' This is the endpoint to cancel a previously submitted calculation. Instead of doing a GET on the polling URL, cancel the request by doing a DELETE +#' +#' \itemize{ +#' \item \emph{ @param } id character +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 204 | Expected response, calculation was canceled successfully. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid identifier provided. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | There was no request for the calculation identifier provided, or the request was already canceled for the provided identifier. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in sometime. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' \strong{ GetSPARCalculationById } \emph{ Get SPAR calculation by id } +#' This is the endpoint to check on the progress of a previously requested calculation. If the calculation has finished computing, the body of the response will contain the requested document in JSON. +#' +#' \itemize{ +#' \item \emph{ @param } id character +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 200 | Expected response once calculation is completed, returns JSON in the format specified in the Run Calculations endpoint. +#' +#' \item return type : object +#' \item response headers : +#' +#' \tabular{ll}{ +#' Content-Encoding \tab Standard HTTP header. Header value based on Accept-Encoding Request header. \cr +#' Content-Type \tab Standard HTTP header. \cr +#' Transfer-Encoding \tab Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 202 | Expected response returned if the calculation is not yet completed. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid identifier provided. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in sometime. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' \strong{ RunSPARCalculation } \emph{ Run SPAR Calculation } +#' This endpoint runs the SPAR calculation specified in the POST body parameters. It must be used first before polling or cancelling endpoints. A successful response will contain the URL to poll for the result of the calculation. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the SPAR template. +#' +#' \itemize{ +#' \item \emph{ @param } x.factset.content.organization character +#' \item \emph{ @param } x.factset.content.type character +#' \item \emph{ @param } spar.calculation.parameters \link{SPARCalculationParameters} +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 202 | Expected response, contains the poll URL in the Location header. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' Location \tab URL to poll for the resulting calculation \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 201 | Expected response if calculation is completed within 30 seconds, returns JSON in the format specified in the Run Calculations endpoint. +#' +#' \item return type : object +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid POST body. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | One or more calculation settings were unavailable. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 415 | Missing/Invalid Content-Type header. Header needs to be set to application/json. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in sometime. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' } +#' +#' +#' @examples +#' \dontrun{ +#' #################### CancelSPARCalculationById #################### +#' +#' library(factset.analyticsapi.engines) +#' var.id <- 'id_example' # character | from url, provided from the location header in the Run Calculation endpoint +#' +#' #Cancel SPAR calculation +#' api.instance <- SPARCalculationsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$CancelSPARCalculationById(var.id), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' #################### GetSPARCalculationById #################### +#' +#' library(factset.analyticsapi.engines) +#' var.id <- 'id_example' # character | from url, provided from the location header in the Run Calculation endpoint +#' +#' #Get SPAR calculation by id +#' api.instance <- SPARCalculationsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$GetSPARCalculationById(var.id), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # deserialized response object +#' response.object <- result$content +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' #################### RunSPARCalculation #################### +#' +#' library(factset.analyticsapi.engines) +#' var.x.factset.content.organization <- 'x.factset.content.organization_example' # character | For specifying the format of the calculation result. Accepted values are \"column\" or \"row\" or \"simplifiedrow\" +#' var.x.factset.content.type <- 'x.factset.content.type_example' # character | For specifying the content type of the calculation result. Accepted values are either \"application/json\" or \"application/x-protobuf\" +#' var.spar.calculation.parameters <- SPARCalculationParameters$new() # SPARCalculationParameters | +#' +#' #Run SPAR Calculation +#' api.instance <- SPARCalculationsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$RunSPARCalculation(x.factset.content.organization=var.x.factset.content.organization, x.factset.content.type=var.x.factset.content.type, spar.calculation.parameters=var.spar.calculation.parameters), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # deserialized response object +#' response.object <- result$content +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' } +#' @importFrom R6 R6Class +#' @importFrom base64enc base64encode +#' @importFrom rlang abort +#' @export +SPARCalculationsApi <- R6::R6Class( + 'SPARCalculationsApi', + public = list( + apiClient = NULL, + initialize = function(apiClient){ + if (!missing(apiClient)) { + self$apiClient <- apiClient + } + else { + self$apiClient <- ApiClient$new() + } + }, + CancelSPARCalculationById = function(id, ...){ + apiResponse <- self$CancelSPARCalculationByIdWithHttpInfo(id, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + CancelSPARCalculationByIdWithHttpInfo = function(id, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`id`)) { + rlang::abort(message = "Missing required parameter `id`.", .subclass = "ApiException", ApiException = ApiException$new(status = 0, reason = "Missing required parameter `id`.")) + } + + urlPath <- "/analytics/engines/spar/v2/calculations/{id}" + if (!missing(`id`)) { + urlPath <- gsub(paste0("\\{", "id", "\\}"), URLencode(as.character(`id`), reserved = TRUE), urlPath) + } + + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "DELETE", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + ApiResponse$new(NULL, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + }, + GetSPARCalculationById = function(id, ...){ + apiResponse <- self$GetSPARCalculationByIdWithHttpInfo(id, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + GetSPARCalculationByIdWithHttpInfo = function(id, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`id`)) { + rlang::abort(message = "Missing required parameter `id`.", .subclass = "ApiException", ApiException = ApiException$new(status = 0, reason = "Missing required parameter `id`.")) + } + + urlPath <- "/analytics/engines/spar/v2/calculations/{id}" + if (!missing(`id`)) { + urlPath <- gsub(paste0("\\{", "id", "\\}"), URLencode(as.character(`id`), reserved = TRUE), urlPath) + } + + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "object", loadNamespace("factset.analyticsapi.engines")), + error = function(e){ + rlang::abort(message = "Failed to deserialize response", .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + }, + RunSPARCalculation = function(x.factset.content.organization=NULL, x.factset.content.type=NULL, spar.calculation.parameters=NULL, ...){ + apiResponse <- self$RunSPARCalculationWithHttpInfo(x.factset.content.organization, x.factset.content.type, spar.calculation.parameters, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + RunSPARCalculationWithHttpInfo = function(x.factset.content.organization=NULL, x.factset.content.type=NULL, spar.calculation.parameters=NULL, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + headerParams['x-factset-content-organization'] <- `x.factset.content.organization` + + headerParams['x-factset-content-type'] <- `x.factset.content.type` + + if (!missing(`spar.calculation.parameters`)) { + body <- `spar.calculation.parameters`$toJSONString() + } else { + body <- NULL + } + + urlPath <- "/analytics/engines/spar/v2/calculations" + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "POST", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "object", loadNamespace("factset.analyticsapi.engines")), + error = function(e){ + rlang::abort(message = "Failed to deserialize response", .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + } + ) +) diff --git a/auto-generated-sdk/R/spar_date_parameters.R b/auto-generated-sdk/R/spar_date_parameters.R index 7797ebf..9503a68 100644 --- a/auto-generated-sdk/R/spar_date_parameters.R +++ b/auto-generated-sdk/R/spar_date_parameters.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/spar_identifier.R b/auto-generated-sdk/R/spar_identifier.R index 056a5d4..db022e3 100644 --- a/auto-generated-sdk/R/spar_identifier.R +++ b/auto-generated-sdk/R/spar_identifier.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/stach_extensions.R b/auto-generated-sdk/R/stach_extensions.R index 5df19fe..0bb5ef1 100644 --- a/auto-generated-sdk/R/stach_extensions.R +++ b/auto-generated-sdk/R/stach_extensions.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech @@ -22,7 +22,6 @@ library(factset.protobuf.stach) #' } #' } #' -#' #' @importFrom R6 R6Class #' @export diff --git a/auto-generated-sdk/R/strategy_documents_api.R b/auto-generated-sdk/R/strategy_documents_api.R new file mode 100644 index 0000000..fd75e0c --- /dev/null +++ b/auto-generated-sdk/R/strategy_documents_api.R @@ -0,0 +1,1065 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title StrategyDocuments operations +#' @description factset.analyticsapi.engines.StrategyDocuments +#' @format An \code{R6Class} generator object +#' @field apiClient Handles the client-server communication. +#' +#' @section Methods: +#' \describe{ +#' \strong{ GetAxiomaEquityStrategyDocuments } \emph{ Get Axioma Equity strategy documents and sub-directories in a directory } +#' This endpoint looks up all Axioma Equity strategy documents and sub-directories in a given directory. +#' +#' \itemize{ +#' \item \emph{ @param } path character +#' \item \emph{ @returnType } \link{DocumentDirectories} \cr +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 200 | Expected response, returns a list of Axioma Equity strategy documents and directories +#' +#' \item return type : DocumentDirectories +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid query parameter or value provided +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | Path not found +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in some time +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' \strong{ GetAxiomaFIStrategyDocuments } \emph{ Get Axioma FI strategy documents and sub-directories in a directory } +#' This endpoint looks up all Axioma FI strategy documents and sub-directories in a given directory. +#' +#' \itemize{ +#' \item \emph{ @param } path character +#' \item \emph{ @returnType } \link{DocumentDirectories} \cr +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 200 | Expected response, returns a list of Axioma FI strategy documents and directories +#' +#' \item return type : DocumentDirectories +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid query parameter or value provided +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | Path not found +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in some time +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' \strong{ GetBarraStrategyDocuments } \emph{ Get Barra strategy documents and sub-directories in a directory } +#' This endpoint looks up all Barra strategy documents and sub-directories in a given directory. +#' +#' \itemize{ +#' \item \emph{ @param } path character +#' \item \emph{ @returnType } \link{DocumentDirectories} \cr +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 200 | Expected response, returns a list of Barra strategy documents and directories +#' +#' \item return type : DocumentDirectories +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid query parameter or value provided +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | Path not found +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in some time +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' \strong{ GetFPOStrategyDocuments } \emph{ Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory } +#' This endpoint looks up all FactSet Portfolio Optimizer strategy documents and sub-directories in a given directory. +#' +#' \itemize{ +#' \item \emph{ @param } path character +#' \item \emph{ @returnType } \link{DocumentDirectories} \cr +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 200 | Expected response, returns a list of FactSet Portfolio Optimizer strategy documents and directories +#' +#' \item return type : DocumentDirectories +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid query parameter or value provided +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | Path not found +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in some time +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' \strong{ GetNorthfieldStrategyDocuments } \emph{ Get Northfield strategy documents and sub-directories in a directory } +#' This endpoint looks up all Northfield strategy documents and sub-directories in a given directory. +#' +#' \itemize{ +#' \item \emph{ @param } path character +#' \item \emph{ @returnType } \link{DocumentDirectories} \cr +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 200 | Expected response, returns a list of Northfield strategy documents and directories +#' +#' \item return type : DocumentDirectories +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid query parameter or value provided +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | Path not found +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in some time +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' } +#' +#' +#' @examples +#' \dontrun{ +#' #################### GetAxiomaEquityStrategyDocuments #################### +#' +#' library(factset.analyticsapi.engines) +#' var.path <- '' # character | The directory to get the strategy documents and sub-directories in +#' +#' #Get Axioma Equity strategy documents and sub-directories in a directory +#' api.instance <- StrategyDocumentsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$GetAxiomaEquityStrategyDocuments(var.path), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # deserialized response object +#' response.object <- result$content +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' #################### GetAxiomaFIStrategyDocuments #################### +#' +#' library(factset.analyticsapi.engines) +#' var.path <- '' # character | The directory to get the strategy documents and sub-directories in +#' +#' #Get Axioma FI strategy documents and sub-directories in a directory +#' api.instance <- StrategyDocumentsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$GetAxiomaFIStrategyDocuments(var.path), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # deserialized response object +#' response.object <- result$content +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' #################### GetBarraStrategyDocuments #################### +#' +#' library(factset.analyticsapi.engines) +#' var.path <- '' # character | The directory to get the strategy documents and sub-directories in +#' +#' #Get Barra strategy documents and sub-directories in a directory +#' api.instance <- StrategyDocumentsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$GetBarraStrategyDocuments(var.path), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # deserialized response object +#' response.object <- result$content +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' #################### GetFPOStrategyDocuments #################### +#' +#' library(factset.analyticsapi.engines) +#' var.path <- '' # character | The directory to get the strategy documents and sub-directories in +#' +#' #Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory +#' api.instance <- StrategyDocumentsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$GetFPOStrategyDocuments(var.path), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # deserialized response object +#' response.object <- result$content +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' #################### GetNorthfieldStrategyDocuments #################### +#' +#' library(factset.analyticsapi.engines) +#' var.path <- '' # character | The directory to get the strategy documents and sub-directories in +#' +#' #Get Northfield strategy documents and sub-directories in a directory +#' api.instance <- StrategyDocumentsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$GetNorthfieldStrategyDocuments(var.path), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # deserialized response object +#' response.object <- result$content +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' } +#' @importFrom R6 R6Class +#' @importFrom base64enc base64encode +#' @importFrom rlang abort +#' @export +StrategyDocumentsApi <- R6::R6Class( + 'StrategyDocumentsApi', + public = list( + apiClient = NULL, + initialize = function(apiClient){ + if (!missing(apiClient)) { + self$apiClient <- apiClient + } + else { + self$apiClient <- ApiClient$new() + } + }, + GetAxiomaEquityStrategyDocuments = function(path, ...){ + apiResponse <- self$GetAxiomaEquityStrategyDocumentsWithHttpInfo(path, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + GetAxiomaEquityStrategyDocumentsWithHttpInfo = function(path, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`path`)) { + rlang::abort(message = "Missing required parameter `path`.", .subclass = "ApiException", ApiException = ApiException$new(status = 0, reason = "Missing required parameter `path`.")) + } + + urlPath <- "/analytics/engines/axp/v1/strategies/{path}" + if (!missing(`path`)) { + urlPath <- gsub(paste0("\\{", "path", "\\}"), URLencode(as.character(`path`), reserved = TRUE), urlPath) + } + + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "DocumentDirectories", loadNamespace("factset.analyticsapi.engines")), + error = function(e){ + rlang::abort(message = "Failed to deserialize response", .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + }, + GetAxiomaFIStrategyDocuments = function(path, ...){ + apiResponse <- self$GetAxiomaFIStrategyDocumentsWithHttpInfo(path, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + GetAxiomaFIStrategyDocumentsWithHttpInfo = function(path, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`path`)) { + rlang::abort(message = "Missing required parameter `path`.", .subclass = "ApiException", ApiException = ApiException$new(status = 0, reason = "Missing required parameter `path`.")) + } + + urlPath <- "/analytics/engines/afi/v1/strategies/{path}" + if (!missing(`path`)) { + urlPath <- gsub(paste0("\\{", "path", "\\}"), URLencode(as.character(`path`), reserved = TRUE), urlPath) + } + + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "DocumentDirectories", loadNamespace("factset.analyticsapi.engines")), + error = function(e){ + rlang::abort(message = "Failed to deserialize response", .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + }, + GetBarraStrategyDocuments = function(path, ...){ + apiResponse <- self$GetBarraStrategyDocumentsWithHttpInfo(path, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + GetBarraStrategyDocumentsWithHttpInfo = function(path, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`path`)) { + rlang::abort(message = "Missing required parameter `path`.", .subclass = "ApiException", ApiException = ApiException$new(status = 0, reason = "Missing required parameter `path`.")) + } + + urlPath <- "/analytics/engines/bpm/v1/strategies/{path}" + if (!missing(`path`)) { + urlPath <- gsub(paste0("\\{", "path", "\\}"), URLencode(as.character(`path`), reserved = TRUE), urlPath) + } + + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "DocumentDirectories", loadNamespace("factset.analyticsapi.engines")), + error = function(e){ + rlang::abort(message = "Failed to deserialize response", .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + }, + GetFPOStrategyDocuments = function(path, ...){ + apiResponse <- self$GetFPOStrategyDocumentsWithHttpInfo(path, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + GetFPOStrategyDocumentsWithHttpInfo = function(path, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`path`)) { + rlang::abort(message = "Missing required parameter `path`.", .subclass = "ApiException", ApiException = ApiException$new(status = 0, reason = "Missing required parameter `path`.")) + } + + urlPath <- "/analytics/engines/fpo/v1/strategies/{path}" + if (!missing(`path`)) { + urlPath <- gsub(paste0("\\{", "path", "\\}"), URLencode(as.character(`path`), reserved = TRUE), urlPath) + } + + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "DocumentDirectories", loadNamespace("factset.analyticsapi.engines")), + error = function(e){ + rlang::abort(message = "Failed to deserialize response", .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + }, + GetNorthfieldStrategyDocuments = function(path, ...){ + apiResponse <- self$GetNorthfieldStrategyDocumentsWithHttpInfo(path, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + GetNorthfieldStrategyDocumentsWithHttpInfo = function(path, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`path`)) { + rlang::abort(message = "Missing required parameter `path`.", .subclass = "ApiException", ApiException = ApiException$new(status = 0, reason = "Missing required parameter `path`.")) + } + + urlPath <- "/analytics/engines/npo/v1/strategies/{path}" + if (!missing(`path`)) { + urlPath <- gsub(paste0("\\{", "path", "\\}"), URLencode(as.character(`path`), reserved = TRUE), urlPath) + } + + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "DocumentDirectories", loadNamespace("factset.analyticsapi.engines")), + error = function(e){ + rlang::abort(message = "Failed to deserialize response", .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + } + ) +) diff --git a/auto-generated-sdk/R/utility_api.R b/auto-generated-sdk/R/utility_api.R index 383d905..0ad29d9 100644 --- a/auto-generated-sdk/R/utility_api.R +++ b/auto-generated-sdk/R/utility_api.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/vault_calculation_parameters.R b/auto-generated-sdk/R/vault_calculation_parameters.R index c3c20e2..f624974 100644 --- a/auto-generated-sdk/R/vault_calculation_parameters.R +++ b/auto-generated-sdk/R/vault_calculation_parameters.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech @@ -18,6 +18,8 @@ #' #' @field configid character #' +#' @field componentdetail character [optional] +#' #' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON @@ -29,7 +31,8 @@ VaultCalculationParameters <- R6::R6Class( `account` = NULL, `dates` = NULL, `configid` = NULL, - initialize = function(`componentid`, `account`, `configid`, `dates`=NULL, ...){ + `componentdetail` = NULL, + initialize = function(`componentid`, `account`, `configid`, `dates`=NULL, `componentdetail`=NULL, ...){ local.optional.var <- list(...) if (!missing(`componentid`)) { stopifnot(is.character(`componentid`), length(`componentid`) == 1) @@ -47,6 +50,10 @@ VaultCalculationParameters <- R6::R6Class( stopifnot(R6::is.R6(`dates`)) self$`dates` <- `dates` } + if (!is.null(`componentdetail`)) { + stopifnot(is.character(`componentdetail`), length(`componentdetail`) == 1) + self$`componentdetail` <- `componentdetail` + } }, toJSON = function() { VaultCalculationParametersObject <- list() @@ -66,6 +73,10 @@ VaultCalculationParameters <- R6::R6Class( VaultCalculationParametersObject[['configid']] <- self$`configid` } + if (!is.null(self$`componentdetail`)) { + VaultCalculationParametersObject[['componentdetail']] <- + self$`componentdetail` + } VaultCalculationParametersObject }, @@ -87,6 +98,9 @@ VaultCalculationParameters <- R6::R6Class( if (!is.null(VaultCalculationParametersObject$`configid`)) { self$`configid` <- VaultCalculationParametersObject$`configid` } + if (!is.null(VaultCalculationParametersObject$`componentdetail`)) { + self$`componentdetail` <- VaultCalculationParametersObject$`componentdetail` + } }, toJSONString = function() { jsoncontent <- c( @@ -117,6 +131,13 @@ VaultCalculationParameters <- R6::R6Class( "%s" ', self$`configid` + )}, + if (!is.null(self$`componentdetail`)) { + sprintf( + '"componentdetail": + "%s" + ', + self$`componentdetail` )} ) jsoncontent <- paste(jsoncontent, collapse = ",") @@ -128,6 +149,7 @@ VaultCalculationParameters <- R6::R6Class( self$`account` <- VaultIdentifier$new()$fromJSON(jsonlite::toJSON(VaultCalculationParametersObject$account, auto_unbox = TRUE, digits = NA)) self$`dates` <- VaultDateParameters$new()$fromJSON(jsonlite::toJSON(VaultCalculationParametersObject$dates, auto_unbox = TRUE, digits = NA)) self$`configid` <- VaultCalculationParametersObject$`configid` + self$`componentdetail` <- VaultCalculationParametersObject$`componentdetail` self } ) diff --git a/auto-generated-sdk/R/vault_calculations_api.R b/auto-generated-sdk/R/vault_calculations_api.R new file mode 100644 index 0000000..9efe722 --- /dev/null +++ b/auto-generated-sdk/R/vault_calculations_api.R @@ -0,0 +1,639 @@ +# Engines API +# +# Allow clients to fetch Analytics through APIs. +# +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +# Contact: analytics.api.support@factset.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title VaultCalculations operations +#' @description factset.analyticsapi.engines.VaultCalculations +#' @format An \code{R6Class} generator object +#' @field apiClient Handles the client-server communication. +#' +#' @section Methods: +#' \describe{ +#' \strong{ CancelVaultCalculationById } \emph{ Cancel Vault calculation by id } +#' This is the endpoint to cancel a previously submitted calculation. Instead of doing a GET on the polling URL, cancel the request by doing a DELETE. +#' +#' \itemize{ +#' \item \emph{ @param } id character +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 204 | Expected response, calculation was canceled successfully. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid identifier provided. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | There was no request for the calculation identifier provided, or the request was already canceled for the provided identifier. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in sometime. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' \strong{ GetVaultCalculationById } \emph{ Get Vault calculation by id } +#' This is the endpoint to check on the progress of a previously requested calculation. If the calculation has finished computing, the body of the response will contain the requested document in JSON. +#' +#' \itemize{ +#' \item \emph{ @param } id character +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 202 | Expected response returned if the calculation is not yet completed. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 200 | Expected response once calculation is completed, returns JSON in the format specified in the Run Calculations endpoint. +#' +#' \item return type : object +#' \item response headers : +#' +#' \tabular{ll}{ +#' Content-Encoding \tab Standard HTTP header. Header value based on Accept-Encoding Request header. \cr +#' Content-Type \tab Standard HTTP header. \cr +#' Transfer-Encoding \tab Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid identifier provided. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in sometime. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' \strong{ RunVaultCalculation } \emph{ Run Vault Calculation } +#' This endpoint runs the Vault calculation specified in the POST body parameters. It must be used first before polling or cancelling endpoints. A successful response will contain the URL to poll for the result of the calculation. Remarks: * Start and and end date must be within the configuration's min and max date range +#' +#' \itemize{ +#' \item \emph{ @param } x.factset.content.organization character +#' \item \emph{ @param } x.factset.content.type character +#' \item \emph{ @param } vault.calculation.parameters \link{VaultCalculationParameters} +#' +#' \item On encountering errors, an error of subclass ApiException will be thrown. +#' +#' \item status code : 202 | Expected response, contains the poll URL in the Location header. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' Location \tab URL to poll for the resulting calculation \cr +#' Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 201 | Expected response if calculation is completed within 30 seconds, returns JSON in the format specified in the Run Calculations endpoint. +#' +#' \item return type : object +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 400 | Invalid POST body. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 401 | Missing or invalid authentication. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 403 | User is forbidden with current credentials +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 404 | One or more calculation settings were unavailable. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 415 | Missing/Invalid Content-Type header. Header needs to be set to application/json. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' } +#' \item status code : 429 | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +#' X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +#' X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +#' Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +#' } +#' \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' \item status code : 503 | Request timed out. Retry the request in sometime. +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' X-DataDirect-Request-Key \tab FactSet's request key header. \cr +#' X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +#' } +#' } +#' +#' } +#' +#' +#' @examples +#' \dontrun{ +#' #################### CancelVaultCalculationById #################### +#' +#' library(factset.analyticsapi.engines) +#' var.id <- 'id_example' # character | from url, provided from the location header in the Run Calculation endpoint +#' +#' #Cancel Vault calculation by id +#' api.instance <- VaultCalculationsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$CancelVaultCalculationById(var.id), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' #################### GetVaultCalculationById #################### +#' +#' library(factset.analyticsapi.engines) +#' var.id <- 'id_example' # character | from url, provided from the location header in the Run Calculation endpoint +#' +#' #Get Vault calculation by id +#' api.instance <- VaultCalculationsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$GetVaultCalculationById(var.id), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # deserialized response object +#' response.object <- result$content +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' #################### RunVaultCalculation #################### +#' +#' library(factset.analyticsapi.engines) +#' var.x.factset.content.organization <- 'x.factset.content.organization_example' # character | For specifying the format of the calculation result. Accepted values are \"column\" or \"row\" or \"simplifiedrow\" +#' var.x.factset.content.type <- 'x.factset.content.type_example' # character | For specifying the content type of the calculation result. Accepted values are either \"application/json\" or \"application/x-protobuf\" +#' var.vault.calculation.parameters <- VaultCalculationParameters$new() # VaultCalculationParameters | +#' +#' #Run Vault Calculation +#' api.instance <- VaultCalculationsApi$new() +#' +#' #Configure HTTP basic authorization: Basic +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#'result <- tryCatch( +#' api.instance$RunVaultCalculation(x.factset.content.organization=var.x.factset.content.organization, x.factset.content.type=var.x.factset.content.type, vault.calculation.parameters=var.vault.calculation.parameters), +#' ApiException = function(ex) ex +#' ) +#' # In case of error, print the error object +#' if(!is.null(result$ApiException)) { +#' cat(result$ApiException$toString()) +#' } else { +#' # deserialized response object +#' response.object <- result$content +#' # response headers +#' response.headers <- result$response$headers +#' # response status code +#' response.status.code <- result$response$status_code +#' } +#' +#' +#' } +#' @importFrom R6 R6Class +#' @importFrom base64enc base64encode +#' @importFrom rlang abort +#' @export +VaultCalculationsApi <- R6::R6Class( + 'VaultCalculationsApi', + public = list( + apiClient = NULL, + initialize = function(apiClient){ + if (!missing(apiClient)) { + self$apiClient <- apiClient + } + else { + self$apiClient <- ApiClient$new() + } + }, + CancelVaultCalculationById = function(id, ...){ + apiResponse <- self$CancelVaultCalculationByIdWithHttpInfo(id, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + CancelVaultCalculationByIdWithHttpInfo = function(id, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`id`)) { + rlang::abort(message = "Missing required parameter `id`.", .subclass = "ApiException", ApiException = ApiException$new(status = 0, reason = "Missing required parameter `id`.")) + } + + urlPath <- "/analytics/engines/vault/v2/calculations/{id}" + if (!missing(`id`)) { + urlPath <- gsub(paste0("\\{", "id", "\\}"), URLencode(as.character(`id`), reserved = TRUE), urlPath) + } + + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "DELETE", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + ApiResponse$new(NULL, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + }, + GetVaultCalculationById = function(id, ...){ + apiResponse <- self$GetVaultCalculationByIdWithHttpInfo(id, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + GetVaultCalculationByIdWithHttpInfo = function(id, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`id`)) { + rlang::abort(message = "Missing required parameter `id`.", .subclass = "ApiException", ApiException = ApiException$new(status = 0, reason = "Missing required parameter `id`.")) + } + + urlPath <- "/analytics/engines/vault/v2/calculations/{id}" + if (!missing(`id`)) { + urlPath <- gsub(paste0("\\{", "id", "\\}"), URLencode(as.character(`id`), reserved = TRUE), urlPath) + } + + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "object", loadNamespace("factset.analyticsapi.engines")), + error = function(e){ + rlang::abort(message = "Failed to deserialize response", .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + }, + RunVaultCalculation = function(x.factset.content.organization=NULL, x.factset.content.type=NULL, vault.calculation.parameters=NULL, ...){ + apiResponse <- self$RunVaultCalculationWithHttpInfo(x.factset.content.organization, x.factset.content.type, vault.calculation.parameters, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + RunVaultCalculationWithHttpInfo = function(x.factset.content.organization=NULL, x.factset.content.type=NULL, vault.calculation.parameters=NULL, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + headerParams['x-factset-content-organization'] <- `x.factset.content.organization` + + headerParams['x-factset-content-type'] <- `x.factset.content.type` + + if (!missing(`vault.calculation.parameters`)) { + body <- `vault.calculation.parameters`$toJSONString() + } else { + body <- NULL + } + + urlPath <- "/analytics/engines/vault/v2/calculations" + # HTTP basic auth + headerParams['Authorization'] <- paste("Basic", base64enc::base64encode(charToRaw(paste(self$apiClient$username, self$apiClient$password, sep=":")))) + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "POST", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "object", loadNamespace("factset.analyticsapi.engines")), + error = function(e){ + rlang::abort(message = "Failed to deserialize response", .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- paste("Server returned " , httr::status_code(resp) , " response status code.") + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api client exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + errorMsg <- toString(content(resp)) + if(errorMsg == ""){ + errorMsg <- "Api server exception encountered." + } + rlang::abort(message = errorMsg, .subclass = "ApiException", ApiException = ApiException$new(http_response = resp)) + } + } + ) +) diff --git a/auto-generated-sdk/R/vault_component.R b/auto-generated-sdk/R/vault_component.R index ef3f8ca..3d0498b 100644 --- a/auto-generated-sdk/R/vault_component.R +++ b/auto-generated-sdk/R/vault_component.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/vault_configuration.R b/auto-generated-sdk/R/vault_configuration.R index 3775125..27ce2e3 100644 --- a/auto-generated-sdk/R/vault_configuration.R +++ b/auto-generated-sdk/R/vault_configuration.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/vault_configuration_summary.R b/auto-generated-sdk/R/vault_configuration_summary.R index 44905a7..71fccb6 100644 --- a/auto-generated-sdk/R/vault_configuration_summary.R +++ b/auto-generated-sdk/R/vault_configuration_summary.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/vault_date_parameters.R b/auto-generated-sdk/R/vault_date_parameters.R index 98a6413..7ec22d0 100644 --- a/auto-generated-sdk/R/vault_date_parameters.R +++ b/auto-generated-sdk/R/vault_date_parameters.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/R/vault_identifier.R b/auto-generated-sdk/R/vault_identifier.R index eea2968..4782469 100644 --- a/auto-generated-sdk/R/vault_identifier.R +++ b/auto-generated-sdk/R/vault_identifier.R @@ -1,8 +1,8 @@ # Engines API # -# Allow clients to fetch Engines Analytics through APIs. +# Allow clients to fetch Analytics through APIs. # -# The version of the OpenAPI document: 2 +# The version of the OpenAPI document: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] # Contact: analytics.api.support@factset.com # Generated by: https://openapi-generator.tech diff --git a/auto-generated-sdk/README.md b/auto-generated-sdk/README.md index 8674c20..5c630ce 100644 --- a/auto-generated-sdk/README.md +++ b/auto-generated-sdk/README.md @@ -1,12 +1,12 @@ # R API client for factset.analyticsapi.engines -Allow clients to fetch Engines Analytics through APIs. +Allow clients to fetch Analytics through APIs. ## Overview This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI spec](https://openapis.org) from a remote server, you can easily generate an API client. -- API version: 2 -- Package version: 3.1.0 +- API version: v2:[pa,spar,vault,pub],v1:[fiab,fi,axp,afi,npo,bpm,fpo] +- Package version: 3.2.0 - Build package: CustomRClientCodegen For more information, please visit [https://developer.factset.com/contact](https://developer.factset.com/contact) @@ -29,8 +29,8 @@ install.packages("factset.protobuf.stach") git clone https://github.com/factset/analyticsapi-engines-r-sdk cd analyticsapi-engines-r-sdk R CMD build . -R CMD check factset.analyticsapi.engines_3.1.0.tar.gz -R CMD INSTALL factset.analyticsapi.engines_3.1.0.tar.gz +R CMD check factset.analyticsapi.engines_3.2.0.tar.gz +R CMD INSTALL factset.analyticsapi.engines_3.2.0.tar.gz ``` ### Install the package @@ -77,17 +77,43 @@ Class | Method | HTTP request | Description *DatesApi* | [**ConvertPADatesToAbsoluteFormat**](docs/DatesApi.md#ConvertPADatesToAbsoluteFormat) | **GET** /analytics/lookups/v2/engines/pa/dates | Convert PA dates to absolute format *DatesApi* | [**ConvertVaultDatesToAbsoluteFormat**](docs/DatesApi.md#ConvertVaultDatesToAbsoluteFormat) | **GET** /analytics/lookups/v2/engines/vault/dates | Convert Vault dates to absolute format *DocumentsApi* | [**GetPA3Documents**](docs/DocumentsApi.md#GetPA3Documents) | **GET** /analytics/lookups/v2/engines/pa/documents/{path} | Get PA3 documents and sub-directories in a directory +*DocumentsApi* | [**GetPubDocuments**](docs/DocumentsApi.md#GetPubDocuments) | **GET** /analytics/lookups/v2/engines/pub/documents/{path} | Gets Publisher documents and sub-directories in a directory *DocumentsApi* | [**GetSPAR3Documents**](docs/DocumentsApi.md#GetSPAR3Documents) | **GET** /analytics/lookups/v2/engines/spar/documents/{path} | Gets SPAR3 documents and sub-directories in a directory *DocumentsApi* | [**GetVaultDocuments**](docs/DocumentsApi.md#GetVaultDocuments) | **GET** /analytics/lookups/v2/engines/vault/documents/{path} | Get Vault documents and sub-directories in a directory +*FIABCalculationsApi* | [**GetFIABCalculationById**](docs/FIABCalculationsApi.md#GetFIABCalculationById) | **GET** /analytics/engines/fiab/v1/calculations/{id} | Get FIAB calculation by id +*FIABCalculationsApi* | [**GetFIABCalculationStatusSummaries**](docs/FIABCalculationsApi.md#GetFIABCalculationStatusSummaries) | **GET** /analytics/engines/fiab/v1/calculations | Get all FIAB calculation summaries +*FIABCalculationsApi* | [**RunFIABCalculation**](docs/FIABCalculationsApi.md#RunFIABCalculation) | **POST** /analytics/engines/fiab/v1/calculations | Run FIAB calculation +*FICalculationsApi* | [**CancelFICalculationById**](docs/FICalculationsApi.md#CancelFICalculationById) | **DELETE** /analytics/engines/fi/v1/calculations/{id} | Cancel FI calculation by id +*FICalculationsApi* | [**GetFICalculationById**](docs/FICalculationsApi.md#GetFICalculationById) | **GET** /analytics/engines/fi/v1/calculations/{id} | Get FI calculation by id +*FICalculationsApi* | [**RunFICalculation**](docs/FICalculationsApi.md#RunFICalculation) | **POST** /analytics/engines/fi/v1/calculations | Run FI calculation *FrequenciesApi* | [**GetPAFrequencies**](docs/FrequenciesApi.md#GetPAFrequencies) | **GET** /analytics/lookups/v2/engines/pa/frequencies | Get PA frequencies *FrequenciesApi* | [**GetSPARFrequencies**](docs/FrequenciesApi.md#GetSPARFrequencies) | **GET** /analytics/lookups/v2/engines/spar/frequencies | Get SPAR frequencies *FrequenciesApi* | [**GetVaultFrequencies**](docs/FrequenciesApi.md#GetVaultFrequencies) | **GET** /analytics/lookups/v2/engines/vault/frequencies | Get Vault frequencies *GroupsApi* | [**GetPAGroups**](docs/GroupsApi.md#GetPAGroups) | **GET** /analytics/lookups/v2/engines/pa/groups | Get PA groups +*OptimizationsApi* | [**CancelAxiomaOptimizationById**](docs/OptimizationsApi.md#CancelAxiomaOptimizationById) | **DELETE** /analytics/engines/axp/v1/optimizations/{id} | Cancel Axioma optimization by id +*OptimizationsApi* | [**GetAxiomaOptimizationById**](docs/OptimizationsApi.md#GetAxiomaOptimizationById) | **GET** /analytics/engines/axp/v1/optimizations/{id} | Get Axioma optimization by id +*OptimizationsApi* | [**RunAxiomaOptimization**](docs/OptimizationsApi.md#RunAxiomaOptimization) | **POST** /analytics/engines/axp/v1/optimizations | Run Axioma optimization +*PACalculationsApi* | [**CancelPACalculationById**](docs/PACalculationsApi.md#CancelPACalculationById) | **DELETE** /analytics/engines/pa/v2/calculations/{id} | Cancel PA calculation by id +*PACalculationsApi* | [**GetPACalculationById**](docs/PACalculationsApi.md#GetPACalculationById) | **GET** /analytics/engines/pa/v2/calculations/{id} | Get PA calculation by id +*PACalculationsApi* | [**RunPACalculation**](docs/PACalculationsApi.md#RunPACalculation) | **POST** /analytics/engines/pa/v2/calculations | Run PA Calculation +*SPARBenchmarkApi* | [**GetSPARBenchmarkById**](docs/SPARBenchmarkApi.md#GetSPARBenchmarkById) | **GET** /analytics/lookups/v2/engines/spar/benchmarks | Get SPAR benchmark details +*SPARCalculationsApi* | [**CancelSPARCalculationById**](docs/SPARCalculationsApi.md#CancelSPARCalculationById) | **DELETE** /analytics/engines/spar/v2/calculations/{id} | Cancel SPAR calculation +*SPARCalculationsApi* | [**GetSPARCalculationById**](docs/SPARCalculationsApi.md#GetSPARCalculationById) | **GET** /analytics/engines/spar/v2/calculations/{id} | Get SPAR calculation by id +*SPARCalculationsApi* | [**RunSPARCalculation**](docs/SPARCalculationsApi.md#RunSPARCalculation) | **POST** /analytics/engines/spar/v2/calculations | Run SPAR Calculation +*StrategyDocumentsApi* | [**GetAxiomaEquityStrategyDocuments**](docs/StrategyDocumentsApi.md#GetAxiomaEquityStrategyDocuments) | **GET** /analytics/engines/axp/v1/strategies/{path} | Get Axioma Equity strategy documents and sub-directories in a directory +*StrategyDocumentsApi* | [**GetAxiomaFIStrategyDocuments**](docs/StrategyDocumentsApi.md#GetAxiomaFIStrategyDocuments) | **GET** /analytics/engines/afi/v1/strategies/{path} | Get Axioma FI strategy documents and sub-directories in a directory +*StrategyDocumentsApi* | [**GetBarraStrategyDocuments**](docs/StrategyDocumentsApi.md#GetBarraStrategyDocuments) | **GET** /analytics/engines/bpm/v1/strategies/{path} | Get Barra strategy documents and sub-directories in a directory +*StrategyDocumentsApi* | [**GetFPOStrategyDocuments**](docs/StrategyDocumentsApi.md#GetFPOStrategyDocuments) | **GET** /analytics/engines/fpo/v1/strategies/{path} | Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory +*StrategyDocumentsApi* | [**GetNorthfieldStrategyDocuments**](docs/StrategyDocumentsApi.md#GetNorthfieldStrategyDocuments) | **GET** /analytics/engines/npo/v1/strategies/{path} | Get Northfield strategy documents and sub-directories in a directory +*VaultCalculationsApi* | [**CancelVaultCalculationById**](docs/VaultCalculationsApi.md#CancelVaultCalculationById) | **DELETE** /analytics/engines/vault/v2/calculations/{id} | Cancel Vault calculation by id +*VaultCalculationsApi* | [**GetVaultCalculationById**](docs/VaultCalculationsApi.md#GetVaultCalculationById) | **GET** /analytics/engines/vault/v2/calculations/{id} | Get Vault calculation by id +*VaultCalculationsApi* | [**RunVaultCalculation**](docs/VaultCalculationsApi.md#RunVaultCalculation) | **POST** /analytics/engines/vault/v2/calculations | Run Vault Calculation *UtilityApi* | [**getByUrl**](docs/UtilityApi.md#getByUrl) | **GET** {url} | Get by url ## Documentation for Models - [AccountDirectories](docs/AccountDirectories.md) + - [AxiomaEquityOptimizationParameters](docs/AxiomaEquityOptimizationParameters.md) - [Calculation](docs/Calculation.md) - [CalculationStatus](docs/CalculationStatus.md) - [CalculationStatusSummary](docs/CalculationStatusSummary.md) @@ -102,14 +128,36 @@ Class | Method | HTTP request | Description - [Currency](docs/Currency.md) - [DateParametersSummary](docs/DateParametersSummary.md) - [DocumentDirectories](docs/DocumentDirectories.md) + - [EventSummary](docs/EventSummary.md) + - [FIABCalculationParameters](docs/FIABCalculationParameters.md) + - [FIABCalculationStatus](docs/FIABCalculationStatus.md) + - [FIABCalculationStatusSummary](docs/FIABCalculationStatusSummary.md) + - [FIABDateParameters](docs/FIABDateParameters.md) + - [FIABIdentifier](docs/FIABIdentifier.md) + - [FICalculationParameters](docs/FICalculationParameters.md) + - [FIJobSettings](docs/FIJobSettings.md) + - [FISecurity](docs/FISecurity.md) - [Frequency](docs/Frequency.md) - [Group](docs/Group.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) - [PAComponent](docs/PAComponent.md) - [PADateParameters](docs/PADateParameters.md) - [PAIdentifier](docs/PAIdentifier.md) + - [PubCalculationParameters](docs/PubCalculationParameters.md) + - [PubDateParameters](docs/PubDateParameters.md) + - [PubIdentifier](docs/PubIdentifier.md) + - [SPARBenchmark](docs/SPARBenchmark.md) - [SPARCalculationParameters](docs/SPARCalculationParameters.md) - [SPARDateParameters](docs/SPARDateParameters.md) - [SPARIdentifier](docs/SPARIdentifier.md) diff --git a/auto-generated-sdk/cran-comments.md b/auto-generated-sdk/cran-comments.md deleted file mode 100644 index 77cbe4b..0000000 --- a/auto-generated-sdk/cran-comments.md +++ /dev/null @@ -1,17 +0,0 @@ -## Resubmission - -This is a resubmission. Following things were fixed as per the previous feedback. - -* Removed "R Package" from the Title. -* Improved the description of the package. -* Added web reference of API in the "Description" field. -* Replaced \donttest{} by \dontrun{}. - -## Test environments -* local Windows install - R 3.5.1 -* win-builder (devel and release) - -## R CMD check results -There were no ERRORs or WARNINGS - -There was 1 NOTE: New submission. \ No newline at end of file diff --git a/auto-generated-sdk/docs/AccountsApi.md b/auto-generated-sdk/docs/AccountsApi.md index 3de72d8..0293449 100644 --- a/auto-generated-sdk/docs/AccountsApi.md +++ b/auto-generated-sdk/docs/AccountsApi.md @@ -18,7 +18,7 @@ This endpoint looks up all ACCT and ACTM files and sub-directories in a given di ```R library(factset.analyticsapi.engines) -var.path <- 'path_example' # character | The directory to get the accounts and sub-directories in +var.path <- '' # character | The directory to get the accounts and sub-directories in #Get accounts and sub-directories in a directory api.instance <- AccountsApi$new() @@ -46,7 +46,7 @@ response.status.code <- result$response$status_code Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **path** | **character**| The directory to get the accounts and sub-directories in | + **path** | **character**| The directory to get the accounts and sub-directories in | [default to ''] ### Return type @@ -64,12 +64,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns a list of accounts and directories | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **400** | Invalid query parameter or value provided | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **404** | Path not found | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in some time | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns a list of accounts and directories | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid query parameter or value provided | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Path 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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 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.
| diff --git a/auto-generated-sdk/docs/AxiomaEquityOptimizationParameters.md b/auto-generated-sdk/docs/AxiomaEquityOptimizationParameters.md new file mode 100644 index 0000000..6538f48 --- /dev/null +++ b/auto-generated-sdk/docs/AxiomaEquityOptimizationParameters.md @@ -0,0 +1,11 @@ +# factset.analyticsapi.engines::AxiomaEquityOptimizationParameters + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**strategy** | [**OptimizerStrategy**](OptimizerStrategy.md) | | +**account** | [**OptimizerAccount**](OptimizerAccount.md) | | [optional] +**optimization** | [**Optimization**](Optimization.md) | | [optional] +**outputtypes** | [**OptimizerOutputTypes**](OptimizerOutputTypes.md) | | + + diff --git a/auto-generated-sdk/docs/Calculation.md b/auto-generated-sdk/docs/Calculation.md index 1726c19..fda68d2 100644 --- a/auto-generated-sdk/docs/Calculation.md +++ b/auto-generated-sdk/docs/Calculation.md @@ -3,8 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**pa** | [**map(PACalculationParameters)**](PACalculationParameters.md) | | [optional] -**spar** | [**map(SPARCalculationParameters)**](SPARCalculationParameters.md) | | [optional] -**vault** | [**map(VaultCalculationParameters)**](VaultCalculationParameters.md) | | [optional] +**pa** | [**map(PACalculationParameters)**](PACalculationParameters.md) | List of PA calculation parameters. | [optional] +**spar** | [**map(SPARCalculationParameters)**](SPARCalculationParameters.md) | List of SPAR calculation parameters. | [optional] +**vault** | [**map(VaultCalculationParameters)**](VaultCalculationParameters.md) | List of Vault calculation parameters. | [optional] +**pub** | [**map(PubCalculationParameters)**](PubCalculationParameters.md) | List of Publisher calculation parameters. | [optional] diff --git a/auto-generated-sdk/docs/CalculationStatus.md b/auto-generated-sdk/docs/CalculationStatus.md index bfe3a21..9d70de8 100644 --- a/auto-generated-sdk/docs/CalculationStatus.md +++ b/auto-generated-sdk/docs/CalculationStatus.md @@ -4,9 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **status** | **character** | | [optional] -**points** | **integer** | | [optional] -**pa** | [**map(CalculationUnitStatus)**](CalculationUnitStatus.md) | | [optional] -**spar** | [**map(CalculationUnitStatus)**](CalculationUnitStatus.md) | | [optional] -**vault** | [**map(CalculationUnitStatus)**](CalculationUnitStatus.md) | | [optional] +**units** | **integer** | Number of calculation units in batch. | [optional] +**pa** | [**map(CalculationUnitStatus)**](CalculationUnitStatus.md) | List of statuses for PA calculation units. | [optional] +**spar** | [**map(CalculationUnitStatus)**](CalculationUnitStatus.md) | List of statuses for SPAR calculation units. | [optional] +**vault** | [**map(CalculationUnitStatus)**](CalculationUnitStatus.md) | List of statuses for Vault calculation units. | [optional] +**pub** | [**map(CalculationUnitStatus)**](CalculationUnitStatus.md) | List of statuses for Publisher calculation units. | [optional] diff --git a/auto-generated-sdk/docs/CalculationStatusSummary.md b/auto-generated-sdk/docs/CalculationStatusSummary.md index 4870e00..e462779 100644 --- a/auto-generated-sdk/docs/CalculationStatusSummary.md +++ b/auto-generated-sdk/docs/CalculationStatusSummary.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **character** | | [optional] -**points** | **integer** | Number of calculation units in batch. | [optional] +**status** | **character** | The status of the calculation. | [optional] +**units** | **integer** | Number of calculation units in batch. | [optional] **requestTime** | **character** | Request time of calculation. | [optional] **lastPollTime** | **character** | Last poll time of calculation. | [optional] diff --git a/auto-generated-sdk/docs/CalculationUnitStatus.md b/auto-generated-sdk/docs/CalculationUnitStatus.md index 6ceec68..269cfa5 100644 --- a/auto-generated-sdk/docs/CalculationUnitStatus.md +++ b/auto-generated-sdk/docs/CalculationUnitStatus.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **character** | | [optional] -**points** | **integer** | | [optional] -**error** | **character** | | [optional] -**result** | **character** | | [optional] +**status** | **character** | The status of calculation unit. | [optional] +**error** | **character** | The error in a calculation unit. | [optional] +**result** | **character** | The result URL of the calculation. | [optional] +**progress** | **character** | The progress of the calculation unit. | [optional] diff --git a/auto-generated-sdk/docs/CalculationsApi.md b/auto-generated-sdk/docs/CalculationsApi.md index fdc293b..e86d33d 100644 --- a/auto-generated-sdk/docs/CalculationsApi.md +++ b/auto-generated-sdk/docs/CalculationsApi.md @@ -65,13 +65,14 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **204** | Expected response, request was cancelled successfully. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **400** | Invalid identifier provided. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **404** | There was no request for the identifier provided, or the request was already canceled for the provided identifier. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in sometime. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **204** | Expected response, request was cancelled 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | There was no request for the identifier provided, or the request was already canceled for the provided identifier. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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.
| # **GetCalculationStatusById** > CalculationStatus GetCalculationStatusById(id) @@ -125,19 +126,20 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, text/json + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns status information of the entire calculation and each individual calculation unit. | * X-RateLimit-Remaining - Number of requests left for the time window.
* Cache-Control - 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 - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **400** | Invalid identifier provided. | * X-RateLimit-Remaining - Number of requests left for the time window.
* Cache-Control - 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 - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication. | * X-RateLimit-Remaining - Number of requests left for the time window.
* Cache-Control - 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 - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials. | * X-RateLimit-Remaining - Number of requests left for the time window.
* Cache-Control - 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 - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **404** | Provided identifier was not a request, or the request was cancelled. | * X-RateLimit-Remaining - Number of requests left for the time window.
* Cache-Control - 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 - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-RateLimit-Remaining - Number of requests left for the time window.
* Cache-Control - 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 - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-RateLimit-Remaining - Number of requests left for the time window.
* Cache-Control - 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 - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in sometime. | * X-RateLimit-Remaining - Number of requests left for the time window.
* Cache-Control - 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 - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns status information of the entire calculation and each individual calculation unit. | * Cache-Control - Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid identifier provided. | * Cache-Control - Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **401** | Missing or invalid authentication. | * Cache-Control - Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
* X-DataDirect-Request-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. | * Cache-Control - Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Provided identifier was not a request, or the request was cancelled. | * Cache-Control - Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **406** | Unsupported Accept header. Header needs to be set to application/json. | * Cache-Control - Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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. | * Cache-Control - Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
* X-DataDirect-Request-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. | * Cache-Control - Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
* X-DataDirect-Request-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. | * Cache-Control - Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| # **GetCalculationStatusSummaries** > map(CalculationStatusSummary) GetCalculationStatusSummaries() @@ -187,30 +189,33 @@ This endpoint does not need any parameter. ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, text/json + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | List of active calculation requests. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in sometime. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | List of active calculation 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.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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.
| # **RunCalculation** -> RunCalculation(calculation=var.calculation) +> RunCalculation(x.factset.content.organization=var.x.factset.content.organization, x.factset.content.type=var.x.factset.content.type, calculation=var.calculation) Run calculation -This endpoint creates a new calculation and runs the set of calculation units specified in the POST body. This must be used first before get status or cancelling endpoints with a calculation id. A successful response will contain the URL to check the status of the calculation request. Remarks: * Maximum 25 points allowed per calculation and maximum 500 points allowed across all simultaneous calculations. (Refer API documentation for more information) * Any settings in POST body will act as a one-time override over the settings saved in the PA/SPAR/Vault template. +This endpoint creates a new calculation and runs the set of calculation units specified in the POST body. This must be used first before get status or cancelling endpoints with a calculation id. A successful response will contain the URL to check the status of the calculation request. Remarks: * Maximum 500 units allowed across all simultaneous calculations. (Refer API documentation for more information) * Any settings in POST body will act as a one-time override over the settings saved in the PA/SPAR/Vault template. ### Example ```R library(factset.analyticsapi.engines) -var.calculation <- Calculation$new(TODO, TODO, TODO) # Calculation | +var.x.factset.content.organization <- 'x.factset.content.organization_example' # character | For specifying the format of the calculation result. Accepted values are \"column\" or \"row\" or \"simplifiedrow\" +var.x.factset.content.type <- 'x.factset.content.type_example' # character | For specifying the content type of the calculation result. Accepted values are either \"application/json\" or \"application/x-protobuf\" +var.calculation <- Calculation$new(TODO, TODO, TODO, TODO) # Calculation | #Run calculation api.instance <- CalculationsApi$new() @@ -218,7 +223,7 @@ api.instance <- CalculationsApi$new() api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; result <- tryCatch( - api.instance$RunCalculation(calculation=var.calculation), + api.instance$RunCalculation(x.factset.content.organization=var.x.factset.content.organization, x.factset.content.type=var.x.factset.content.type, calculation=var.calculation), ApiException = function(ex) ex ) # In case of error, print the error object @@ -236,6 +241,8 @@ response.status.code <- result$response$status_code Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **x.factset.content.organization** | **character**| For specifying the format of the calculation result. Accepted values are \"column\" or \"row\" or \"simplifiedrow\" | [optional] + **x.factset.content.type** | **character**| For specifying the content type of the calculation result. Accepted values are either \"application/json\" or \"application/x-protobuf\" | [optional] **calculation** | [**Calculation**](Calculation.md)| | [optional] ### Return type @@ -254,12 +261,12 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **202** | Expected response, contains the URL in the Location header to check the status of the calculation. | * X-FactSet-Api-Points-Limit - Maximum points limit across all batches.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Points-Remaining - Number of points remaining till points limit reached.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* Location - URL to check status of the request.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **400** | Invalid POST body. | * X-FactSet-Api-Points-Limit - Maximum points limit across all batches.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Points-Remaining - Number of points remaining till points limit reached.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* Location - URL to check status of the request.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication. | * X-FactSet-Api-Points-Limit - Maximum points limit across all batches.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Points-Remaining - Number of points remaining till points limit reached.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* Location - URL to check status of the request.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials. | * X-FactSet-Api-Points-Limit - Maximum points limit across all batches.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Points-Remaining - Number of points remaining till points limit reached.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* Location - URL to check status of the request.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-FactSet-Api-Points-Limit - Maximum points limit across all batches.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Points-Remaining - Number of points remaining till points limit reached.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* Location - URL to check status of the request.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **429** | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish / expire. | * X-FactSet-Api-Points-Limit - Maximum points limit across all batches.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Points-Remaining - Number of points remaining till points limit reached.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* Location - URL to check status of the request.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-FactSet-Api-Points-Limit - Maximum points limit across all batches.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Points-Remaining - Number of points remaining till points limit reached.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* Location - URL to check status of the request.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in sometime. | * X-FactSet-Api-Points-Limit - Maximum points limit across all batches.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Points-Remaining - Number of points remaining till points limit reached.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* Location - URL to check status of the request.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **202** | Expected response, contains the URL in the Location header to check the status of the calculation. | * Location - URL to check status of the request.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Points-Limit - Maximum points limit across all batches.
* X-FactSet-Api-Points-Remaining - Number of points remaining till points limit reached.
* X-FactSet-Api-Units-Limit - Maximum units limit across all batches.
* X-FactSet-Api-Units-Remaining - Number of units remaining till units limit reached.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid POST body. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Points-Limit - Maximum points limit across all batches.
* X-FactSet-Api-Points-Remaining - Number of points remaining till points limit reached.
* X-FactSet-Api-Units-Limit - Maximum units limit across all batches.
* X-FactSet-Api-Units-Remaining - Number of units remaining till units limit reached.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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.
* X-FactSet-Api-Points-Limit - Maximum points limit across all batches.
* X-FactSet-Api-Points-Remaining - Number of points remaining till points limit reached.
* X-FactSet-Api-Units-Limit - Maximum units limit across all batches.
* X-FactSet-Api-Units-Remaining - Number of units remaining till units limit reached.
| +| **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-Points-Limit - Maximum points limit across all batches.
* X-FactSet-Api-Points-Remaining - Number of points remaining till points limit reached.
* X-FactSet-Api-Units-Limit - Maximum units limit across all batches.
* X-FactSet-Api-Units-Remaining - Number of units remaining till units limit reached.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Points-Limit - Maximum points limit across all batches.
* X-FactSet-Api-Points-Remaining - Number of points remaining till points limit reached.
* X-FactSet-Api-Units-Limit - Maximum units limit across all batches.
* X-FactSet-Api-Units-Remaining - Number of units remaining till units limit reached.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **429** | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish / expire. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Points-Limit - Maximum points limit across all batches.
* X-FactSet-Api-Points-Remaining - Number of points remaining till points limit reached.
* X-FactSet-Api-Units-Limit - Maximum units limit across all batches.
* X-FactSet-Api-Units-Remaining - Number of units remaining till units limit reached.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Points-Limit - Maximum points limit across all batches.
* X-FactSet-Api-Points-Remaining - Number of points remaining till points limit reached.
* X-FactSet-Api-Units-Limit - Maximum units limit across all batches.
* X-FactSet-Api-Units-Remaining - Number of units remaining till units limit reached.
| +| **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.
* X-FactSet-Api-Points-Limit - Maximum points limit across all batches.
* X-FactSet-Api-Points-Remaining - Number of points remaining till points limit reached.
* X-FactSet-Api-Units-Limit - Maximum units limit across all batches.
* X-FactSet-Api-Units-Remaining - Number of units remaining till units limit reached.
| diff --git a/auto-generated-sdk/docs/ColumnStatisticsApi.md b/auto-generated-sdk/docs/ColumnStatisticsApi.md index a892870..6ad6b39 100644 --- a/auto-generated-sdk/docs/ColumnStatisticsApi.md +++ b/auto-generated-sdk/docs/ColumnStatisticsApi.md @@ -60,10 +60,11 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns a list of PA column statistics | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in sometime. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns a list of PA column statistics | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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/ColumnSummary.md b/auto-generated-sdk/docs/ColumnSummary.md index c9021e2..53fb4ee 100644 --- a/auto-generated-sdk/docs/ColumnSummary.md +++ b/auto-generated-sdk/docs/ColumnSummary.md @@ -1,5 +1,6 @@ # factset.analyticsapi.engines::ColumnSummary +Column settings (name, directory, category) ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/auto-generated-sdk/docs/ColumnsApi.md b/auto-generated-sdk/docs/ColumnsApi.md index 5bfb13d..d9f8f58 100644 --- a/auto-generated-sdk/docs/ColumnsApi.md +++ b/auto-generated-sdk/docs/ColumnsApi.md @@ -65,17 +65,18 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns settings of a PA column. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **400** | Invalid column Id. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **404** | Column not found. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in sometime. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns settings of a PA column. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid column Id. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Column 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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.
| # **GetPAColumns** -> map(ColumnSummary) GetPAColumns(name=var.name, category=var.category, directory=var.directory) +> map(ColumnSummary) GetPAColumns(name='', category='', directory='') Get PA columns @@ -85,9 +86,9 @@ This endpoint lists all the PA columns that can be applied to a calculation. ```R library(factset.analyticsapi.engines) -var.name <- 'name_example' # character | -var.category <- 'category_example' # character | -var.directory <- 'directory_example' # character | +var.name <- '' # character | Column name +var.category <- '' # character | Column category +var.directory <- '' # character | The directory to get the columns in #Get PA columns api.instance <- ColumnsApi$new() @@ -115,9 +116,9 @@ response.status.code <- result$response$status_code Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **name** | **character**| | [optional] - **category** | **character**| | [optional] - **directory** | **character**| | [optional] + **name** | **character**| Column name | [optional] [default to ''] + **category** | **character**| Column category | [optional] [default to ''] + **directory** | **character**| The directory to get the columns in | [optional] [default to ''] ### Return type @@ -135,10 +136,11 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns a list of PA columns | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in sometime. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns a list of PA columns | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Age - Standard HTTP header. Header will specify the age of columns list cached response.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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/ComponentsApi.md b/auto-generated-sdk/docs/ComponentsApi.md index a290a7b..9801c3b 100644 --- a/auto-generated-sdk/docs/ComponentsApi.md +++ b/auto-generated-sdk/docs/ComponentsApi.md @@ -68,14 +68,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns the default settings of a PA component. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **400** | Invalid PA component id. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **404** | Component not found. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in sometime. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns the default settings of a PA component. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid PA component id. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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.
| # **GetPAComponents** > map(ComponentSummary) GetPAComponents(document) @@ -134,14 +135,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns a list of PA components. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **400** | Invalid query parameter provided or Invalid PA document name. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **404** | Document not found. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in sometime. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns a list of 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid query parameter provided or Invalid PA document name. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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.
| # **GetSPARComponents** > map(ComponentSummary) GetSPARComponents(document) @@ -200,14 +202,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns a list of SPAR components. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **400** | Invalid query parameter provided or Invalid SPAR document name. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **404** | SPAR Document not found. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in sometime. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns a list of SPAR 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid query parameter provided or Invalid SPAR document name. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | SPAR 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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.
| # **GetVaultComponentById** > VaultComponent GetVaultComponentById(id) @@ -266,14 +269,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns the default settings of a Vault component. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **400** | Invalid Vault component id. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **404** | Vault Component not found. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in sometime. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns the default settings of a Vault component. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid Vault component id. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Vault 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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.
| # **GetVaultComponents** > map(ComponentSummary) GetVaultComponents(document) @@ -332,12 +336,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns a list of Vault components. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **400** | Invalid query parameter provided or invalid Vault document name. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **404** | Vault Document not found. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in sometime. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns a list of Vault 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid query parameter provided or invalid Vault document name. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Vault 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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/ConfigurationsApi.md b/auto-generated-sdk/docs/ConfigurationsApi.md index 20a2e10..a1c0023 100644 --- a/auto-generated-sdk/docs/ConfigurationsApi.md +++ b/auto-generated-sdk/docs/ConfigurationsApi.md @@ -65,14 +65,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns details for a Vault configuration. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **400** | Invalid vault configuration code. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **404** | Vault configuration id not found. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in sometime. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns details for a Vault configuration. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid vault configuration code. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Vault configuration id 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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.
| # **GetVaultConfigurations** > map(VaultConfigurationSummary) GetVaultConfigurations(account) @@ -131,12 +132,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns a dictionary of Vault configurations. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **400** | Invalid account. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **404** | Account not found. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in sometime. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns a dictionary of Vault configurations. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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/CurrenciesApi.md b/auto-generated-sdk/docs/CurrenciesApi.md index 0833c46..b888f62 100644 --- a/auto-generated-sdk/docs/CurrenciesApi.md +++ b/auto-generated-sdk/docs/CurrenciesApi.md @@ -60,10 +60,11 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns a list of PA currencies. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in sometime. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns a list of PA currencies. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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/DatesApi.md b/auto-generated-sdk/docs/DatesApi.md index e82d45a..cfa018a 100644 --- a/auto-generated-sdk/docs/DatesApi.md +++ b/auto-generated-sdk/docs/DatesApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description Convert PA dates to absolute format -This endpoint converts the given start and end dates to yyyymmdd format for a PA calculation. +This endpoint converts the given start and end dates in FactSet date format to yyyymmdd format for a PA calculation. For more information on FactSet date format, please refer to the PA Engine API documentation under the 'API Documentation' section in the developer portal. ### Example ```R @@ -71,21 +71,22 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns the converted dates in yyyymmdd format. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **400** | Invalid query parameter or value is provided. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **404** | Document or account not found. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in sometime. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns the converted dates in yyyymmdd format. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid query parameter or value is provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Document or 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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.
| # **ConvertVaultDatesToAbsoluteFormat** > DateParametersSummary ConvertVaultDatesToAbsoluteFormat(enddate, componentid, account, startdate=var.startdate) Convert Vault dates to absolute format -This endpoint converts the given start and end dates to yyyymmdd format for a Vault calculation. +This endpoint converts the given start and end dates in FactSet date format to yyyymmdd format for a Vault calculation. For more information on FactSet date format, please refer to the Vault API documentation under the 'API Documentation' section in the developer portal. ### Example ```R @@ -143,12 +144,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns the converted dates in yyyymmdd format. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **400** | Invalid query parameter or value is provided. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **404** | vault Document or account not found. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in sometime. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns the converted dates in yyyymmdd format. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid query parameter or value is provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | vault Document or 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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/DocumentsApi.md b/auto-generated-sdk/docs/DocumentsApi.md index 3741c8d..13cbbf0 100644 --- a/auto-generated-sdk/docs/DocumentsApi.md +++ b/auto-generated-sdk/docs/DocumentsApi.md @@ -5,6 +5,7 @@ All URIs are relative to *https://api.factset.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**GetPA3Documents**](DocumentsApi.md#GetPA3Documents) | **GET** /analytics/lookups/v2/engines/pa/documents/{path} | Get PA3 documents and sub-directories in a directory +[**GetPubDocuments**](DocumentsApi.md#GetPubDocuments) | **GET** /analytics/lookups/v2/engines/pub/documents/{path} | Gets Publisher documents and sub-directories in a directory [**GetSPAR3Documents**](DocumentsApi.md#GetSPAR3Documents) | **GET** /analytics/lookups/v2/engines/spar/documents/{path} | Gets SPAR3 documents and sub-directories in a directory [**GetVaultDocuments**](DocumentsApi.md#GetVaultDocuments) | **GET** /analytics/lookups/v2/engines/vault/documents/{path} | Get Vault documents and sub-directories in a directory @@ -20,7 +21,7 @@ This endpoint looks up all PA3 documents and sub-directories in a given director ```R library(factset.analyticsapi.engines) -var.path <- 'path_example' # character | The directory to get the documents and sub-directories in +var.path <- '' # character | The directory to get the documents and sub-directories in #Get PA3 documents and sub-directories in a directory api.instance <- DocumentsApi$new() @@ -48,7 +49,7 @@ response.status.code <- result$response$status_code Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **path** | **character**| The directory to get the documents and sub-directories in | + **path** | **character**| The directory to get the documents and sub-directories in | [default to ''] ### Return type @@ -66,14 +67,82 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns a list of PA3 documents and directories | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **400** | Invalid query parameter or value provided | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **404** | Path not found | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in some time | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns a list of PA3 documents and directories | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid query parameter or value provided | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Path 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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 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.
| + +# **GetPubDocuments** +> DocumentDirectories GetPubDocuments(path) + +Gets Publisher documents and sub-directories in a directory + +This endpoint looks up all Publisher documents and sub-directories in a given directory. + +### Example +```R +library(factset.analyticsapi.engines) + +var.path <- '' # character | The directory to get the documents in + +#Gets Publisher documents and sub-directories in a directory +api.instance <- DocumentsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$GetPubDocuments(var.path), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **path** | **character**| The directory to get the documents in | [default to ''] + +### Return type + +[**DocumentDirectories**](DocumentDirectories.md) + +### Authorization + +[Basic](../README.md#Basic) + +### 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 Publisher documents and directories | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid query parameter or value provided | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Path 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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 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.
| # **GetSPAR3Documents** > DocumentDirectories GetSPAR3Documents(path) @@ -86,7 +155,7 @@ This endpoint looks up all SPAR3 documents and sub-directories in a given direct ```R library(factset.analyticsapi.engines) -var.path <- 'path_example' # character | The directory to get the documents in +var.path <- '' # character | The directory to get the documents in #Gets SPAR3 documents and sub-directories in a directory api.instance <- DocumentsApi$new() @@ -114,7 +183,7 @@ response.status.code <- result$response$status_code Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **path** | **character**| The directory to get the documents in | + **path** | **character**| The directory to get the documents in | [default to ''] ### Return type @@ -132,14 +201,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns a list of SPAR3 documents and directories | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **400** | Invalid query parameter or value provided | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **404** | Path not found | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in some time | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns a list of SPAR3 documents and directories | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid query parameter or value provided | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Path 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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 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.
| # **GetVaultDocuments** > DocumentDirectories GetVaultDocuments(path) @@ -152,7 +222,7 @@ This endpoint looks up all Vault documents and sub-directories in a given direct ```R library(factset.analyticsapi.engines) -var.path <- 'path_example' # character | The directory to get the documents in +var.path <- '' # character | The directory to get the documents in #Get Vault documents and sub-directories in a directory api.instance <- DocumentsApi$new() @@ -180,7 +250,7 @@ response.status.code <- result$response$status_code Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **path** | **character**| The directory to get the documents in | + **path** | **character**| The directory to get the documents in | [default to ''] ### Return type @@ -198,12 +268,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns a list of Vault documents and directories | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **400** | Invalid query parameter or value provided | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **404** | Path not found | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in some time | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns a list of Vault documents and directories | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid query parameter or value provided | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Path 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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 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.
| diff --git a/auto-generated-sdk/docs/EventSummary.md b/auto-generated-sdk/docs/EventSummary.md new file mode 100644 index 0000000..6ce3759 --- /dev/null +++ b/auto-generated-sdk/docs/EventSummary.md @@ -0,0 +1,10 @@ +# factset.analyticsapi.engines::EventSummary + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **character** | | [optional] +**submissiondatetime** | **character** | | [optional] +**type** | **character** | | [optional] + + diff --git a/auto-generated-sdk/docs/FIABCalculationParameters.md b/auto-generated-sdk/docs/FIABCalculationParameters.md new file mode 100644 index 0000000..c4b0a3c --- /dev/null +++ b/auto-generated-sdk/docs/FIABCalculationParameters.md @@ -0,0 +1,12 @@ +# factset.analyticsapi.engines::FIABCalculationParameters + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fiabdocument** | **character** | FiabDocument (optional) - FIAB document to use as a template. Should be a path to a FIAB document. Expects a GUI-style path (Client:/foo/bar) | [optional] +**account** | [**FIABIdentifier**](FIABIdentifier.md) | | +**dates** | [**FIABDateParameters**](FIABDateParameters.md) | | +**msl** | **character** | Master FISecurity List. Analytics results will be written to the selected MSL. Expects a GUI-style path (Client:/foo/bar) | [optional] +**fisettingsdocument** | **character** | FISettingsDocument (optional) - The given @FIS document will be used to configure analytics assumptions and settings. Expects a GUI-style path (Client:/foo/bar) | [optional] + + diff --git a/auto-generated-sdk/docs/FIABCalculationStatus.md b/auto-generated-sdk/docs/FIABCalculationStatus.md new file mode 100644 index 0000000..9257b8a --- /dev/null +++ b/auto-generated-sdk/docs/FIABCalculationStatus.md @@ -0,0 +1,13 @@ +# factset.analyticsapi.engines::FIABCalculationStatus + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **character** | | [optional] +**status** | **character** | FIAB service batch status integer definitions. See https://pages.github.factset.com/FactSet/fipa-inf-docs/service/fiab_batch_api.html#lt-uuid-gt. | [optional] +**startdatetime** | **character** | | [optional] +**completiondatetime** | **character** | | [optional] +**progress** | **integer** | | [optional] +**batchevents** | [**array[EventSummary]**](EventSummary.md) | | [optional] + + diff --git a/auto-generated-sdk/docs/FIABCalculationStatusSummary.md b/auto-generated-sdk/docs/FIABCalculationStatusSummary.md new file mode 100644 index 0000000..9078a19 --- /dev/null +++ b/auto-generated-sdk/docs/FIABCalculationStatusSummary.md @@ -0,0 +1,9 @@ +# factset.analyticsapi.engines::FIABCalculationStatusSummary + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requesttime** | **character** | Request time of calculation. | [optional] +**lastpolltime** | **character** | Last poll time of calculation. | [optional] + + diff --git a/auto-generated-sdk/docs/FIABCalculationsApi.md b/auto-generated-sdk/docs/FIABCalculationsApi.md new file mode 100644 index 0000000..5314f18 --- /dev/null +++ b/auto-generated-sdk/docs/FIABCalculationsApi.md @@ -0,0 +1,202 @@ +# FIABCalculationsApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**GetFIABCalculationById**](FIABCalculationsApi.md#GetFIABCalculationById) | **GET** /analytics/engines/fiab/v1/calculations/{id} | Get FIAB calculation by id +[**GetFIABCalculationStatusSummaries**](FIABCalculationsApi.md#GetFIABCalculationStatusSummaries) | **GET** /analytics/engines/fiab/v1/calculations | Get all FIAB calculation summaries +[**RunFIABCalculation**](FIABCalculationsApi.md#RunFIABCalculation) | **POST** /analytics/engines/fiab/v1/calculations | Run FIAB calculation + + +# **GetFIABCalculationById** +> FIABCalculationStatus GetFIABCalculationById(id) + +Get FIAB calculation by id + +This is the endpoint to check on the progress of a previously requested calculation. + +### Example +```R +library(factset.analyticsapi.engines) + +var.id <- 'id_example' # character | from url, provided from the location header in the Run FIAB Calculation endpoint + +#Get FIAB calculation by id +api.instance <- FIABCalculationsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$GetFIABCalculationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **character**| from url, provided from the location header in the Run FIAB Calculation endpoint | + +### Return type + +[**FIABCalculationStatus**](FIABCalculationStatus.md) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Expected response, returns status information of the entire calculation if it is complete. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **202** | Expected response, returns status information of the entire calculation if it is not complete. | * Cache-Control - Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +# **GetFIABCalculationStatusSummaries** +> map(FIABCalculationStatusSummary) GetFIABCalculationStatusSummaries() + +Get all FIAB calculation summaries + +This endpoints returns all FIAB calculation requests. + +### Example +```R +library(factset.analyticsapi.engines) + + +#Get all FIAB calculation summaries +api.instance <- FIABCalculationsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$GetFIABCalculationStatusSummaries(), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**map(FIABCalculationStatusSummary)**](FIABCalculationStatusSummary.md) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | List of active FIAB calculation 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.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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.
| + +# **RunFIABCalculation** +> RunFIABCalculation(fiab.calculation.parameters=var.fiab.calculation.parameters) + +Run FIAB calculation + +This endpoint creates a new FIAB calculation. This must be used first before get status or cancelling endpoints with a calculation id. A successful response will contain the URL to check the status of the calculation request. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the FIAB template. + +### Example +```R +library(factset.analyticsapi.engines) + +var.fiab.calculation.parameters <- FIABCalculationParameters$new("fiabdocument_example", FIABIdentifier$new("id_example"), FIABDateParameters$new("startdate_example", "enddate_example"), "msl_example", "fisettingsdocument_example") # FIABCalculationParameters | + +#Run FIAB calculation +api.instance <- FIABCalculationsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$RunFIABCalculation(fiab.calculation.parameters=var.fiab.calculation.parameters), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **fiab.calculation.parameters** | [**FIABCalculationParameters**](FIABCalculationParameters.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **202** | Expected response, contains the URL in the Location header to check the status of the calculation. | * Location - URL to check status of the request.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FIAB request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FIAB requests remaining till request limit reached.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid POST body. | * Location - URL to check status of the request.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FIAB request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FIAB requests remaining till request limit reached.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **401** | Missing or invalid authentication. | * Location - URL to check status of the request.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FIAB request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FIAB requests remaining till request limit reached.
| +| **403** | User is forbidden with current credentials. | * Location - URL to check status of the request.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FIAB request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FIAB requests remaining till request limit reached.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * Location - URL to check status of the request.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FIAB request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FIAB requests remaining till request limit reached.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **429** | Rate limit reached. Cancel older requests using Cancel FIAB Calculation endpoint or wait for older requests to finish / expire. | * Location - URL to check status of the request.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FIAB request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FIAB requests remaining till request limit reached.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * Location - URL to check status of the request.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FIAB request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FIAB requests remaining till request limit reached.
| +| **503** | Request timed out. Retry the request in sometime. | * Location - URL to check status of the request.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FIAB request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FIAB requests remaining till request limit reached.
| + diff --git a/auto-generated-sdk/docs/FIABDateParameters.md b/auto-generated-sdk/docs/FIABDateParameters.md new file mode 100644 index 0000000..d70a9ac --- /dev/null +++ b/auto-generated-sdk/docs/FIABDateParameters.md @@ -0,0 +1,10 @@ +# factset.analyticsapi.engines::FIABDateParameters + +The date parameters for FIAB calculations. +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**startdate** | **character** | Calculation's start date. | +**enddate** | **character** | Calculation's end date. | + + diff --git a/auto-generated-sdk/docs/FIABIdentifier.md b/auto-generated-sdk/docs/FIABIdentifier.md new file mode 100644 index 0000000..88ec110 --- /dev/null +++ b/auto-generated-sdk/docs/FIABIdentifier.md @@ -0,0 +1,8 @@ +# factset.analyticsapi.engines::FIABIdentifier + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **character** | User's FactSet account path. | + + diff --git a/auto-generated-sdk/docs/FICalculationParameters.md b/auto-generated-sdk/docs/FICalculationParameters.md new file mode 100644 index 0000000..124fbdf --- /dev/null +++ b/auto-generated-sdk/docs/FICalculationParameters.md @@ -0,0 +1,10 @@ +# factset.analyticsapi.engines::FICalculationParameters + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**securities** | [**array[FISecurity]**](FISecurity.md) | | +**calculations** | **array[character]** | | +**jobSettings** | [**FIJobSettings**](FIJobSettings.md) | | + + diff --git a/auto-generated-sdk/docs/FICalculationsApi.md b/auto-generated-sdk/docs/FICalculationsApi.md new file mode 100644 index 0000000..ef192a0 --- /dev/null +++ b/auto-generated-sdk/docs/FICalculationsApi.md @@ -0,0 +1,212 @@ +# FICalculationsApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CancelFICalculationById**](FICalculationsApi.md#CancelFICalculationById) | **DELETE** /analytics/engines/fi/v1/calculations/{id} | Cancel FI calculation by id +[**GetFICalculationById**](FICalculationsApi.md#GetFICalculationById) | **GET** /analytics/engines/fi/v1/calculations/{id} | Get FI calculation by id +[**RunFICalculation**](FICalculationsApi.md#RunFICalculation) | **POST** /analytics/engines/fi/v1/calculations | Run FI calculation + + +# **CancelFICalculationById** +> CancelFICalculationById(id) + +Cancel FI calculation by id + +This is the endpoint to cancel a previously submitted calculation. Instead of doing a GET on the polling URL, cancel the request by doing a DELETE. + +### Example +```R +library(factset.analyticsapi.engines) + +var.id <- 'id_example' # character | from url, provided from the location header in the Run FI Calculation endpoint + +#Cancel FI calculation by id +api.instance <- FICalculationsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$CancelFICalculationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **character**| from url, provided from the location header in the Run FI Calculation endpoint | + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Expected response, calculation was canceled 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | There was no request for the calculation identifier provided, or the request was already canceled for the provided identifier. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +# **GetFICalculationById** +> object GetFICalculationById(id) + +Get FI calculation by id + +This is the endpoint to check on the progress of a previously requested calculation. If the calculation has finished computing, the body of the response will contain the requested document in JSON. Otherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. + +### Example +```R +library(factset.analyticsapi.engines) + +var.id <- 'id_example' # character | from url, provided from the location header in the Run FI Calculation endpoint + +#Get FI calculation by id +api.instance <- FICalculationsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$GetFICalculationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **character**| from url, provided from the location header in the Run FI Calculation endpoint | + +### Return type + +**object** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Expected response once calculation is completed, returns JSON in the format specified in the Run Calculations endpoint. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **202** | Expected response returned if the calculation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. | * X-FactSet-Api-PickUp-Progress - FactSet's progress header.
* Cache-Control - Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +# **RunFICalculation** +> object RunFICalculation(x.factset.content.organization=var.x.factset.content.organization, x.factset.content.type=var.x.factset.content.type, fi.calculation.parameters=var.fi.calculation.parameters) + +Run FI calculation + +This endpoint creates a new FI calculation. This must be used first before get status or cancelling endpoints with a calculation id. A successful response will contain the resulting FI calculation or a polling URL in location header if the request takes too long. + +### Example +```R +library(factset.analyticsapi.engines) + +var.x.factset.content.organization <- 'x.factset.content.organization_example' # character | For specifying the format of the calculation result. Accepted values are \"column\" or \"row\" or \"simplifiedrow\" +var.x.factset.content.type <- 'x.factset.content.type_example' # character | For specifying the content type of the calculation result. Accepted values are either \"application/json\" or \"application/x-protobuf\" +var.fi.calculation.parameters <- FICalculationParameters$new(list(FISecurity$new("calcFromMethod_example", 123, 123, "symbol_example", "settlementDate_example", "discountCurve_example")), list("calculations_example"), FIJobSettings$new("yieldCurveDate_example", list(123))) # FICalculationParameters | + +#Run FI calculation +api.instance <- FICalculationsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$RunFICalculation(x.factset.content.organization=var.x.factset.content.organization, x.factset.content.type=var.x.factset.content.type, fi.calculation.parameters=var.fi.calculation.parameters), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **x.factset.content.organization** | **character**| For specifying the format of the calculation result. Accepted values are \"column\" or \"row\" or \"simplifiedrow\" | [optional] + **x.factset.content.type** | **character**| For specifying the content type of the calculation result. Accepted values are either \"application/json\" or \"application/x-protobuf\" | [optional] + **fi.calculation.parameters** | [**FICalculationParameters**](FICalculationParameters.md)| | [optional] + +### Return type + +**object** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **201** | Expected response if calculation is completed within 30 seconds, returns JSON in the format specified in the Run Calculations endpoint. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid POST body. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
| +| **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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **429** | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
| +| **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.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
| + diff --git a/auto-generated-sdk/docs/FIJobSettings.md b/auto-generated-sdk/docs/FIJobSettings.md new file mode 100644 index 0000000..56a2e93 --- /dev/null +++ b/auto-generated-sdk/docs/FIJobSettings.md @@ -0,0 +1,9 @@ +# factset.analyticsapi.engines::FIJobSettings + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**yieldCurveDate** | **character** | | +**partialDurationMonths** | **array[integer]** | | [optional] + + diff --git a/auto-generated-sdk/docs/FISecurity.md b/auto-generated-sdk/docs/FISecurity.md new file mode 100644 index 0000000..eaf41b9 --- /dev/null +++ b/auto-generated-sdk/docs/FISecurity.md @@ -0,0 +1,13 @@ +# factset.analyticsapi.engines::FISecurity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**calcFromMethod** | **character** | | +**calcFromValue** | **numeric** | | +**face** | **numeric** | | +**symbol** | **character** | | +**settlementDate** | **character** | | +**discountCurve** | **character** | | + + diff --git a/auto-generated-sdk/docs/FrequenciesApi.md b/auto-generated-sdk/docs/FrequenciesApi.md index ae3150d..4ba52c0 100644 --- a/auto-generated-sdk/docs/FrequenciesApi.md +++ b/auto-generated-sdk/docs/FrequenciesApi.md @@ -62,12 +62,13 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns a list of PA frequencies. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in sometime. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns a list of PA frequencies. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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.
| # **GetSPARFrequencies** > map(Frequency) GetSPARFrequencies() @@ -122,12 +123,13 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns a list of SPAR frequencies. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in sometime. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns a list of SPAR frequencies. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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.
| # **GetVaultFrequencies** > map(Frequency) GetVaultFrequencies() @@ -182,10 +184,11 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns a list of Vault frequencies. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in sometime. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns a list of Vault frequencies. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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/GroupsApi.md b/auto-generated-sdk/docs/GroupsApi.md index cc110c0..c1cf90d 100644 --- a/auto-generated-sdk/docs/GroupsApi.md +++ b/auto-generated-sdk/docs/GroupsApi.md @@ -60,10 +60,11 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Expected response, returns a list of PA groups | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* Age - Standard HTTP header. Header will specify the age of groupings list cached response.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **401** | Missing or invalid authentication. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **403** | User is forbidden with current credentials | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| -| **503** | Request timed out. Retry the request in sometime. | * X-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-DataDirect-Request-Key - FactSet's request key header.
| +| **200** | Expected response, returns a list of PA groups | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Age - Standard HTTP header. Header will specify the age of groupings list cached response.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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/OptimalPortfolio.md b/auto-generated-sdk/docs/OptimalPortfolio.md new file mode 100644 index 0000000..6ac0275 --- /dev/null +++ b/auto-generated-sdk/docs/OptimalPortfolio.md @@ -0,0 +1,11 @@ +# factset.analyticsapi.engines::OptimalPortfolio + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**acctname** | **character** | Account path | [optional] +**excludezero** | **character** | Exclude zero | [optional] +**archivedate** | **character** | Archive date | [optional] +**ifexists** | **character** | Archive action if account exists | [optional] + + diff --git a/auto-generated-sdk/docs/Optimization.md b/auto-generated-sdk/docs/Optimization.md new file mode 100644 index 0000000..b36db5a --- /dev/null +++ b/auto-generated-sdk/docs/Optimization.md @@ -0,0 +1,10 @@ +# factset.analyticsapi.engines::Optimization + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**riskmodeldate** | **character** | Risk model date | [optional] +**backtestdate** | **character** | Backtest date | [optional] +**cashflow** | **character** | Cash flow | [optional] + + diff --git a/auto-generated-sdk/docs/OptimizationsApi.md b/auto-generated-sdk/docs/OptimizationsApi.md new file mode 100644 index 0000000..0ffb521 --- /dev/null +++ b/auto-generated-sdk/docs/OptimizationsApi.md @@ -0,0 +1,204 @@ +# OptimizationsApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CancelAxiomaOptimizationById**](OptimizationsApi.md#CancelAxiomaOptimizationById) | **DELETE** /analytics/engines/axp/v1/optimizations/{id} | Cancel Axioma optimization by id +[**GetAxiomaOptimizationById**](OptimizationsApi.md#GetAxiomaOptimizationById) | **GET** /analytics/engines/axp/v1/optimizations/{id} | Get Axioma optimization by id +[**RunAxiomaOptimization**](OptimizationsApi.md#RunAxiomaOptimization) | **POST** /analytics/engines/axp/v1/optimizations | Run Axioma optimization + + +# **CancelAxiomaOptimizationById** +> CancelAxiomaOptimizationById(id) + +Cancel Axioma optimization by id + +This is the endpoint to cancel a previously submitted optimization. Instead of doing a GET on the polling URL, cancel the request by doing a DELETE. + +### Example +```R +library(factset.analyticsapi.engines) + +var.id <- 'id_example' # character | from url, provided from the location header in the Run Optimization endpoint + +#Cancel Axioma optimization by id +api.instance <- OptimizationsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$CancelAxiomaOptimizationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **character**| from url, provided from the location header in the Run Optimization endpoint | + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Expected response, optimization was canceled 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet’s request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | There was no request for the optimization identifier provided, or the request was already canceled for the provided identifier. | * X-DataDirect-Request-Key - FactSet’s request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet’s request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet’s request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +# **GetAxiomaOptimizationById** +> GetAxiomaOptimizationById(id) + +Get Axioma optimization by id + +This is the endpoint to check on the progress of a previously requested optimization. If the optimization has finished computing, the body of the response will contain result in JSON. Otherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. + +### Example +```R +library(factset.analyticsapi.engines) + +var.id <- 'id_example' # character | from url, provided from the location header in the Run Optimization endpoint + +#Get Axioma optimization by id +api.instance <- OptimizationsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$GetAxiomaOptimizationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **character**| from url, provided from the location header in the Run Optimization endpoint | + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Expected response once optimization is completed, returns JSON in the format specified in the Run Optimization endpoint. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet’s request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **202** | Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. | * X-FactSet-Api-PickUp-Progress - FactSet’s progress header.
* Cache-Control - Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
* X-DataDirect-Request-Key - FactSet’s request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet’s request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled | * X-DataDirect-Request-Key - FactSet’s request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet’s request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet’s request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +# **RunAxiomaOptimization** +> RunAxiomaOptimization(axioma.equity.optimization.parameters=var.axioma.equity.optimization.parameters) + +Run Axioma optimization + +This endpoint runs Axioma optimization specified in the POST body parameters. It must be used first before polling or cancelling endpoints. A successful response will contain the URL to poll for the result of the optimization. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the strategy document. + +### Example +```R +library(factset.analyticsapi.engines) + +var.axioma.equity.optimization.parameters <- AxiomaEquityOptimizationParameters$new(OptimizerStrategy$new("id_example", OptimizerStrategyOverrides$new("objective_example", TODO, "alpha_example", "transactioncost_example", "tax_example")), OptimizerAccount$new("id_example", OptimizerAccountOverrides$new("portfolio_example", "benchmark_example", "riskmodelid_example", "currency_example")), Optimization$new("riskmodeldate_example", "backtestdate_example", "cashflow_example"), OptimizerOutputTypes$new(OptimizerTradesList$new("identifiertype_example", "includecash_example"), OptimizerOptimalHoldings$new("identifiertype_example", "includecash_example", "excludezero_example"), OptimalPortfolio$new("acctname_example", "excludezero_example", "archivedate_example", "ifexists_example"))) # AxiomaEquityOptimizationParameters | + +#Run Axioma optimization +api.instance <- OptimizationsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$RunAxiomaOptimization(axioma.equity.optimization.parameters=var.axioma.equity.optimization.parameters), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **axioma.equity.optimization.parameters** | [**AxiomaEquityOptimizationParameters**](AxiomaEquityOptimizationParameters.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **202** | Expected response, contains the URL in the Location header to check the status of the optimization. | * Location - URL to poll for the resulting optimization
* X-DataDirect-Request-Key - FactSet’s request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **201** | Expected response if optimization is completed within 30 seconds, returns JSON in the format specified in the Run optimization endpoint. | * X-DataDirect-Request-Key - FactSet’s request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid POST body. | * X-DataDirect-Request-Key - FactSet’s request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | One or more optimization settings were unavailable. | * X-DataDirect-Request-Key - FactSet’s request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet’s request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **429** | Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire. | * X-DataDirect-Request-Key - FactSet’s request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet’s request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +| **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/OptimizerAccount.md b/auto-generated-sdk/docs/OptimizerAccount.md new file mode 100644 index 0000000..8c10043 --- /dev/null +++ b/auto-generated-sdk/docs/OptimizerAccount.md @@ -0,0 +1,9 @@ +# factset.analyticsapi.engines::OptimizerAccount + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **character** | Account path | [optional] +**overrides** | [**OptimizerAccountOverrides**](OptimizerAccountOverrides.md) | | [optional] + + diff --git a/auto-generated-sdk/docs/OptimizerAccountOverrides.md b/auto-generated-sdk/docs/OptimizerAccountOverrides.md new file mode 100644 index 0000000..a13f93f --- /dev/null +++ b/auto-generated-sdk/docs/OptimizerAccountOverrides.md @@ -0,0 +1,11 @@ +# factset.analyticsapi.engines::OptimizerAccountOverrides + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**portfolio** | **character** | Portfolio | [optional] +**benchmark** | **character** | Benchmark | [optional] +**riskmodelid** | **character** | Risk model | [optional] +**currency** | **character** | Currency | [optional] + + diff --git a/auto-generated-sdk/docs/OptimizerOptimalHoldings.md b/auto-generated-sdk/docs/OptimizerOptimalHoldings.md new file mode 100644 index 0000000..e9f27b1 --- /dev/null +++ b/auto-generated-sdk/docs/OptimizerOptimalHoldings.md @@ -0,0 +1,10 @@ +# factset.analyticsapi.engines::OptimizerOptimalHoldings + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identifiertype** | **character** | Identifier type | [optional] +**includecash** | **character** | Include cash | [optional] +**excludezero** | **character** | Exclude zero | [optional] + + diff --git a/auto-generated-sdk/docs/OptimizerOutputTypes.md b/auto-generated-sdk/docs/OptimizerOutputTypes.md new file mode 100644 index 0000000..92e9de3 --- /dev/null +++ b/auto-generated-sdk/docs/OptimizerOutputTypes.md @@ -0,0 +1,10 @@ +# factset.analyticsapi.engines::OptimizerOutputTypes + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**trades** | [**OptimizerTradesList**](OptimizerTradesList.md) | | [optional] +**optimal** | [**OptimizerOptimalHoldings**](OptimizerOptimalHoldings.md) | | [optional] +**account** | [**OptimalPortfolio**](OptimalPortfolio.md) | | [optional] + + diff --git a/auto-generated-sdk/docs/OptimizerStrategy.md b/auto-generated-sdk/docs/OptimizerStrategy.md new file mode 100644 index 0000000..dd59c81 --- /dev/null +++ b/auto-generated-sdk/docs/OptimizerStrategy.md @@ -0,0 +1,9 @@ +# factset.analyticsapi.engines::OptimizerStrategy + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **character** | OptimizerStrategy document path | +**overrides** | [**OptimizerStrategyOverrides**](OptimizerStrategyOverrides.md) | | [optional] + + diff --git a/auto-generated-sdk/docs/OptimizerStrategyOverrides.md b/auto-generated-sdk/docs/OptimizerStrategyOverrides.md new file mode 100644 index 0000000..aec611c --- /dev/null +++ b/auto-generated-sdk/docs/OptimizerStrategyOverrides.md @@ -0,0 +1,12 @@ +# factset.analyticsapi.engines::OptimizerStrategyOverrides + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**objective** | **character** | Objective | [optional] +**constraints** | **map(character)** | List of constraints | [optional] +**alpha** | **character** | Alpha | [optional] +**transactioncost** | **character** | Transaction cost | [optional] +**tax** | **character** | Tax | [optional] + + diff --git a/auto-generated-sdk/docs/OptimizerTradesList.md b/auto-generated-sdk/docs/OptimizerTradesList.md new file mode 100644 index 0000000..e94a2c0 --- /dev/null +++ b/auto-generated-sdk/docs/OptimizerTradesList.md @@ -0,0 +1,9 @@ +# factset.analyticsapi.engines::OptimizerTradesList + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identifiertype** | **character** | Identifier type | [optional] +**includecash** | **character** | Include cash | [optional] + + diff --git a/auto-generated-sdk/docs/PACalculationParameters.md b/auto-generated-sdk/docs/PACalculationParameters.md index 0036ac6..1622aa7 100644 --- a/auto-generated-sdk/docs/PACalculationParameters.md +++ b/auto-generated-sdk/docs/PACalculationParameters.md @@ -4,11 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **componentid** | **character** | The PA Engine component identifier to analyze. | -**accounts** | [**array[PAIdentifier]**](PAIdentifier.md) | | [optional] -**benchmarks** | [**array[PAIdentifier]**](PAIdentifier.md) | | [optional] +**accounts** | [**array[PAIdentifier]**](PAIdentifier.md) | List of accounts. | [optional] +**benchmarks** | [**array[PAIdentifier]**](PAIdentifier.md) | List of benchmarks. | [optional] **dates** | [**PADateParameters**](PADateParameters.md) | | [optional] -**groups** | [**array[PACalculationGroup]**](PACalculationGroup.md) | | [optional] +**groups** | [**array[PACalculationGroup]**](PACalculationGroup.md) | List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document. | [optional] **currencyisocode** | **character** | Currency ISO code for calculation. | [optional] -**columns** | [**array[PACalculationColumn]**](PACalculationColumn.md) | | [optional] +**columns** | [**array[PACalculationColumn]**](PACalculationColumn.md) | List of columns for the PA calculation. This will take precedence over the columns saved in the PA document. | [optional] +**componentdetail** | **character** | Component detail type for the PA component. It can be GROUPS or TOTALS. | [optional] diff --git a/auto-generated-sdk/docs/PACalculationsApi.md b/auto-generated-sdk/docs/PACalculationsApi.md new file mode 100644 index 0000000..c326089 --- /dev/null +++ b/auto-generated-sdk/docs/PACalculationsApi.md @@ -0,0 +1,212 @@ +# PACalculationsApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CancelPACalculationById**](PACalculationsApi.md#CancelPACalculationById) | **DELETE** /analytics/engines/pa/v2/calculations/{id} | Cancel PA calculation by id +[**GetPACalculationById**](PACalculationsApi.md#GetPACalculationById) | **GET** /analytics/engines/pa/v2/calculations/{id} | Get PA calculation by id +[**RunPACalculation**](PACalculationsApi.md#RunPACalculation) | **POST** /analytics/engines/pa/v2/calculations | Run PA Calculation + + +# **CancelPACalculationById** +> CancelPACalculationById(id) + +Cancel PA calculation by id + +This is the endpoint to cancel a previously submitted calculation. Instead of doing a GET on the polling URL, cancel the request by doing a DELETE. + +### Example +```R +library(factset.analyticsapi.engines) + +var.id <- 'id_example' # character | from url, provided from the location header in the Run Calculation endpoint + +#Cancel PA calculation by id +api.instance <- PACalculationsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$CancelPACalculationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **character**| from url, provided from the location header in the Run Calculation endpoint | + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Expected response, calculation was canceled 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | There was no request for the calculation identifier provided, or the request was already canceled for the provided identifier. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +# **GetPACalculationById** +> object GetPACalculationById(id) + +Get PA calculation by id + +This is the endpoint to check on the progress of a previously requested calculation. If the calculation has finished computing, the body of the response will contain the requested document in JSON. Otherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. + +### Example +```R +library(factset.analyticsapi.engines) + +var.id <- 'id_example' # character | from url, provided from the location header in the Run Calculation endpoint + +#Get PA calculation by id +api.instance <- PACalculationsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$GetPACalculationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **character**| from url, provided from the location header in the Run Calculation endpoint | + +### Return type + +**object** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Expected response once calculation is completed, returns JSON in the format specified in the Run Calculations endpoint. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **202** | Expected response returned if the calculation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. | * X-FactSet-Api-PickUp-Progress - FactSet's progress header.
* Cache-Control - Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +# **RunPACalculation** +> object RunPACalculation(x.factset.content.organization=var.x.factset.content.organization, x.factset.content.type=var.x.factset.content.type, pa.calculation.parameters=var.pa.calculation.parameters) + +Run PA Calculation + +This endpoint runs the PA calculation specified in the POST body parameters. It must be used first before polling or cancelling endpoints. A successful response will contain the URL to poll for the result of the calculation. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. + +### Example +```R +library(factset.analyticsapi.engines) + +var.x.factset.content.organization <- 'x.factset.content.organization_example' # character | For specifying the format of the calculation result. Accepted values are \"column\" or \"row\" or \"simplifiedrow\" +var.x.factset.content.type <- 'x.factset.content.type_example' # character | For specifying the content type of the calculation result. Accepted values are either \"application/json\" or \"application/x-protobuf\" +var.pa.calculation.parameters <- PACalculationParameters$new("componentid_example", list(PAIdentifier$new("id_example", "holdingsmode_example")), list(PAIdentifier$new("id_example", "holdingsmode_example")), PADateParameters$new("startdate_example", "enddate_example", "frequency_example"), list(PACalculationGroup$new("id_example")), "currencyisocode_example", list(PACalculationColumn$new("id_example", list("statistics_example"))), "componentdetail_example") # PACalculationParameters | + +#Run PA Calculation +api.instance <- PACalculationsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$RunPACalculation(x.factset.content.organization=var.x.factset.content.organization, x.factset.content.type=var.x.factset.content.type, pa.calculation.parameters=var.pa.calculation.parameters), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **x.factset.content.organization** | **character**| For specifying the format of the calculation result. Accepted values are \"column\" or \"row\" or \"simplifiedrow\" | [optional] + **x.factset.content.type** | **character**| For specifying the content type of the calculation result. Accepted values are either \"application/json\" or \"application/x-protobuf\" | [optional] + **pa.calculation.parameters** | [**PACalculationParameters**](PACalculationParameters.md)| | [optional] + +### Return type + +**object** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **201** | Expected response if calculation is completed within 30 seconds, returns JSON in the format specified in the Run Calculations endpoint. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid POST body. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **429** | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +| **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/PAComponent.md b/auto-generated-sdk/docs/PAComponent.md index b1bc28d..6b19cdd 100644 --- a/auto-generated-sdk/docs/PAComponent.md +++ b/auto-generated-sdk/docs/PAComponent.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **character** | Component identifier. | [optional] -**accounts** | [**array[PAIdentifier]**](PAIdentifier.md) | | [optional] [readonly] -**benchmarks** | [**array[PAIdentifier]**](PAIdentifier.md) | | [optional] [readonly] +**accounts** | [**array[PAIdentifier]**](PAIdentifier.md) | List of accounts saved in the PA document. | [optional] [readonly] +**benchmarks** | [**array[PAIdentifier]**](PAIdentifier.md) | List of benchmarks saved in the PA document. | [optional] [readonly] **currencyisocode** | **character** | | [optional] **dates** | [**PADateParameters**](PADateParameters.md) | | [optional] -**snapshot** | **character** | | [optional] +**snapshot** | **character** | Is the component type snapshot or subperiod. | [optional] **name** | **character** | Component name. | [optional] **category** | **character** | Component category. | [optional] diff --git a/auto-generated-sdk/docs/PADateParameters.md b/auto-generated-sdk/docs/PADateParameters.md index 2bb60f9..2ae19bb 100644 --- a/auto-generated-sdk/docs/PADateParameters.md +++ b/auto-generated-sdk/docs/PADateParameters.md @@ -1,5 +1,6 @@ # factset.analyticsapi.engines::PADateParameters +The date parameters for PA calculation. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/auto-generated-sdk/docs/PAIdentifier.md b/auto-generated-sdk/docs/PAIdentifier.md index 426996e..ede2675 100644 --- a/auto-generated-sdk/docs/PAIdentifier.md +++ b/auto-generated-sdk/docs/PAIdentifier.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **character** | User's FactSet account path OR benchmark. | -**holdingsmode** | **character** | Holdings Mode can be buyandhold, TBR or OMS. | [optional] +**holdingsmode** | **character** | Holdings Mode can be B&H, TBR, OMS or EXT. | [optional] diff --git a/auto-generated-sdk/docs/PubCalculationParameters.md b/auto-generated-sdk/docs/PubCalculationParameters.md new file mode 100644 index 0000000..ade851f --- /dev/null +++ b/auto-generated-sdk/docs/PubCalculationParameters.md @@ -0,0 +1,10 @@ +# factset.analyticsapi.engines::PubCalculationParameters + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**document** | **character** | The Publisher Engine document to analyze. | +**account** | [**PubIdentifier**](PubIdentifier.md) | | +**dates** | [**PubDateParameters**](PubDateParameters.md) | | + + diff --git a/auto-generated-sdk/docs/PubDateParameters.md b/auto-generated-sdk/docs/PubDateParameters.md new file mode 100644 index 0000000..c42aedf --- /dev/null +++ b/auto-generated-sdk/docs/PubDateParameters.md @@ -0,0 +1,10 @@ +# factset.analyticsapi.engines::PubDateParameters + +The date parameters for Publisher calculation. +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**startdate** | **character** | Calculation's start date. | [optional] +**enddate** | **character** | Calculation's end date or as of date. | + + diff --git a/auto-generated-sdk/docs/PubIdentifier.md b/auto-generated-sdk/docs/PubIdentifier.md new file mode 100644 index 0000000..b163ffd --- /dev/null +++ b/auto-generated-sdk/docs/PubIdentifier.md @@ -0,0 +1,9 @@ +# factset.analyticsapi.engines::PubIdentifier + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **character** | User's FactSet account path OR benchmark. | +**holdingsmode** | **character** | Holdings Mode can be B&H, TBR, OMS or EXT. | [optional] + + diff --git a/auto-generated-sdk/docs/SPARBenchmark.md b/auto-generated-sdk/docs/SPARBenchmark.md new file mode 100644 index 0000000..31a5a82 --- /dev/null +++ b/auto-generated-sdk/docs/SPARBenchmark.md @@ -0,0 +1,10 @@ +# factset.analyticsapi.engines::SPARBenchmark + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **character** | Benchmark identifier | [optional] +**name** | **character** | Benchmark Name | [optional] +**identifiers** | [**array[SPARIdentifier]**](SPARIdentifier.md) | List of SPAR identifiers | [optional] + + diff --git a/auto-generated-sdk/docs/SPARBenchmarkApi.md b/auto-generated-sdk/docs/SPARBenchmarkApi.md new file mode 100644 index 0000000..fade0e5 --- /dev/null +++ b/auto-generated-sdk/docs/SPARBenchmarkApi.md @@ -0,0 +1,76 @@ +# SPARBenchmarkApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**GetSPARBenchmarkById**](SPARBenchmarkApi.md#GetSPARBenchmarkById) | **GET** /analytics/lookups/v2/engines/spar/benchmarks | Get SPAR benchmark details + + +# **GetSPARBenchmarkById** +> SPARBenchmark GetSPARBenchmarkById(id) + +Get SPAR benchmark details + +This endpoint returns the details of a given SPAR benchmark identifier. + +### Example +```R +library(factset.analyticsapi.engines) + +var.id <- 'id_example' # character | Benchmark Identifier + +#Get SPAR benchmark details +api.instance <- SPARBenchmarkApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$GetSPARBenchmarkById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **character**| Benchmark Identifier | + +### Return type + +[**SPARBenchmark**](SPARBenchmark.md) + +### Authorization + +[Basic](../README.md#Basic) + +### 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 prefix and return types for the benchmark. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid benchmark identifier. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Benchmark identifier 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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/SPARCalculationParameters.md b/auto-generated-sdk/docs/SPARCalculationParameters.md index 738bef1..5c5eae3 100644 --- a/auto-generated-sdk/docs/SPARCalculationParameters.md +++ b/auto-generated-sdk/docs/SPARCalculationParameters.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **componentid** | **character** | The SPAR Engine component identifier to analyze. | -**accounts** | [**array[SPARIdentifier]**](SPARIdentifier.md) | | [optional] +**accounts** | [**array[SPARIdentifier]**](SPARIdentifier.md) | List of accounts for SPAR calculation. | [optional] **benchmark** | [**SPARIdentifier**](SPARIdentifier.md) | | [optional] **dates** | [**SPARDateParameters**](SPARDateParameters.md) | | [optional] diff --git a/auto-generated-sdk/docs/SPARCalculationsApi.md b/auto-generated-sdk/docs/SPARCalculationsApi.md new file mode 100644 index 0000000..e96dafd --- /dev/null +++ b/auto-generated-sdk/docs/SPARCalculationsApi.md @@ -0,0 +1,212 @@ +# SPARCalculationsApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CancelSPARCalculationById**](SPARCalculationsApi.md#CancelSPARCalculationById) | **DELETE** /analytics/engines/spar/v2/calculations/{id} | Cancel SPAR calculation +[**GetSPARCalculationById**](SPARCalculationsApi.md#GetSPARCalculationById) | **GET** /analytics/engines/spar/v2/calculations/{id} | Get SPAR calculation by id +[**RunSPARCalculation**](SPARCalculationsApi.md#RunSPARCalculation) | **POST** /analytics/engines/spar/v2/calculations | Run SPAR Calculation + + +# **CancelSPARCalculationById** +> CancelSPARCalculationById(id) + +Cancel SPAR calculation + +This is the endpoint to cancel a previously submitted calculation. Instead of doing a GET on the polling URL, cancel the request by doing a DELETE + +### Example +```R +library(factset.analyticsapi.engines) + +var.id <- 'id_example' # character | from url, provided from the location header in the Run Calculation endpoint + +#Cancel SPAR calculation +api.instance <- SPARCalculationsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$CancelSPARCalculationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **character**| from url, provided from the location header in the Run Calculation endpoint | + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Expected response, calculation was canceled 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | There was no request for the calculation identifier provided, or the request was already canceled for the provided identifier. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +# **GetSPARCalculationById** +> object GetSPARCalculationById(id) + +Get SPAR calculation by id + +This is the endpoint to check on the progress of a previously requested calculation. If the calculation has finished computing, the body of the response will contain the requested document in JSON. + +### Example +```R +library(factset.analyticsapi.engines) + +var.id <- 'id_example' # character | from url, provided from the location header in the Run Calculation endpoint + +#Get SPAR calculation by id +api.instance <- SPARCalculationsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$GetSPARCalculationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **character**| from url, provided from the location header in the Run Calculation endpoint | + +### Return type + +**object** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Expected response once calculation is completed, returns JSON in the format specified in the Run Calculations endpoint. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **202** | Expected response returned if the calculation is not yet completed. | * Cache-Control - Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +# **RunSPARCalculation** +> object RunSPARCalculation(x.factset.content.organization=var.x.factset.content.organization, x.factset.content.type=var.x.factset.content.type, spar.calculation.parameters=var.spar.calculation.parameters) + +Run SPAR Calculation + +This endpoint runs the SPAR calculation specified in the POST body parameters. It must be used first before polling or cancelling endpoints. A successful response will contain the URL to poll for the result of the calculation. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the SPAR template. + +### Example +```R +library(factset.analyticsapi.engines) + +var.x.factset.content.organization <- 'x.factset.content.organization_example' # character | For specifying the format of the calculation result. Accepted values are \"column\" or \"row\" or \"simplifiedrow\" +var.x.factset.content.type <- 'x.factset.content.type_example' # character | For specifying the content type of the calculation result. Accepted values are either \"application/json\" or \"application/x-protobuf\" +var.spar.calculation.parameters <- SPARCalculationParameters$new("componentid_example", list(SPARIdentifier$new("id_example", "returntype_example", "prefix_example")), SPARIdentifier$new("id_example", "returntype_example", "prefix_example"), SPARDateParameters$new("startdate_example", "enddate_example", "frequency_example")) # SPARCalculationParameters | + +#Run SPAR Calculation +api.instance <- SPARCalculationsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$RunSPARCalculation(x.factset.content.organization=var.x.factset.content.organization, x.factset.content.type=var.x.factset.content.type, spar.calculation.parameters=var.spar.calculation.parameters), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **x.factset.content.organization** | **character**| For specifying the format of the calculation result. Accepted values are \"column\" or \"row\" or \"simplifiedrow\" | [optional] + **x.factset.content.type** | **character**| For specifying the content type of the calculation result. Accepted values are either \"application/json\" or \"application/x-protobuf\" | [optional] + **spar.calculation.parameters** | [**SPARCalculationParameters**](SPARCalculationParameters.md)| | [optional] + +### Return type + +**object** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **201** | Expected response if calculation is completed within 30 seconds, returns JSON in the format specified in the Run Calculations endpoint. | * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid POST body. | * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **401** | Missing or invalid authentication. | * 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-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | One or more calculation settings were unavailable. | * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **429** | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. | * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-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-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + diff --git a/auto-generated-sdk/docs/SPARDateParameters.md b/auto-generated-sdk/docs/SPARDateParameters.md index d13023f..4fb032e 100644 --- a/auto-generated-sdk/docs/SPARDateParameters.md +++ b/auto-generated-sdk/docs/SPARDateParameters.md @@ -1,5 +1,6 @@ # factset.analyticsapi.engines::SPARDateParameters +The date parameters for SPAR calculation. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/auto-generated-sdk/docs/SPARIdentifier.md b/auto-generated-sdk/docs/SPARIdentifier.md index 2373021..0fdcffe 100644 --- a/auto-generated-sdk/docs/SPARIdentifier.md +++ b/auto-generated-sdk/docs/SPARIdentifier.md @@ -1,5 +1,6 @@ # factset.analyticsapi.engines::SPARIdentifier +The account/benchmark parameter for SPAR calculation. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/auto-generated-sdk/docs/StrategyDocumentsApi.md b/auto-generated-sdk/docs/StrategyDocumentsApi.md new file mode 100644 index 0000000..cb58fbb --- /dev/null +++ b/auto-generated-sdk/docs/StrategyDocumentsApi.md @@ -0,0 +1,348 @@ +# StrategyDocumentsApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**GetAxiomaEquityStrategyDocuments**](StrategyDocumentsApi.md#GetAxiomaEquityStrategyDocuments) | **GET** /analytics/engines/axp/v1/strategies/{path} | Get Axioma Equity strategy documents and sub-directories in a directory +[**GetAxiomaFIStrategyDocuments**](StrategyDocumentsApi.md#GetAxiomaFIStrategyDocuments) | **GET** /analytics/engines/afi/v1/strategies/{path} | Get Axioma FI strategy documents and sub-directories in a directory +[**GetBarraStrategyDocuments**](StrategyDocumentsApi.md#GetBarraStrategyDocuments) | **GET** /analytics/engines/bpm/v1/strategies/{path} | Get Barra strategy documents and sub-directories in a directory +[**GetFPOStrategyDocuments**](StrategyDocumentsApi.md#GetFPOStrategyDocuments) | **GET** /analytics/engines/fpo/v1/strategies/{path} | Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory +[**GetNorthfieldStrategyDocuments**](StrategyDocumentsApi.md#GetNorthfieldStrategyDocuments) | **GET** /analytics/engines/npo/v1/strategies/{path} | Get Northfield strategy documents and sub-directories in a directory + + +# **GetAxiomaEquityStrategyDocuments** +> DocumentDirectories GetAxiomaEquityStrategyDocuments(path) + +Get Axioma Equity strategy documents and sub-directories in a directory + +This endpoint looks up all Axioma Equity strategy documents and sub-directories in a given directory. + +### Example +```R +library(factset.analyticsapi.engines) + +var.path <- '' # character | The directory to get the strategy documents and sub-directories in + +#Get Axioma Equity strategy documents and sub-directories in a directory +api.instance <- StrategyDocumentsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$GetAxiomaEquityStrategyDocuments(var.path), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **path** | **character**| The directory to get the strategy documents and sub-directories in | [default to ''] + +### Return type + +[**DocumentDirectories**](DocumentDirectories.md) + +### Authorization + +[Basic](../README.md#Basic) + +### 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 Axioma Equity strategy documents and directories | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid query parameter or value provided | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Path 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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 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.
| + +# **GetAxiomaFIStrategyDocuments** +> DocumentDirectories GetAxiomaFIStrategyDocuments(path) + +Get Axioma FI strategy documents and sub-directories in a directory + +This endpoint looks up all Axioma FI strategy documents and sub-directories in a given directory. + +### Example +```R +library(factset.analyticsapi.engines) + +var.path <- '' # character | The directory to get the strategy documents and sub-directories in + +#Get Axioma FI strategy documents and sub-directories in a directory +api.instance <- StrategyDocumentsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$GetAxiomaFIStrategyDocuments(var.path), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **path** | **character**| The directory to get the strategy documents and sub-directories in | [default to ''] + +### Return type + +[**DocumentDirectories**](DocumentDirectories.md) + +### Authorization + +[Basic](../README.md#Basic) + +### 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 Axioma FI strategy documents and directories | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid query parameter or value provided | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Path 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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 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.
| + +# **GetBarraStrategyDocuments** +> DocumentDirectories GetBarraStrategyDocuments(path) + +Get Barra strategy documents and sub-directories in a directory + +This endpoint looks up all Barra strategy documents and sub-directories in a given directory. + +### Example +```R +library(factset.analyticsapi.engines) + +var.path <- '' # character | The directory to get the strategy documents and sub-directories in + +#Get Barra strategy documents and sub-directories in a directory +api.instance <- StrategyDocumentsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$GetBarraStrategyDocuments(var.path), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **path** | **character**| The directory to get the strategy documents and sub-directories in | [default to ''] + +### Return type + +[**DocumentDirectories**](DocumentDirectories.md) + +### Authorization + +[Basic](../README.md#Basic) + +### 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 Barra strategy documents and directories | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid query parameter or value provided | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Path 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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 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.
| + +# **GetFPOStrategyDocuments** +> DocumentDirectories GetFPOStrategyDocuments(path) + +Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory + +This endpoint looks up all FactSet Portfolio Optimizer strategy documents and sub-directories in a given directory. + +### Example +```R +library(factset.analyticsapi.engines) + +var.path <- '' # character | The directory to get the strategy documents and sub-directories in + +#Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory +api.instance <- StrategyDocumentsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$GetFPOStrategyDocuments(var.path), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **path** | **character**| The directory to get the strategy documents and sub-directories in | [default to ''] + +### Return type + +[**DocumentDirectories**](DocumentDirectories.md) + +### Authorization + +[Basic](../README.md#Basic) + +### 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 FactSet Portfolio Optimizer strategy documents and directories | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid query parameter or value provided | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Path 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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 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.
| + +# **GetNorthfieldStrategyDocuments** +> DocumentDirectories GetNorthfieldStrategyDocuments(path) + +Get Northfield strategy documents and sub-directories in a directory + +This endpoint looks up all Northfield strategy documents and sub-directories in a given directory. + +### Example +```R +library(factset.analyticsapi.engines) + +var.path <- '' # character | The directory to get the strategy documents and sub-directories in + +#Get Northfield strategy documents and sub-directories in a directory +api.instance <- StrategyDocumentsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$GetNorthfieldStrategyDocuments(var.path), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **path** | **character**| The directory to get the strategy documents and sub-directories in | [default to ''] + +### Return type + +[**DocumentDirectories**](DocumentDirectories.md) + +### Authorization + +[Basic](../README.md#Basic) + +### 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 Northfield strategy documents and directories | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid query parameter or value provided | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Path 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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 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.
| + diff --git a/auto-generated-sdk/docs/VaultCalculationParameters.md b/auto-generated-sdk/docs/VaultCalculationParameters.md index aee5a1b..32b5763 100644 --- a/auto-generated-sdk/docs/VaultCalculationParameters.md +++ b/auto-generated-sdk/docs/VaultCalculationParameters.md @@ -7,5 +7,6 @@ Name | Type | Description | Notes **account** | [**VaultIdentifier**](VaultIdentifier.md) | | **dates** | [**VaultDateParameters**](VaultDateParameters.md) | | [optional] **configid** | **character** | Vault Configuration identifier. | +**componentdetail** | **character** | Component detail type for the Vault component. It can be GROUPS or TOTALS. | [optional] diff --git a/auto-generated-sdk/docs/VaultCalculationsApi.md b/auto-generated-sdk/docs/VaultCalculationsApi.md new file mode 100644 index 0000000..bc404a6 --- /dev/null +++ b/auto-generated-sdk/docs/VaultCalculationsApi.md @@ -0,0 +1,212 @@ +# VaultCalculationsApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CancelVaultCalculationById**](VaultCalculationsApi.md#CancelVaultCalculationById) | **DELETE** /analytics/engines/vault/v2/calculations/{id} | Cancel Vault calculation by id +[**GetVaultCalculationById**](VaultCalculationsApi.md#GetVaultCalculationById) | **GET** /analytics/engines/vault/v2/calculations/{id} | Get Vault calculation by id +[**RunVaultCalculation**](VaultCalculationsApi.md#RunVaultCalculation) | **POST** /analytics/engines/vault/v2/calculations | Run Vault Calculation + + +# **CancelVaultCalculationById** +> CancelVaultCalculationById(id) + +Cancel Vault calculation by id + +This is the endpoint to cancel a previously submitted calculation. Instead of doing a GET on the polling URL, cancel the request by doing a DELETE. + +### Example +```R +library(factset.analyticsapi.engines) + +var.id <- 'id_example' # character | from url, provided from the location header in the Run Calculation endpoint + +#Cancel Vault calculation by id +api.instance <- VaultCalculationsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$CancelVaultCalculationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **character**| from url, provided from the location header in the Run Calculation endpoint | + +### Return type + +void (empty response body) + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | Expected response, calculation was canceled 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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | There was no request for the calculation identifier provided, or the request was already canceled for the provided identifier. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +# **GetVaultCalculationById** +> object GetVaultCalculationById(id) + +Get Vault calculation by id + +This is the endpoint to check on the progress of a previously requested calculation. If the calculation has finished computing, the body of the response will contain the requested document in JSON. + +### Example +```R +library(factset.analyticsapi.engines) + +var.id <- 'id_example' # character | from url, provided from the location header in the Run Calculation endpoint + +#Get Vault calculation by id +api.instance <- VaultCalculationsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$GetVaultCalculationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **character**| from url, provided from the location header in the Run Calculation endpoint | + +### Return type + +**object** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **202** | Expected response returned if the calculation is not yet completed. | * Cache-Control - Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **200** | Expected response once calculation is completed, returns JSON in the format specified in the Run Calculations endpoint. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +# **RunVaultCalculation** +> object RunVaultCalculation(x.factset.content.organization=var.x.factset.content.organization, x.factset.content.type=var.x.factset.content.type, vault.calculation.parameters=var.vault.calculation.parameters) + +Run Vault Calculation + +This endpoint runs the Vault calculation specified in the POST body parameters. It must be used first before polling or cancelling endpoints. A successful response will contain the URL to poll for the result of the calculation. Remarks: * Start and and end date must be within the configuration's min and max date range + +### Example +```R +library(factset.analyticsapi.engines) + +var.x.factset.content.organization <- 'x.factset.content.organization_example' # character | For specifying the format of the calculation result. Accepted values are \"column\" or \"row\" or \"simplifiedrow\" +var.x.factset.content.type <- 'x.factset.content.type_example' # character | For specifying the content type of the calculation result. Accepted values are either \"application/json\" or \"application/x-protobuf\" +var.vault.calculation.parameters <- VaultCalculationParameters$new("componentid_example", VaultIdentifier$new("id_example"), VaultDateParameters$new("startdate_example", "enddate_example", "frequency_example"), "configid_example", "componentdetail_example") # VaultCalculationParameters | + +#Run Vault Calculation +api.instance <- VaultCalculationsApi$new() +# Configure HTTP basic authorization: Basic +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +result <- tryCatch( + api.instance$RunVaultCalculation(x.factset.content.organization=var.x.factset.content.organization, x.factset.content.type=var.x.factset.content.type, vault.calculation.parameters=var.vault.calculation.parameters), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **x.factset.content.organization** | **character**| For specifying the format of the calculation result. Accepted values are \"column\" or \"row\" or \"simplifiedrow\" | [optional] + **x.factset.content.type** | **character**| For specifying the content type of the calculation result. Accepted values are either \"application/json\" or \"application/x-protobuf\" | [optional] + **vault.calculation.parameters** | [**VaultCalculationParameters**](VaultCalculationParameters.md)| | [optional] + +### Return type + +**object** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation
* Cache-Control - Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **201** | Expected response if calculation is completed within 30 seconds, returns JSON in the format specified in the Run Calculations endpoint. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **400** | Invalid POST body. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-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-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +| **429** | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-RateLimit-Limit - Number of allowed requests for the time window.
* X-RateLimit-Remaining - Number of requests left for the time window.
* X-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +| **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/VaultDateParameters.md b/auto-generated-sdk/docs/VaultDateParameters.md index e65f20f..beffe33 100644 --- a/auto-generated-sdk/docs/VaultDateParameters.md +++ b/auto-generated-sdk/docs/VaultDateParameters.md @@ -1,5 +1,6 @@ # factset.analyticsapi.engines::VaultDateParameters +The date parameters for Vault calculation ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/auto-generated-sdk/docs/VaultIdentifier.md b/auto-generated-sdk/docs/VaultIdentifier.md index d803882..e4df496 100644 --- a/auto-generated-sdk/docs/VaultIdentifier.md +++ b/auto-generated-sdk/docs/VaultIdentifier.md @@ -1,5 +1,6 @@ # factset.analyticsapi.engines::VaultIdentifier +The account/benchmark parameter for Vault calculation. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/auto-generated-sdk/man/AccountsApi.Rd b/auto-generated-sdk/man/AccountsApi.Rd index 907f939..bb9fc70 100644 --- a/auto-generated-sdk/man/AccountsApi.Rd +++ b/auto-generated-sdk/man/AccountsApi.Rd @@ -28,11 +28,11 @@ This endpoint looks up all ACCT and ACTM files and sub-directories in a given di \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 400 | Invalid query parameter or value provided @@ -40,11 +40,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication @@ -52,11 +52,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials @@ -64,11 +61,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 404 | Path not found @@ -76,11 +73,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json @@ -88,11 +85,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting @@ -100,11 +107,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in some time @@ -112,11 +116,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } @@ -128,7 +129,7 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr #################### GetAccounts #################### library(factset.analyticsapi.engines) -var.path <- 'path_example' # character | The directory to get the accounts and sub-directories in +var.path <- '' # character | The directory to get the accounts and sub-directories in #Get accounts and sub-directories in a directory api.instance <- AccountsApi$new() diff --git a/auto-generated-sdk/man/AxiomaEquityOptimizationParameters.Rd b/auto-generated-sdk/man/AxiomaEquityOptimizationParameters.Rd new file mode 100644 index 0000000..a3887f4 --- /dev/null +++ b/auto-generated-sdk/man/AxiomaEquityOptimizationParameters.Rd @@ -0,0 +1,109 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/axioma_equity_optimization_parameters.R +\docType{class} +\name{AxiomaEquityOptimizationParameters} +\alias{AxiomaEquityOptimizationParameters} +\title{AxiomaEquityOptimizationParameters} +\format{ +An \code{R6Class} generator object +} +\description{ +AxiomaEquityOptimizationParameters Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{strategy}}{\link{OptimizerStrategy}} + +\item{\code{account}}{\link{OptimizerAccount} [optional]} + +\item{\code{optimization}}{\link{Optimization} [optional]} + +\item{\code{outputtypes}}{\link{OptimizerOutputTypes}} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{AxiomaEquityOptimizationParameters$new()}} +\item \href{#method-toJSON}{\code{AxiomaEquityOptimizationParameters$toJSON()}} +\item \href{#method-fromJSON}{\code{AxiomaEquityOptimizationParameters$fromJSON()}} +\item \href{#method-toJSONString}{\code{AxiomaEquityOptimizationParameters$toJSONString()}} +\item \href{#method-fromJSONString}{\code{AxiomaEquityOptimizationParameters$fromJSONString()}} +\item \href{#method-clone}{\code{AxiomaEquityOptimizationParameters$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{AxiomaEquityOptimizationParameters$new( + strategy, + outputtypes, + account = NULL, + optimization = NULL, + ... +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{AxiomaEquityOptimizationParameters$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{AxiomaEquityOptimizationParameters$fromJSON( + AxiomaEquityOptimizationParametersJson +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{AxiomaEquityOptimizationParameters$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{AxiomaEquityOptimizationParameters$fromJSONString( + AxiomaEquityOptimizationParametersJson +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{AxiomaEquityOptimizationParameters$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/Calculation.Rd b/auto-generated-sdk/man/Calculation.Rd index e2d9f53..7fbca56 100644 --- a/auto-generated-sdk/man/Calculation.Rd +++ b/auto-generated-sdk/man/Calculation.Rd @@ -18,6 +18,8 @@ Calculation Class \item{\code{spar}}{named list( \link{SPARCalculationParameters} ) [optional]} \item{\code{vault}}{named list( \link{VaultCalculationParameters} ) [optional]} + +\item{\code{pub}}{named list( \link{PubCalculationParameters} ) [optional]} } \if{html}{\out{}} } @@ -37,7 +39,7 @@ Calculation Class \if{latex}{\out{\hypertarget{method-new}{}}} \subsection{Method \code{new()}}{ \subsection{Usage}{ -\if{html}{\out{
}}\preformatted{Calculation$new(pa = NULL, spar = NULL, vault = NULL, ...)}\if{html}{\out{
}} +\if{html}{\out{
}}\preformatted{Calculation$new(pa = NULL, spar = NULL, vault = NULL, pub = NULL, ...)}\if{html}{\out{
}} } } diff --git a/auto-generated-sdk/man/CalculationStatus.Rd b/auto-generated-sdk/man/CalculationStatus.Rd index 59f231b..b7ed4a1 100644 --- a/auto-generated-sdk/man/CalculationStatus.Rd +++ b/auto-generated-sdk/man/CalculationStatus.Rd @@ -15,13 +15,15 @@ CalculationStatus Class \describe{ \item{\code{status}}{character [optional]} -\item{\code{points}}{integer [optional]} +\item{\code{units}}{integer [optional]} \item{\code{pa}}{named list( \link{CalculationUnitStatus} ) [optional]} \item{\code{spar}}{named list( \link{CalculationUnitStatus} ) [optional]} \item{\code{vault}}{named list( \link{CalculationUnitStatus} ) [optional]} + +\item{\code{pub}}{named list( \link{CalculationUnitStatus} ) [optional]} } \if{html}{\out{}} } @@ -43,10 +45,11 @@ CalculationStatus Class \subsection{Usage}{ \if{html}{\out{
}}\preformatted{CalculationStatus$new( status = NULL, - points = NULL, + units = NULL, pa = NULL, spar = NULL, vault = NULL, + pub = NULL, ... )}\if{html}{\out{
}} } diff --git a/auto-generated-sdk/man/CalculationStatusSummary.Rd b/auto-generated-sdk/man/CalculationStatusSummary.Rd index 3af758e..9142acf 100644 --- a/auto-generated-sdk/man/CalculationStatusSummary.Rd +++ b/auto-generated-sdk/man/CalculationStatusSummary.Rd @@ -15,7 +15,7 @@ CalculationStatusSummary Class \describe{ \item{\code{status}}{character [optional]} -\item{\code{points}}{integer [optional]} +\item{\code{units}}{integer [optional]} \item{\code{requestTime}}{character [optional]} @@ -41,7 +41,7 @@ CalculationStatusSummary Class \subsection{Usage}{ \if{html}{\out{
}}\preformatted{CalculationStatusSummary$new( status = NULL, - points = NULL, + units = NULL, requestTime = NULL, lastPollTime = NULL, ... diff --git a/auto-generated-sdk/man/CalculationUnitStatus.Rd b/auto-generated-sdk/man/CalculationUnitStatus.Rd index 9df41d7..ed01766 100644 --- a/auto-generated-sdk/man/CalculationUnitStatus.Rd +++ b/auto-generated-sdk/man/CalculationUnitStatus.Rd @@ -15,11 +15,11 @@ CalculationUnitStatus Class \describe{ \item{\code{status}}{character [optional]} -\item{\code{points}}{integer [optional]} - \item{\code{error}}{character [optional]} \item{\code{result}}{character [optional]} + +\item{\code{progress}}{character [optional]} } \if{html}{\out{
}} } @@ -41,9 +41,9 @@ CalculationUnitStatus Class \subsection{Usage}{ \if{html}{\out{
}}\preformatted{CalculationUnitStatus$new( status = NULL, - points = NULL, error = NULL, result = NULL, + progress = NULL, ... )}\if{html}{\out{
}} } diff --git a/auto-generated-sdk/man/CalculationsApi.Rd b/auto-generated-sdk/man/CalculationsApi.Rd index 057c70f..48d50a0 100644 --- a/auto-generated-sdk/man/CalculationsApi.Rd +++ b/auto-generated-sdk/man/CalculationsApi.Rd @@ -27,11 +27,11 @@ This is the endpoint to cancel a previously submitted calculation request. Inst \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 400 | Invalid identifier provided. @@ -39,11 +39,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication. @@ -51,11 +51,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials. @@ -63,11 +60,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 404 | There was no request for the identifier provided, or the request was already canceled for the provided identifier. @@ -75,11 +72,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. @@ -87,11 +94,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in sometime. @@ -99,11 +103,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } @@ -122,12 +123,12 @@ This is the endpoint to check on the progress of a previous calculation request. \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 400 | Invalid identifier provided. @@ -135,12 +136,12 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication. @@ -148,12 +149,9 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials. @@ -161,12 +159,12 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 404 | Provided identifier was not a request, or the request was cancelled. @@ -174,12 +172,12 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. @@ -187,12 +185,23 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ +Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. @@ -200,12 +209,9 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in sometime. @@ -213,12 +219,9 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } @@ -236,11 +239,11 @@ This endpoints returns all active calculation requests. \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication. @@ -248,11 +251,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials. @@ -260,11 +260,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. @@ -272,11 +272,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. @@ -284,11 +294,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in sometime. @@ -296,18 +303,17 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } \strong{ RunCalculation } \emph{ Run calculation } -This endpoint creates a new calculation and runs the set of calculation units specified in the POST body. This must be used first before get status or cancelling endpoints with a calculation id. A successful response will contain the URL to check the status of the calculation request. Remarks: * Maximum 25 points allowed per calculation and maximum 500 points allowed across all simultaneous calculations. (Refer API documentation for more information) * Any settings in POST body will act as a one-time override over the settings saved in the PA/SPAR/Vault template. +This endpoint creates a new calculation and runs the set of calculation units specified in the POST body. This must be used first before get status or cancelling endpoints with a calculation id. A successful response will contain the URL to check the status of the calculation request. Remarks: * Maximum 500 units allowed across all simultaneous calculations. (Refer API documentation for more information) * Any settings in POST body will act as a one-time override over the settings saved in the PA/SPAR/Vault template. \itemize{ +\item \emph{ @param } x.factset.content.organization character +\item \emph{ @param } x.factset.content.type character \item \emph{ @param } calculation \link{Calculation} \item On encountering errors, an error of subclass ApiException will be thrown. @@ -318,14 +324,16 @@ This endpoint creates a new calculation and runs the set of calculation units sp \item response headers : \tabular{ll}{ -X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +Location \tab URL to check status of the request. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr X-FactSet-Api-Points-Remaining \tab Number of points remaining till points limit reached. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +X-FactSet-Api-Units-Limit \tab Maximum units limit across all batches. \cr +X-FactSet-Api-Units-Remaining \tab Number of units remaining till units limit reached. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -Location \tab URL to check status of the request. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 400 | Invalid POST body. @@ -333,14 +341,15 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr X-FactSet-Api-Points-Remaining \tab Number of points remaining till points limit reached. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +X-FactSet-Api-Units-Limit \tab Maximum units limit across all batches. \cr +X-FactSet-Api-Units-Remaining \tab Number of units remaining till units limit reached. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -Location \tab URL to check status of the request. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication. @@ -348,14 +357,12 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr X-FactSet-Api-Points-Remaining \tab Number of points remaining till points limit reached. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -Location \tab URL to check status of the request. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Units-Limit \tab Maximum units limit across all batches. \cr +X-FactSet-Api-Units-Remaining \tab Number of units remaining till units limit reached. \cr } \item status code : 403 | User is forbidden with current credentials. @@ -363,14 +370,15 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr X-FactSet-Api-Points-Remaining \tab Number of points remaining till points limit reached. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +X-FactSet-Api-Units-Limit \tab Maximum units limit across all batches. \cr +X-FactSet-Api-Units-Remaining \tab Number of units remaining till units limit reached. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -Location \tab URL to check status of the request. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 415 | Missing/Invalid Content-Type header. Header needs to be set to application/json. @@ -378,14 +386,15 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr X-FactSet-Api-Points-Remaining \tab Number of points remaining till points limit reached. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +X-FactSet-Api-Units-Limit \tab Maximum units limit across all batches. \cr +X-FactSet-Api-Units-Remaining \tab Number of units remaining till units limit reached. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -Location \tab URL to check status of the request. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 429 | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish / expire. @@ -393,14 +402,16 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr X-FactSet-Api-Points-Remaining \tab Number of points remaining till points limit reached. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +X-FactSet-Api-Units-Limit \tab Maximum units limit across all batches. \cr +X-FactSet-Api-Units-Remaining \tab Number of units remaining till units limit reached. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -Location \tab URL to check status of the request. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. @@ -408,14 +419,12 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr X-FactSet-Api-Points-Remaining \tab Number of points remaining till points limit reached. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -Location \tab URL to check status of the request. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Units-Limit \tab Maximum units limit across all batches. \cr +X-FactSet-Api-Units-Remaining \tab Number of units remaining till units limit reached. \cr } \item status code : 503 | Request timed out. Retry the request in sometime. @@ -423,14 +432,12 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Points-Limit \tab Maximum points limit across all batches. \cr X-FactSet-Api-Points-Remaining \tab Number of points remaining till points limit reached. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -Location \tab URL to check status of the request. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Units-Limit \tab Maximum units limit across all batches. \cr +X-FactSet-Api-Units-Remaining \tab Number of units remaining till units limit reached. \cr } } @@ -532,6 +539,8 @@ response.status.code <- result$response$status_code #################### RunCalculation #################### library(factset.analyticsapi.engines) +var.x.factset.content.organization <- 'x.factset.content.organization_example' # character | For specifying the format of the calculation result. Accepted values are \"column\" or \"row\" or \"simplifiedrow\" +var.x.factset.content.type <- 'x.factset.content.type_example' # character | For specifying the content type of the calculation result. Accepted values are either \"application/json\" or \"application/x-protobuf\" var.calculation <- Calculation$new() # Calculation | #Run calculation @@ -544,7 +553,7 @@ api.instance$apiClient$username <- ''; api.instance$apiClient$password <- ''; result <- tryCatch( - api.instance$RunCalculation(calculation=var.calculation), + api.instance$RunCalculation(x.factset.content.organization=var.x.factset.content.organization, x.factset.content.type=var.x.factset.content.type, calculation=var.calculation), ApiException = function(ex) ex ) # In case of error, print the error object @@ -650,7 +659,12 @@ response.status.code <- result$response$status_code \if{latex}{\out{\hypertarget{method-RunCalculation}{}}} \subsection{Method \code{RunCalculation()}}{ \subsection{Usage}{ -\if{html}{\out{
}}\preformatted{CalculationsApi$RunCalculation(calculation = NULL, ...)}\if{html}{\out{
}} +\if{html}{\out{
}}\preformatted{CalculationsApi$RunCalculation( + x.factset.content.organization = NULL, + x.factset.content.type = NULL, + calculation = NULL, + ... +)}\if{html}{\out{
}} } } @@ -659,7 +673,12 @@ response.status.code <- result$response$status_code \if{latex}{\out{\hypertarget{method-RunCalculationWithHttpInfo}{}}} \subsection{Method \code{RunCalculationWithHttpInfo()}}{ \subsection{Usage}{ -\if{html}{\out{
}}\preformatted{CalculationsApi$RunCalculationWithHttpInfo(calculation = NULL, ...)}\if{html}{\out{
}} +\if{html}{\out{
}}\preformatted{CalculationsApi$RunCalculationWithHttpInfo( + x.factset.content.organization = NULL, + x.factset.content.type = NULL, + calculation = NULL, + ... +)}\if{html}{\out{
}} } } diff --git a/auto-generated-sdk/man/ColumnStatisticsApi.Rd b/auto-generated-sdk/man/ColumnStatisticsApi.Rd index a3cacce..7cc83de 100644 --- a/auto-generated-sdk/man/ColumnStatisticsApi.Rd +++ b/auto-generated-sdk/man/ColumnStatisticsApi.Rd @@ -27,11 +27,11 @@ This endpoint lists all the column statistics that can be applied to a PA column \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication. @@ -39,11 +39,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials @@ -51,11 +48,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. @@ -63,11 +60,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting @@ -75,11 +82,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in sometime. @@ -87,11 +91,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } diff --git a/auto-generated-sdk/man/ColumnsApi.Rd b/auto-generated-sdk/man/ColumnsApi.Rd index 5d347d6..58016e1 100644 --- a/auto-generated-sdk/man/ColumnsApi.Rd +++ b/auto-generated-sdk/man/ColumnsApi.Rd @@ -28,12 +28,12 @@ This endpoint returns the default settings of a PA column. \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr Age \tab Standard HTTP header. Header will specify the age of columns list cached response. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 400 | Invalid column Id. @@ -41,11 +41,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication. @@ -53,11 +53,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials @@ -65,11 +62,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 404 | Column not found. @@ -77,11 +74,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. @@ -89,11 +86,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. @@ -101,11 +108,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in sometime. @@ -113,11 +117,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } @@ -138,12 +139,12 @@ This endpoint lists all the PA columns that can be applied to a calculation. \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr Age \tab Standard HTTP header. Header will specify the age of columns list cached response. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication. @@ -151,11 +152,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials @@ -163,11 +161,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. @@ -175,11 +173,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting @@ -187,11 +195,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in sometime. @@ -199,11 +204,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } @@ -246,9 +248,9 @@ response.status.code <- result$response$status_code #################### GetPAColumns #################### library(factset.analyticsapi.engines) -var.name <- 'name_example' # character | -var.category <- 'category_example' # character | -var.directory <- 'directory_example' # character | +var.name <- '' # character | Column name +var.category <- '' # character | Column category +var.directory <- '' # character | The directory to get the columns in #Get PA columns api.instance <- ColumnsApi$new() @@ -328,7 +330,7 @@ response.status.code <- result$response$status_code \if{latex}{\out{\hypertarget{method-GetPAColumns}{}}} \subsection{Method \code{GetPAColumns()}}{ \subsection{Usage}{ -\if{html}{\out{
}}\preformatted{ColumnsApi$GetPAColumns(name = NULL, category = NULL, directory = NULL, ...)}\if{html}{\out{
}} +\if{html}{\out{
}}\preformatted{ColumnsApi$GetPAColumns(name = "", category = "", directory = "", ...)}\if{html}{\out{
}} } } @@ -338,9 +340,9 @@ response.status.code <- result$response$status_code \subsection{Method \code{GetPAColumnsWithHttpInfo()}}{ \subsection{Usage}{ \if{html}{\out{
}}\preformatted{ColumnsApi$GetPAColumnsWithHttpInfo( - name = NULL, - category = NULL, - directory = NULL, + name = "", + category = "", + directory = "", ... )}\if{html}{\out{
}} } diff --git a/auto-generated-sdk/man/ComponentsApi.Rd b/auto-generated-sdk/man/ComponentsApi.Rd index 83539f7..e004da0 100644 --- a/auto-generated-sdk/man/ComponentsApi.Rd +++ b/auto-generated-sdk/man/ComponentsApi.Rd @@ -28,11 +28,11 @@ This endpoint returns the default settings of a PA component. \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 400 | Invalid PA component id. @@ -40,11 +40,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication. @@ -52,11 +52,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials @@ -64,11 +61,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 404 | Component not found. @@ -76,11 +73,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. @@ -88,11 +85,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. @@ -100,11 +107,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in sometime. @@ -112,11 +116,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } @@ -135,11 +136,11 @@ This endpoint returns the list of PA components in a given PA document. \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 400 | Invalid query parameter provided or Invalid PA document name. @@ -147,11 +148,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication. @@ -159,11 +160,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials @@ -171,11 +169,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 404 | Document not found. @@ -183,11 +181,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. @@ -195,11 +193,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. @@ -207,11 +215,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in sometime. @@ -219,11 +224,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } @@ -242,11 +244,11 @@ This endpoint returns the list of SPAR components in a given SPAR document. \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 400 | Invalid query parameter provided or Invalid SPAR document name. @@ -254,11 +256,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication. @@ -266,11 +268,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials @@ -278,11 +277,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 404 | SPAR Document not found. @@ -290,11 +289,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. @@ -302,11 +301,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. @@ -314,11 +323,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in sometime. @@ -326,11 +332,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } @@ -349,11 +352,11 @@ This endpoint returns the default settings of a Vault component. \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 400 | Invalid Vault component id. @@ -361,11 +364,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication. @@ -373,11 +376,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials @@ -385,11 +385,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 404 | Vault Component not found. @@ -397,11 +397,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. @@ -409,11 +409,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. @@ -421,11 +431,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in sometime. @@ -433,11 +440,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } @@ -456,11 +460,11 @@ This endpoint returns the list of Vault components in a given Vault document. \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 400 | Invalid query parameter provided or invalid Vault document name. @@ -468,11 +472,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication. @@ -480,11 +484,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials @@ -492,11 +493,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 404 | Vault Document not found. @@ -504,11 +505,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. @@ -516,11 +517,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. @@ -528,11 +539,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in sometime. @@ -540,11 +548,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } diff --git a/auto-generated-sdk/man/ConfigurationsApi.Rd b/auto-generated-sdk/man/ConfigurationsApi.Rd index 4426ac1..f739cbe 100644 --- a/auto-generated-sdk/man/ConfigurationsApi.Rd +++ b/auto-generated-sdk/man/ConfigurationsApi.Rd @@ -28,11 +28,11 @@ This endpoint returns details for a Vault configuration as well as a list of acc \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 400 | Invalid vault configuration code. @@ -40,11 +40,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication. @@ -52,11 +52,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials @@ -64,11 +61,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 404 | Vault configuration id not found. @@ -76,11 +73,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. @@ -88,11 +85,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. @@ -100,11 +107,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in sometime. @@ -112,11 +116,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } @@ -135,11 +136,11 @@ This endpoint returns all the Vault configurations saved in the provided account \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 400 | Invalid account. @@ -147,11 +148,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication. @@ -159,11 +160,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials @@ -171,11 +169,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 404 | Account not found. @@ -183,11 +181,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. @@ -195,11 +193,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. @@ -207,11 +215,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in sometime. @@ -219,11 +224,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } diff --git a/auto-generated-sdk/man/CurrenciesApi.Rd b/auto-generated-sdk/man/CurrenciesApi.Rd index 3cb9ef5..4da8287 100644 --- a/auto-generated-sdk/man/CurrenciesApi.Rd +++ b/auto-generated-sdk/man/CurrenciesApi.Rd @@ -27,11 +27,11 @@ This endpoint lists all the PA currencies that can be applied to a calculation. \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication. @@ -39,11 +39,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials @@ -51,11 +48,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. @@ -63,11 +60,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. @@ -75,11 +82,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in sometime. @@ -87,11 +91,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } diff --git a/auto-generated-sdk/man/DatesApi.Rd b/auto-generated-sdk/man/DatesApi.Rd index ef4ff64..2c9bc6b 100644 --- a/auto-generated-sdk/man/DatesApi.Rd +++ b/auto-generated-sdk/man/DatesApi.Rd @@ -14,7 +14,7 @@ factset.analyticsapi.engines.Dates \describe{ \strong{ ConvertPADatesToAbsoluteFormat } \emph{ Convert PA dates to absolute format } -This endpoint converts the given start and end dates to yyyymmdd format for a PA calculation. +This endpoint converts the given start and end dates in FactSet date format to yyyymmdd format for a PA calculation. For more information on FactSet date format, please refer to the PA Engine API documentation under the 'API Documentation' section in the developer portal. \itemize{ \item \emph{ @param } enddate character @@ -31,11 +31,11 @@ This endpoint converts the given start and end dates to yyyymmdd format for a PA \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 400 | Invalid query parameter or value is provided. @@ -43,11 +43,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication. @@ -55,11 +55,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials @@ -67,11 +64,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 404 | Document or account not found. @@ -79,11 +76,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. @@ -91,11 +88,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. @@ -103,11 +110,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in sometime. @@ -115,16 +119,13 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } \strong{ ConvertVaultDatesToAbsoluteFormat } \emph{ Convert Vault dates to absolute format } -This endpoint converts the given start and end dates to yyyymmdd format for a Vault calculation. +This endpoint converts the given start and end dates in FactSet date format to yyyymmdd format for a Vault calculation. For more information on FactSet date format, please refer to the Vault API documentation under the 'API Documentation' section in the developer portal. \itemize{ \item \emph{ @param } enddate character @@ -141,11 +142,11 @@ This endpoint converts the given start and end dates to yyyymmdd format for a Va \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 400 | Invalid query parameter or value is provided. @@ -153,11 +154,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication. @@ -165,11 +166,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials @@ -177,11 +175,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 404 | vault Document or account not found. @@ -189,11 +187,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. @@ -201,11 +199,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. @@ -213,11 +221,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in sometime. @@ -225,11 +230,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } diff --git a/auto-generated-sdk/man/DocumentsApi.Rd b/auto-generated-sdk/man/DocumentsApi.Rd index e0d79e0..c00df3e 100644 --- a/auto-generated-sdk/man/DocumentsApi.Rd +++ b/auto-generated-sdk/man/DocumentsApi.Rd @@ -28,11 +28,11 @@ This endpoint looks up all PA3 documents and sub-directories in a given director \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 400 | Invalid query parameter or value provided @@ -40,11 +40,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication @@ -52,11 +52,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials @@ -64,11 +61,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 404 | Path not found @@ -76,11 +73,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json @@ -88,11 +85,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting @@ -100,23 +107,125 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in some time + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +\strong{ GetPubDocuments } \emph{ Gets Publisher documents and sub-directories in a directory } +This endpoint looks up all Publisher documents and sub-directories in a given directory. + +\itemize{ +\item \emph{ @param } path character +\item \emph{ @returnType } \link{DocumentDirectories} \cr + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 200 | Expected response, returns a list of Publisher documents and directories + +\item return type : DocumentDirectories +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid query parameter or value provided + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } -\item status code : 503 | Request timed out. Retry the request in some time +\item status code : 403 | User is forbidden with current credentials \item response headers : \tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | Path not found + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 406 | Unsupported Accept header. Header needs to be set to application/json + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in some time + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } @@ -135,11 +244,11 @@ This endpoint looks up all SPAR3 documents and sub-directories in a given direct \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 400 | Invalid query parameter or value provided @@ -147,11 +256,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication @@ -159,11 +268,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials @@ -171,11 +277,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 404 | Path not found @@ -183,11 +289,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json @@ -195,11 +301,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting @@ -207,11 +323,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in some time @@ -219,11 +332,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } @@ -242,11 +352,11 @@ This endpoint looks up all Vault documents and sub-directories in a given direct \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 400 | Invalid query parameter or value provided @@ -254,11 +364,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication @@ -266,11 +376,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials @@ -278,11 +385,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 404 | Path not found @@ -290,11 +397,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json @@ -302,11 +409,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting @@ -314,11 +431,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in some time @@ -326,11 +440,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } @@ -342,7 +453,7 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr #################### GetPA3Documents #################### library(factset.analyticsapi.engines) -var.path <- 'path_example' # character | The directory to get the documents and sub-directories in +var.path <- '' # character | The directory to get the documents and sub-directories in #Get PA3 documents and sub-directories in a directory api.instance <- DocumentsApi$new() @@ -370,10 +481,41 @@ response.status.code <- result$response$status_code } +#################### GetPubDocuments #################### + +library(factset.analyticsapi.engines) +var.path <- '' # character | The directory to get the documents in + +#Gets Publisher documents and sub-directories in a directory +api.instance <- DocumentsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$GetPubDocuments(var.path), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + #################### GetSPAR3Documents #################### library(factset.analyticsapi.engines) -var.path <- 'path_example' # character | The directory to get the documents in +var.path <- '' # character | The directory to get the documents in #Gets SPAR3 documents and sub-directories in a directory api.instance <- DocumentsApi$new() @@ -404,7 +546,7 @@ response.status.code <- result$response$status_code #################### GetVaultDocuments #################### library(factset.analyticsapi.engines) -var.path <- 'path_example' # character | The directory to get the documents in +var.path <- '' # character | The directory to get the documents in #Get Vault documents and sub-directories in a directory api.instance <- DocumentsApi$new() @@ -447,6 +589,8 @@ response.status.code <- result$response$status_code \item \href{#method-new}{\code{DocumentsApi$new()}} \item \href{#method-GetPA3Documents}{\code{DocumentsApi$GetPA3Documents()}} \item \href{#method-GetPA3DocumentsWithHttpInfo}{\code{DocumentsApi$GetPA3DocumentsWithHttpInfo()}} +\item \href{#method-GetPubDocuments}{\code{DocumentsApi$GetPubDocuments()}} +\item \href{#method-GetPubDocumentsWithHttpInfo}{\code{DocumentsApi$GetPubDocumentsWithHttpInfo()}} \item \href{#method-GetSPAR3Documents}{\code{DocumentsApi$GetSPAR3Documents()}} \item \href{#method-GetSPAR3DocumentsWithHttpInfo}{\code{DocumentsApi$GetSPAR3DocumentsWithHttpInfo()}} \item \href{#method-GetVaultDocuments}{\code{DocumentsApi$GetVaultDocuments()}} @@ -480,6 +624,24 @@ response.status.code <- result$response$status_code \if{html}{\out{
}}\preformatted{DocumentsApi$GetPA3DocumentsWithHttpInfo(path, ...)}\if{html}{\out{
}} } +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetPubDocuments}{}}} +\subsection{Method \code{GetPubDocuments()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{DocumentsApi$GetPubDocuments(path, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetPubDocumentsWithHttpInfo}{}}} +\subsection{Method \code{GetPubDocumentsWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{DocumentsApi$GetPubDocumentsWithHttpInfo(path, ...)}\if{html}{\out{
}} +} + } \if{html}{\out{
}} \if{html}{\out{}} diff --git a/auto-generated-sdk/man/EventSummary.Rd b/auto-generated-sdk/man/EventSummary.Rd new file mode 100644 index 0000000..157065a --- /dev/null +++ b/auto-generated-sdk/man/EventSummary.Rd @@ -0,0 +1,97 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/event_summary.R +\docType{class} +\name{EventSummary} +\alias{EventSummary} +\title{EventSummary} +\format{ +An \code{R6Class} generator object +} +\description{ +EventSummary Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{message}}{character [optional]} + +\item{\code{submissiondatetime}}{character [optional]} + +\item{\code{type}}{character [optional]} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{EventSummary$new()}} +\item \href{#method-toJSON}{\code{EventSummary$toJSON()}} +\item \href{#method-fromJSON}{\code{EventSummary$fromJSON()}} +\item \href{#method-toJSONString}{\code{EventSummary$toJSONString()}} +\item \href{#method-fromJSONString}{\code{EventSummary$fromJSONString()}} +\item \href{#method-clone}{\code{EventSummary$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{EventSummary$new(message = NULL, submissiondatetime = NULL, type = NULL, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{EventSummary$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{EventSummary$fromJSON(EventSummaryJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{EventSummary$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{EventSummary$fromJSONString(EventSummaryJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{EventSummary$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/FIABCalculationParameters.Rd b/auto-generated-sdk/man/FIABCalculationParameters.Rd new file mode 100644 index 0000000..5ca7edd --- /dev/null +++ b/auto-generated-sdk/man/FIABCalculationParameters.Rd @@ -0,0 +1,108 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/fiab_calculation_parameters.R +\docType{class} +\name{FIABCalculationParameters} +\alias{FIABCalculationParameters} +\title{FIABCalculationParameters} +\format{ +An \code{R6Class} generator object +} +\description{ +FIABCalculationParameters Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{fiabdocument}}{character [optional]} + +\item{\code{account}}{\link{FIABIdentifier}} + +\item{\code{dates}}{\link{FIABDateParameters}} + +\item{\code{msl}}{character [optional]} + +\item{\code{fisettingsdocument}}{character [optional]} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{FIABCalculationParameters$new()}} +\item \href{#method-toJSON}{\code{FIABCalculationParameters$toJSON()}} +\item \href{#method-fromJSON}{\code{FIABCalculationParameters$fromJSON()}} +\item \href{#method-toJSONString}{\code{FIABCalculationParameters$toJSONString()}} +\item \href{#method-fromJSONString}{\code{FIABCalculationParameters$fromJSONString()}} +\item \href{#method-clone}{\code{FIABCalculationParameters$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationParameters$new( + account, + dates, + fiabdocument = NULL, + msl = NULL, + fisettingsdocument = NULL, + ... +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationParameters$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationParameters$fromJSON(FIABCalculationParametersJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationParameters$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationParameters$fromJSONString(FIABCalculationParametersJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationParameters$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/FIABCalculationStatus.Rd b/auto-generated-sdk/man/FIABCalculationStatus.Rd new file mode 100644 index 0000000..1cb9423 --- /dev/null +++ b/auto-generated-sdk/man/FIABCalculationStatus.Rd @@ -0,0 +1,111 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/fiab_calculation_status.R +\docType{class} +\name{FIABCalculationStatus} +\alias{FIABCalculationStatus} +\title{FIABCalculationStatus} +\format{ +An \code{R6Class} generator object +} +\description{ +FIABCalculationStatus Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{id}}{character [optional]} + +\item{\code{status}}{character [optional]} + +\item{\code{startdatetime}}{character [optional]} + +\item{\code{completiondatetime}}{character [optional]} + +\item{\code{progress}}{integer [optional]} + +\item{\code{batchevents}}{list( \link{EventSummary} ) [optional]} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{FIABCalculationStatus$new()}} +\item \href{#method-toJSON}{\code{FIABCalculationStatus$toJSON()}} +\item \href{#method-fromJSON}{\code{FIABCalculationStatus$fromJSON()}} +\item \href{#method-toJSONString}{\code{FIABCalculationStatus$toJSONString()}} +\item \href{#method-fromJSONString}{\code{FIABCalculationStatus$fromJSONString()}} +\item \href{#method-clone}{\code{FIABCalculationStatus$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationStatus$new( + id = NULL, + status = NULL, + startdatetime = NULL, + completiondatetime = NULL, + progress = NULL, + batchevents = NULL, + ... +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationStatus$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationStatus$fromJSON(FIABCalculationStatusJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationStatus$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationStatus$fromJSONString(FIABCalculationStatusJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationStatus$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/FIABCalculationStatusSummary.Rd b/auto-generated-sdk/man/FIABCalculationStatusSummary.Rd new file mode 100644 index 0000000..4810f3c --- /dev/null +++ b/auto-generated-sdk/man/FIABCalculationStatusSummary.Rd @@ -0,0 +1,95 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/fiab_calculation_status_summary.R +\docType{class} +\name{FIABCalculationStatusSummary} +\alias{FIABCalculationStatusSummary} +\title{FIABCalculationStatusSummary} +\format{ +An \code{R6Class} generator object +} +\description{ +FIABCalculationStatusSummary Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{requesttime}}{character [optional]} + +\item{\code{lastpolltime}}{character [optional]} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{FIABCalculationStatusSummary$new()}} +\item \href{#method-toJSON}{\code{FIABCalculationStatusSummary$toJSON()}} +\item \href{#method-fromJSON}{\code{FIABCalculationStatusSummary$fromJSON()}} +\item \href{#method-toJSONString}{\code{FIABCalculationStatusSummary$toJSONString()}} +\item \href{#method-fromJSONString}{\code{FIABCalculationStatusSummary$fromJSONString()}} +\item \href{#method-clone}{\code{FIABCalculationStatusSummary$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationStatusSummary$new(requesttime = NULL, lastpolltime = NULL, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationStatusSummary$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationStatusSummary$fromJSON(FIABCalculationStatusSummaryJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationStatusSummary$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationStatusSummary$fromJSONString(FIABCalculationStatusSummaryJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationStatusSummary$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/FIABCalculationsApi.Rd b/auto-generated-sdk/man/FIABCalculationsApi.Rd new file mode 100644 index 0000000..b66f5a1 --- /dev/null +++ b/auto-generated-sdk/man/FIABCalculationsApi.Rd @@ -0,0 +1,523 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/fiab_calculations_api.R +\docType{class} +\name{FIABCalculationsApi} +\alias{FIABCalculationsApi} +\title{FIABCalculations operations} +\format{ +An \code{R6Class} generator object +} +\description{ +factset.analyticsapi.engines.FIABCalculations +} +\section{Methods}{ + +\describe{ +\strong{ GetFIABCalculationById } \emph{ Get FIAB calculation by id } +This is the endpoint to check on the progress of a previously requested calculation. + +\itemize{ +\item \emph{ @param } id character +\item \emph{ @returnType } \link{FIABCalculationStatus} \cr + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 200 | Expected response, returns status information of the entire calculation if it is complete. + +\item return type : FIABCalculationStatus +\item response headers : + +\tabular{ll}{ +Content-Encoding \tab Standard HTTP header. Header value based on Accept-Encoding Request header. \cr +Content-Type \tab Standard HTTP header. \cr +Transfer-Encoding \tab Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 202 | Expected response, returns status information of the entire calculation if it is not complete. + +\item return type : FIABCalculationStatus +\item response headers : + +\tabular{ll}{ +Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid identifier provided. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in sometime. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +\strong{ GetFIABCalculationStatusSummaries } \emph{ Get all FIAB calculation summaries } +This endpoints returns all FIAB calculation requests. + +\itemize{ +\item \emph{ @returnType } named list( \link{FIABCalculationStatusSummary} ) \cr + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 200 | List of active FIAB calculation requests. + +\item return type : map(FIABCalculationStatusSummary) +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in sometime. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +\strong{ RunFIABCalculation } \emph{ Run FIAB calculation } +This endpoint creates a new FIAB calculation. This must be used first before get status or cancelling endpoints with a calculation id. A successful response will contain the URL to check the status of the calculation request. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the FIAB template. + +\itemize{ +\item \emph{ @param } fiab.calculation.parameters \link{FIABCalculationParameters} + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 202 | Expected response, contains the URL in the Location header to check the status of the calculation. + + +\item response headers : + +\tabular{ll}{ +Location \tab URL to check status of the request. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Calculations-Limit \tab Maximum FIAB request limit. \cr +X-FactSet-Api-Calculations-Remaining \tab Number of FIAB requests remaining till request limit reached. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid POST body. + + +\item response headers : + +\tabular{ll}{ +Location \tab URL to check status of the request. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Calculations-Limit \tab Maximum FIAB request limit. \cr +X-FactSet-Api-Calculations-Remaining \tab Number of FIAB requests remaining till request limit reached. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication. + + +\item response headers : + +\tabular{ll}{ +Location \tab URL to check status of the request. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Calculations-Limit \tab Maximum FIAB request limit. \cr +X-FactSet-Api-Calculations-Remaining \tab Number of FIAB requests remaining till request limit reached. \cr +} +\item status code : 403 | User is forbidden with current credentials. + + +\item response headers : + +\tabular{ll}{ +Location \tab URL to check status of the request. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Calculations-Limit \tab Maximum FIAB request limit. \cr +X-FactSet-Api-Calculations-Remaining \tab Number of FIAB requests remaining till request limit reached. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 415 | Missing/Invalid Content-Type header. Header needs to be set to application/json. + + +\item response headers : + +\tabular{ll}{ +Location \tab URL to check status of the request. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Calculations-Limit \tab Maximum FIAB request limit. \cr +X-FactSet-Api-Calculations-Remaining \tab Number of FIAB requests remaining till request limit reached. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Cancel older requests using Cancel FIAB Calculation endpoint or wait for older requests to finish / expire. + + +\item response headers : + +\tabular{ll}{ +Location \tab URL to check status of the request. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Calculations-Limit \tab Maximum FIAB request limit. \cr +X-FactSet-Api-Calculations-Remaining \tab Number of FIAB requests remaining till request limit reached. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. + + +\item response headers : + +\tabular{ll}{ +Location \tab URL to check status of the request. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Calculations-Limit \tab Maximum FIAB request limit. \cr +X-FactSet-Api-Calculations-Remaining \tab Number of FIAB requests remaining till request limit reached. \cr +} +\item status code : 503 | Request timed out. Retry the request in sometime. + + +\item response headers : + +\tabular{ll}{ +Location \tab URL to check status of the request. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Calculations-Limit \tab Maximum FIAB request limit. \cr +X-FactSet-Api-Calculations-Remaining \tab Number of FIAB requests remaining till request limit reached. \cr +} +} + +} +} + +\examples{ +\dontrun{ +#################### GetFIABCalculationById #################### + +library(factset.analyticsapi.engines) +var.id <- 'id_example' # character | from url, provided from the location header in the Run FIAB Calculation endpoint + +#Get FIAB calculation by id +api.instance <- FIABCalculationsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$GetFIABCalculationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +#################### GetFIABCalculationStatusSummaries #################### + +library(factset.analyticsapi.engines) + +#Get all FIAB calculation summaries +api.instance <- FIABCalculationsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$GetFIABCalculationStatusSummaries(), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +#################### RunFIABCalculation #################### + +library(factset.analyticsapi.engines) +var.fiab.calculation.parameters <- FIABCalculationParameters$new() # FIABCalculationParameters | + +#Run FIAB calculation +api.instance <- FIABCalculationsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$RunFIABCalculation(fiab.calculation.parameters=var.fiab.calculation.parameters), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +} +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{apiClient}}{Handles the client-server communication.} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{FIABCalculationsApi$new()}} +\item \href{#method-GetFIABCalculationById}{\code{FIABCalculationsApi$GetFIABCalculationById()}} +\item \href{#method-GetFIABCalculationByIdWithHttpInfo}{\code{FIABCalculationsApi$GetFIABCalculationByIdWithHttpInfo()}} +\item \href{#method-GetFIABCalculationStatusSummaries}{\code{FIABCalculationsApi$GetFIABCalculationStatusSummaries()}} +\item \href{#method-GetFIABCalculationStatusSummariesWithHttpInfo}{\code{FIABCalculationsApi$GetFIABCalculationStatusSummariesWithHttpInfo()}} +\item \href{#method-RunFIABCalculation}{\code{FIABCalculationsApi$RunFIABCalculation()}} +\item \href{#method-RunFIABCalculationWithHttpInfo}{\code{FIABCalculationsApi$RunFIABCalculationWithHttpInfo()}} +\item \href{#method-clone}{\code{FIABCalculationsApi$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationsApi$new(apiClient)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetFIABCalculationById}{}}} +\subsection{Method \code{GetFIABCalculationById()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationsApi$GetFIABCalculationById(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetFIABCalculationByIdWithHttpInfo}{}}} +\subsection{Method \code{GetFIABCalculationByIdWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationsApi$GetFIABCalculationByIdWithHttpInfo(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetFIABCalculationStatusSummaries}{}}} +\subsection{Method \code{GetFIABCalculationStatusSummaries()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationsApi$GetFIABCalculationStatusSummaries(...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetFIABCalculationStatusSummariesWithHttpInfo}{}}} +\subsection{Method \code{GetFIABCalculationStatusSummariesWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationsApi$GetFIABCalculationStatusSummariesWithHttpInfo(...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-RunFIABCalculation}{}}} +\subsection{Method \code{RunFIABCalculation()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationsApi$RunFIABCalculation(fiab.calculation.parameters = NULL, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-RunFIABCalculationWithHttpInfo}{}}} +\subsection{Method \code{RunFIABCalculationWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationsApi$RunFIABCalculationWithHttpInfo( + fiab.calculation.parameters = NULL, + ... +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABCalculationsApi$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/FIABDateParameters.Rd b/auto-generated-sdk/man/FIABDateParameters.Rd new file mode 100644 index 0000000..def8683 --- /dev/null +++ b/auto-generated-sdk/man/FIABDateParameters.Rd @@ -0,0 +1,95 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/fiab_date_parameters.R +\docType{class} +\name{FIABDateParameters} +\alias{FIABDateParameters} +\title{FIABDateParameters} +\format{ +An \code{R6Class} generator object +} +\description{ +FIABDateParameters Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{startdate}}{character} + +\item{\code{enddate}}{character} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{FIABDateParameters$new()}} +\item \href{#method-toJSON}{\code{FIABDateParameters$toJSON()}} +\item \href{#method-fromJSON}{\code{FIABDateParameters$fromJSON()}} +\item \href{#method-toJSONString}{\code{FIABDateParameters$toJSONString()}} +\item \href{#method-fromJSONString}{\code{FIABDateParameters$fromJSONString()}} +\item \href{#method-clone}{\code{FIABDateParameters$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABDateParameters$new(startdate, enddate, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABDateParameters$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABDateParameters$fromJSON(FIABDateParametersJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABDateParameters$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABDateParameters$fromJSONString(FIABDateParametersJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABDateParameters$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/FIABIdentifier.Rd b/auto-generated-sdk/man/FIABIdentifier.Rd new file mode 100644 index 0000000..c340f29 --- /dev/null +++ b/auto-generated-sdk/man/FIABIdentifier.Rd @@ -0,0 +1,93 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/fiab_identifier.R +\docType{class} +\name{FIABIdentifier} +\alias{FIABIdentifier} +\title{FIABIdentifier} +\format{ +An \code{R6Class} generator object +} +\description{ +FIABIdentifier Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{id}}{character} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{FIABIdentifier$new()}} +\item \href{#method-toJSON}{\code{FIABIdentifier$toJSON()}} +\item \href{#method-fromJSON}{\code{FIABIdentifier$fromJSON()}} +\item \href{#method-toJSONString}{\code{FIABIdentifier$toJSONString()}} +\item \href{#method-fromJSONString}{\code{FIABIdentifier$fromJSONString()}} +\item \href{#method-clone}{\code{FIABIdentifier$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABIdentifier$new(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABIdentifier$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABIdentifier$fromJSON(FIABIdentifierJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABIdentifier$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABIdentifier$fromJSONString(FIABIdentifierJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIABIdentifier$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/FICalculationParameters.Rd b/auto-generated-sdk/man/FICalculationParameters.Rd new file mode 100644 index 0000000..0963083 --- /dev/null +++ b/auto-generated-sdk/man/FICalculationParameters.Rd @@ -0,0 +1,97 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/fi_calculation_parameters.R +\docType{class} +\name{FICalculationParameters} +\alias{FICalculationParameters} +\title{FICalculationParameters} +\format{ +An \code{R6Class} generator object +} +\description{ +FICalculationParameters Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{securities}}{list( \link{FISecurity} )} + +\item{\code{calculations}}{list( character )} + +\item{\code{jobSettings}}{\link{FIJobSettings}} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{FICalculationParameters$new()}} +\item \href{#method-toJSON}{\code{FICalculationParameters$toJSON()}} +\item \href{#method-fromJSON}{\code{FICalculationParameters$fromJSON()}} +\item \href{#method-toJSONString}{\code{FICalculationParameters$toJSONString()}} +\item \href{#method-fromJSONString}{\code{FICalculationParameters$fromJSONString()}} +\item \href{#method-clone}{\code{FICalculationParameters$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FICalculationParameters$new(securities, calculations, jobSettings, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FICalculationParameters$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FICalculationParameters$fromJSON(FICalculationParametersJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FICalculationParameters$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FICalculationParameters$fromJSONString(FICalculationParametersJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FICalculationParameters$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/FICalculationsApi.Rd b/auto-generated-sdk/man/FICalculationsApi.Rd new file mode 100644 index 0000000..a911195 --- /dev/null +++ b/auto-generated-sdk/man/FICalculationsApi.Rd @@ -0,0 +1,558 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/fi_calculations_api.R +\docType{class} +\name{FICalculationsApi} +\alias{FICalculationsApi} +\title{FICalculations operations} +\format{ +An \code{R6Class} generator object +} +\description{ +factset.analyticsapi.engines.FICalculations +} +\section{Methods}{ + +\describe{ +\strong{ CancelFICalculationById } \emph{ Cancel FI calculation by id } +This is the endpoint to cancel a previously submitted calculation. Instead of doing a GET on the polling URL, cancel the request by doing a DELETE. + +\itemize{ +\item \emph{ @param } id character + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 204 | Expected response, calculation was canceled successfully. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid identifier provided. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | There was no request for the calculation identifier provided, or the request was already canceled for the provided identifier. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in sometime. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +\strong{ GetFICalculationById } \emph{ Get FI calculation by id } +This is the endpoint to check on the progress of a previously requested calculation. If the calculation has finished computing, the body of the response will contain the requested document in JSON. Otherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. + +\itemize{ +\item \emph{ @param } id character + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 200 | Expected response once calculation is completed, returns JSON in the format specified in the Run Calculations endpoint. + +\item return type : object +\item response headers : + +\tabular{ll}{ +Content-Encoding \tab Standard HTTP header. Header value based on Accept-Encoding Request header. \cr +Content-Type \tab Standard HTTP header. \cr +Transfer-Encoding \tab Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 202 | Expected response returned if the calculation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. + + +\item response headers : + +\tabular{ll}{ +X-FactSet-Api-PickUp-Progress \tab FactSet's progress header. \cr +Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid identifier provided. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in sometime. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +\strong{ RunFICalculation } \emph{ Run FI calculation } +This endpoint creates a new FI calculation. This must be used first before get status or cancelling endpoints with a calculation id. A successful response will contain the resulting FI calculation or a polling URL in location header if the request takes too long. + +\itemize{ +\item \emph{ @param } x.factset.content.organization character +\item \emph{ @param } x.factset.content.type character +\item \emph{ @param } fi.calculation.parameters \link{FICalculationParameters} + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 202 | Expected response, contains the poll URL in the Location header. + + +\item response headers : + +\tabular{ll}{ +Location \tab URL to poll for the resulting calculation \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Calculations-Limit \tab Maximum FI request limit. \cr +X-FactSet-Api-Calculations-Remaining \tab Number of FI requests remaining till request limit reached. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 201 | Expected response if calculation is completed within 30 seconds, returns JSON in the format specified in the Run Calculations endpoint. + +\item return type : object +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Calculations-Limit \tab Maximum FI request limit. \cr +X-FactSet-Api-Calculations-Remaining \tab Number of FI requests remaining till request limit reached. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid POST body. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Calculations-Limit \tab Maximum FI request limit. \cr +X-FactSet-Api-Calculations-Remaining \tab Number of FI requests remaining till request limit reached. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Calculations-Limit \tab Maximum FI request limit. \cr +X-FactSet-Api-Calculations-Remaining \tab Number of FI requests remaining till request limit reached. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Calculations-Limit \tab Maximum FI request limit. \cr +X-FactSet-Api-Calculations-Remaining \tab Number of FI requests remaining till request limit reached. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | One or more calculation settings were unavailable. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Calculations-Limit \tab Maximum FI request limit. \cr +X-FactSet-Api-Calculations-Remaining \tab Number of FI requests remaining till request limit reached. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 415 | Missing/Invalid Content-Type header. Header needs to be set to application/json. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Calculations-Limit \tab Maximum FI request limit. \cr +X-FactSet-Api-Calculations-Remaining \tab Number of FI requests remaining till request limit reached. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Calculations-Limit \tab Maximum FI request limit. \cr +X-FactSet-Api-Calculations-Remaining \tab Number of FI requests remaining till request limit reached. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Calculations-Limit \tab Maximum FI request limit. \cr +X-FactSet-Api-Calculations-Remaining \tab Number of FI requests remaining till request limit reached. \cr +} +\item status code : 503 | Request timed out. Retry the request in sometime. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-FactSet-Api-Calculations-Limit \tab Maximum FI request limit. \cr +X-FactSet-Api-Calculations-Remaining \tab Number of FI requests remaining till request limit reached. \cr +} +} + +} +} + +\examples{ +\dontrun{ +#################### CancelFICalculationById #################### + +library(factset.analyticsapi.engines) +var.id <- 'id_example' # character | from url, provided from the location header in the Run FI Calculation endpoint + +#Cancel FI calculation by id +api.instance <- FICalculationsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$CancelFICalculationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +#################### GetFICalculationById #################### + +library(factset.analyticsapi.engines) +var.id <- 'id_example' # character | from url, provided from the location header in the Run FI Calculation endpoint + +#Get FI calculation by id +api.instance <- FICalculationsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$GetFICalculationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +#################### RunFICalculation #################### + +library(factset.analyticsapi.engines) +var.x.factset.content.organization <- 'x.factset.content.organization_example' # character | For specifying the format of the calculation result. Accepted values are \"column\" or \"row\" or \"simplifiedrow\" +var.x.factset.content.type <- 'x.factset.content.type_example' # character | For specifying the content type of the calculation result. Accepted values are either \"application/json\" or \"application/x-protobuf\" +var.fi.calculation.parameters <- FICalculationParameters$new() # FICalculationParameters | + +#Run FI calculation +api.instance <- FICalculationsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$RunFICalculation(x.factset.content.organization=var.x.factset.content.organization, x.factset.content.type=var.x.factset.content.type, fi.calculation.parameters=var.fi.calculation.parameters), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +} +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{apiClient}}{Handles the client-server communication.} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{FICalculationsApi$new()}} +\item \href{#method-CancelFICalculationById}{\code{FICalculationsApi$CancelFICalculationById()}} +\item \href{#method-CancelFICalculationByIdWithHttpInfo}{\code{FICalculationsApi$CancelFICalculationByIdWithHttpInfo()}} +\item \href{#method-GetFICalculationById}{\code{FICalculationsApi$GetFICalculationById()}} +\item \href{#method-GetFICalculationByIdWithHttpInfo}{\code{FICalculationsApi$GetFICalculationByIdWithHttpInfo()}} +\item \href{#method-RunFICalculation}{\code{FICalculationsApi$RunFICalculation()}} +\item \href{#method-RunFICalculationWithHttpInfo}{\code{FICalculationsApi$RunFICalculationWithHttpInfo()}} +\item \href{#method-clone}{\code{FICalculationsApi$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FICalculationsApi$new(apiClient)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-CancelFICalculationById}{}}} +\subsection{Method \code{CancelFICalculationById()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FICalculationsApi$CancelFICalculationById(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-CancelFICalculationByIdWithHttpInfo}{}}} +\subsection{Method \code{CancelFICalculationByIdWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FICalculationsApi$CancelFICalculationByIdWithHttpInfo(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetFICalculationById}{}}} +\subsection{Method \code{GetFICalculationById()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FICalculationsApi$GetFICalculationById(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetFICalculationByIdWithHttpInfo}{}}} +\subsection{Method \code{GetFICalculationByIdWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FICalculationsApi$GetFICalculationByIdWithHttpInfo(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-RunFICalculation}{}}} +\subsection{Method \code{RunFICalculation()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FICalculationsApi$RunFICalculation( + x.factset.content.organization = NULL, + x.factset.content.type = NULL, + fi.calculation.parameters = NULL, + ... +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-RunFICalculationWithHttpInfo}{}}} +\subsection{Method \code{RunFICalculationWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FICalculationsApi$RunFICalculationWithHttpInfo( + x.factset.content.organization = NULL, + x.factset.content.type = NULL, + fi.calculation.parameters = NULL, + ... +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FICalculationsApi$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/FIJobSettings.Rd b/auto-generated-sdk/man/FIJobSettings.Rd new file mode 100644 index 0000000..d802b7f --- /dev/null +++ b/auto-generated-sdk/man/FIJobSettings.Rd @@ -0,0 +1,95 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/fi_job_settings.R +\docType{class} +\name{FIJobSettings} +\alias{FIJobSettings} +\title{FIJobSettings} +\format{ +An \code{R6Class} generator object +} +\description{ +FIJobSettings Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{yieldCurveDate}}{character} + +\item{\code{partialDurationMonths}}{list( integer ) [optional]} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{FIJobSettings$new()}} +\item \href{#method-toJSON}{\code{FIJobSettings$toJSON()}} +\item \href{#method-fromJSON}{\code{FIJobSettings$fromJSON()}} +\item \href{#method-toJSONString}{\code{FIJobSettings$toJSONString()}} +\item \href{#method-fromJSONString}{\code{FIJobSettings$fromJSONString()}} +\item \href{#method-clone}{\code{FIJobSettings$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIJobSettings$new(yieldCurveDate, partialDurationMonths = NULL, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIJobSettings$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIJobSettings$fromJSON(FIJobSettingsJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIJobSettings$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIJobSettings$fromJSONString(FIJobSettingsJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FIJobSettings$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/FISecurity.Rd b/auto-generated-sdk/man/FISecurity.Rd new file mode 100644 index 0000000..abde9ee --- /dev/null +++ b/auto-generated-sdk/man/FISecurity.Rd @@ -0,0 +1,111 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/fi_security.R +\docType{class} +\name{FISecurity} +\alias{FISecurity} +\title{FISecurity} +\format{ +An \code{R6Class} generator object +} +\description{ +FISecurity Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{calcFromMethod}}{character} + +\item{\code{calcFromValue}}{numeric} + +\item{\code{face}}{numeric} + +\item{\code{symbol}}{character} + +\item{\code{settlementDate}}{character} + +\item{\code{discountCurve}}{character} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{FISecurity$new()}} +\item \href{#method-toJSON}{\code{FISecurity$toJSON()}} +\item \href{#method-fromJSON}{\code{FISecurity$fromJSON()}} +\item \href{#method-toJSONString}{\code{FISecurity$toJSONString()}} +\item \href{#method-fromJSONString}{\code{FISecurity$fromJSONString()}} +\item \href{#method-clone}{\code{FISecurity$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FISecurity$new( + calcFromMethod, + calcFromValue, + face, + symbol, + settlementDate, + discountCurve, + ... +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FISecurity$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FISecurity$fromJSON(FISecurityJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FISecurity$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FISecurity$fromJSONString(FISecurityJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{FISecurity$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/FrequenciesApi.Rd b/auto-generated-sdk/man/FrequenciesApi.Rd index 2c9068a..6ffc442 100644 --- a/auto-generated-sdk/man/FrequenciesApi.Rd +++ b/auto-generated-sdk/man/FrequenciesApi.Rd @@ -27,11 +27,11 @@ This endpoint lists all the frequencies that can be applied to a PA calculation. \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication. @@ -39,11 +39,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials @@ -51,11 +48,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. @@ -63,11 +60,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. @@ -75,11 +82,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in sometime. @@ -87,11 +91,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } @@ -109,11 +110,11 @@ This endpoint lists all the frequencies that can be applied to a SPAR calculatio \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication. @@ -121,11 +122,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials @@ -133,11 +131,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. @@ -145,11 +143,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. @@ -157,11 +165,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in sometime. @@ -169,11 +174,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } @@ -191,11 +193,11 @@ This endpoint lists all the frequencies that can be applied to a Vault calculati \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication. @@ -203,11 +205,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials @@ -215,11 +214,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. @@ -227,11 +226,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. @@ -239,11 +248,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in sometime. @@ -251,11 +257,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } diff --git a/auto-generated-sdk/man/GroupsApi.Rd b/auto-generated-sdk/man/GroupsApi.Rd index c0dfd6a..6b3e831 100644 --- a/auto-generated-sdk/man/GroupsApi.Rd +++ b/auto-generated-sdk/man/GroupsApi.Rd @@ -27,12 +27,12 @@ This endpoint lists all the PA groups that can be applied to a PA calculation. \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr Age \tab Standard HTTP header. Header will specify the age of groupings list cached response. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 401 | Missing or invalid authentication. @@ -40,11 +40,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 403 | User is forbidden with current credentials @@ -52,11 +49,11 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr -X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr } \item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. @@ -64,11 +61,21 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr } \item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting @@ -76,11 +83,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } \item status code : 503 | Request timed out. Retry the request in sometime. @@ -88,11 +92,8 @@ X-DataDirect-Request-Key \tab FactSet's request key header. \cr \item response headers : \tabular{ll}{ -X-RateLimit-Remaining \tab Number of requests left for the time window. \cr -X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr -X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr -X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr } } diff --git a/auto-generated-sdk/man/OptimalPortfolio.Rd b/auto-generated-sdk/man/OptimalPortfolio.Rd new file mode 100644 index 0000000..43b5486 --- /dev/null +++ b/auto-generated-sdk/man/OptimalPortfolio.Rd @@ -0,0 +1,105 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/optimal_portfolio.R +\docType{class} +\name{OptimalPortfolio} +\alias{OptimalPortfolio} +\title{OptimalPortfolio} +\format{ +An \code{R6Class} generator object +} +\description{ +OptimalPortfolio Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{acctname}}{character [optional]} + +\item{\code{excludezero}}{character [optional]} + +\item{\code{archivedate}}{character [optional]} + +\item{\code{ifexists}}{character [optional]} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{OptimalPortfolio$new()}} +\item \href{#method-toJSON}{\code{OptimalPortfolio$toJSON()}} +\item \href{#method-fromJSON}{\code{OptimalPortfolio$fromJSON()}} +\item \href{#method-toJSONString}{\code{OptimalPortfolio$toJSONString()}} +\item \href{#method-fromJSONString}{\code{OptimalPortfolio$fromJSONString()}} +\item \href{#method-clone}{\code{OptimalPortfolio$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimalPortfolio$new( + acctname = NULL, + excludezero = NULL, + archivedate = NULL, + ifexists = NULL, + ... +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimalPortfolio$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimalPortfolio$fromJSON(OptimalPortfolioJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimalPortfolio$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimalPortfolio$fromJSONString(OptimalPortfolioJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimalPortfolio$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/Optimization.Rd b/auto-generated-sdk/man/Optimization.Rd new file mode 100644 index 0000000..324f95d --- /dev/null +++ b/auto-generated-sdk/man/Optimization.Rd @@ -0,0 +1,102 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/optimization.R +\docType{class} +\name{Optimization} +\alias{Optimization} +\title{Optimization} +\format{ +An \code{R6Class} generator object +} +\description{ +Optimization Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{riskmodeldate}}{character [optional]} + +\item{\code{backtestdate}}{character [optional]} + +\item{\code{cashflow}}{character [optional]} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{Optimization$new()}} +\item \href{#method-toJSON}{\code{Optimization$toJSON()}} +\item \href{#method-fromJSON}{\code{Optimization$fromJSON()}} +\item \href{#method-toJSONString}{\code{Optimization$toJSONString()}} +\item \href{#method-fromJSONString}{\code{Optimization$fromJSONString()}} +\item \href{#method-clone}{\code{Optimization$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{Optimization$new( + riskmodeldate = NULL, + backtestdate = NULL, + cashflow = NULL, + ... +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{Optimization$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{Optimization$fromJSON(OptimizationJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{Optimization$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{Optimization$fromJSONString(OptimizationJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{Optimization$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/OptimizationsApi.Rd b/auto-generated-sdk/man/OptimizationsApi.Rd new file mode 100644 index 0000000..054bcb0 --- /dev/null +++ b/auto-generated-sdk/man/OptimizationsApi.Rd @@ -0,0 +1,526 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/optimizations_api.R +\docType{class} +\name{OptimizationsApi} +\alias{OptimizationsApi} +\title{Optimizations operations} +\format{ +An \code{R6Class} generator object +} +\description{ +factset.analyticsapi.engines.Optimizations +} +\section{Methods}{ + +\describe{ +\strong{ CancelAxiomaOptimizationById } \emph{ Cancel Axioma optimization by id } +This is the endpoint to cancel a previously submitted optimization. Instead of doing a GET on the polling URL, cancel the request by doing a DELETE. + +\itemize{ +\item \emph{ @param } id character + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 204 | Expected response, optimization was canceled successfully. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid identifier provided. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | There was no request for the optimization identifier provided, or the request was already canceled for the provided identifier. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in sometime. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +\strong{ GetAxiomaOptimizationById } \emph{ Get Axioma optimization by id } +This is the endpoint to check on the progress of a previously requested optimization. If the optimization has finished computing, the body of the response will contain result in JSON. Otherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. + +\itemize{ +\item \emph{ @param } id character + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 200 | Expected response once optimization is completed, returns JSON in the format specified in the Run Optimization endpoint. + + +\item response headers : + +\tabular{ll}{ +Content-Encoding \tab Standard HTTP header. Header value based on Accept-Encoding Request header. \cr +Content-Type \tab Standard HTTP header. \cr +Transfer-Encoding \tab Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. \cr +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 202 | Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. + + +\item response headers : + +\tabular{ll}{ +X-FactSet-Api-PickUp-Progress \tab FactSet’s progress header. \cr +Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid identifier provided. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in sometime. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +\strong{ RunAxiomaOptimization } \emph{ Run Axioma optimization } +This endpoint runs Axioma optimization specified in the POST body parameters. It must be used first before polling or cancelling endpoints. A successful response will contain the URL to poll for the result of the optimization. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the strategy document. + +\itemize{ +\item \emph{ @param } axioma.equity.optimization.parameters \link{AxiomaEquityOptimizationParameters} + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 202 | Expected response, contains the URL in the Location header to check the status of the optimization. + + +\item response headers : + +\tabular{ll}{ +Location \tab URL to poll for the resulting optimization \cr +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 201 | Expected response if optimization is completed within 30 seconds, returns JSON in the format specified in the Run optimization endpoint. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid POST body. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | One or more optimization settings were unavailable. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 415 | Missing/Invalid Content-Type header. Header needs to be set to application/json. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in sometime. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet’s request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +} +} + +\examples{ +\dontrun{ +#################### CancelAxiomaOptimizationById #################### + +library(factset.analyticsapi.engines) +var.id <- 'id_example' # character | from url, provided from the location header in the Run Optimization endpoint + +#Cancel Axioma optimization by id +api.instance <- OptimizationsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$CancelAxiomaOptimizationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +#################### GetAxiomaOptimizationById #################### + +library(factset.analyticsapi.engines) +var.id <- 'id_example' # character | from url, provided from the location header in the Run Optimization endpoint + +#Get Axioma optimization by id +api.instance <- OptimizationsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$GetAxiomaOptimizationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +#################### RunAxiomaOptimization #################### + +library(factset.analyticsapi.engines) +var.axioma.equity.optimization.parameters <- AxiomaEquityOptimizationParameters$new() # AxiomaEquityOptimizationParameters | + +#Run Axioma optimization +api.instance <- OptimizationsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$RunAxiomaOptimization(axioma.equity.optimization.parameters=var.axioma.equity.optimization.parameters), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +} +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{apiClient}}{Handles the client-server communication.} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{OptimizationsApi$new()}} +\item \href{#method-CancelAxiomaOptimizationById}{\code{OptimizationsApi$CancelAxiomaOptimizationById()}} +\item \href{#method-CancelAxiomaOptimizationByIdWithHttpInfo}{\code{OptimizationsApi$CancelAxiomaOptimizationByIdWithHttpInfo()}} +\item \href{#method-GetAxiomaOptimizationById}{\code{OptimizationsApi$GetAxiomaOptimizationById()}} +\item \href{#method-GetAxiomaOptimizationByIdWithHttpInfo}{\code{OptimizationsApi$GetAxiomaOptimizationByIdWithHttpInfo()}} +\item \href{#method-RunAxiomaOptimization}{\code{OptimizationsApi$RunAxiomaOptimization()}} +\item \href{#method-RunAxiomaOptimizationWithHttpInfo}{\code{OptimizationsApi$RunAxiomaOptimizationWithHttpInfo()}} +\item \href{#method-clone}{\code{OptimizationsApi$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizationsApi$new(apiClient)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-CancelAxiomaOptimizationById}{}}} +\subsection{Method \code{CancelAxiomaOptimizationById()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizationsApi$CancelAxiomaOptimizationById(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-CancelAxiomaOptimizationByIdWithHttpInfo}{}}} +\subsection{Method \code{CancelAxiomaOptimizationByIdWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizationsApi$CancelAxiomaOptimizationByIdWithHttpInfo(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetAxiomaOptimizationById}{}}} +\subsection{Method \code{GetAxiomaOptimizationById()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizationsApi$GetAxiomaOptimizationById(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetAxiomaOptimizationByIdWithHttpInfo}{}}} +\subsection{Method \code{GetAxiomaOptimizationByIdWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizationsApi$GetAxiomaOptimizationByIdWithHttpInfo(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-RunAxiomaOptimization}{}}} +\subsection{Method \code{RunAxiomaOptimization()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizationsApi$RunAxiomaOptimization( + axioma.equity.optimization.parameters = NULL, + ... +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-RunAxiomaOptimizationWithHttpInfo}{}}} +\subsection{Method \code{RunAxiomaOptimizationWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizationsApi$RunAxiomaOptimizationWithHttpInfo( + axioma.equity.optimization.parameters = NULL, + ... +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizationsApi$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/OptimizerAccount.Rd b/auto-generated-sdk/man/OptimizerAccount.Rd new file mode 100644 index 0000000..7252f09 --- /dev/null +++ b/auto-generated-sdk/man/OptimizerAccount.Rd @@ -0,0 +1,95 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/optimizer_account.R +\docType{class} +\name{OptimizerAccount} +\alias{OptimizerAccount} +\title{OptimizerAccount} +\format{ +An \code{R6Class} generator object +} +\description{ +OptimizerAccount Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{id}}{character [optional]} + +\item{\code{overrides}}{\link{OptimizerAccountOverrides} [optional]} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{OptimizerAccount$new()}} +\item \href{#method-toJSON}{\code{OptimizerAccount$toJSON()}} +\item \href{#method-fromJSON}{\code{OptimizerAccount$fromJSON()}} +\item \href{#method-toJSONString}{\code{OptimizerAccount$toJSONString()}} +\item \href{#method-fromJSONString}{\code{OptimizerAccount$fromJSONString()}} +\item \href{#method-clone}{\code{OptimizerAccount$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerAccount$new(id = NULL, overrides = NULL, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerAccount$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerAccount$fromJSON(OptimizerAccountJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerAccount$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerAccount$fromJSONString(OptimizerAccountJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerAccount$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/OptimizerAccountOverrides.Rd b/auto-generated-sdk/man/OptimizerAccountOverrides.Rd new file mode 100644 index 0000000..a5eabfb --- /dev/null +++ b/auto-generated-sdk/man/OptimizerAccountOverrides.Rd @@ -0,0 +1,105 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/optimizer_account_overrides.R +\docType{class} +\name{OptimizerAccountOverrides} +\alias{OptimizerAccountOverrides} +\title{OptimizerAccountOverrides} +\format{ +An \code{R6Class} generator object +} +\description{ +OptimizerAccountOverrides Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{portfolio}}{character [optional]} + +\item{\code{benchmark}}{character [optional]} + +\item{\code{riskmodelid}}{character [optional]} + +\item{\code{currency}}{character [optional]} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{OptimizerAccountOverrides$new()}} +\item \href{#method-toJSON}{\code{OptimizerAccountOverrides$toJSON()}} +\item \href{#method-fromJSON}{\code{OptimizerAccountOverrides$fromJSON()}} +\item \href{#method-toJSONString}{\code{OptimizerAccountOverrides$toJSONString()}} +\item \href{#method-fromJSONString}{\code{OptimizerAccountOverrides$fromJSONString()}} +\item \href{#method-clone}{\code{OptimizerAccountOverrides$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerAccountOverrides$new( + portfolio = NULL, + benchmark = NULL, + riskmodelid = NULL, + currency = NULL, + ... +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerAccountOverrides$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerAccountOverrides$fromJSON(OptimizerAccountOverridesJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerAccountOverrides$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerAccountOverrides$fromJSONString(OptimizerAccountOverridesJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerAccountOverrides$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/OptimizerOptimalHoldings.Rd b/auto-generated-sdk/man/OptimizerOptimalHoldings.Rd new file mode 100644 index 0000000..6dda6b9 --- /dev/null +++ b/auto-generated-sdk/man/OptimizerOptimalHoldings.Rd @@ -0,0 +1,102 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/optimizer_optimal_holdings.R +\docType{class} +\name{OptimizerOptimalHoldings} +\alias{OptimizerOptimalHoldings} +\title{OptimizerOptimalHoldings} +\format{ +An \code{R6Class} generator object +} +\description{ +OptimizerOptimalHoldings Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{identifiertype}}{character [optional]} + +\item{\code{includecash}}{character [optional]} + +\item{\code{excludezero}}{character [optional]} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{OptimizerOptimalHoldings$new()}} +\item \href{#method-toJSON}{\code{OptimizerOptimalHoldings$toJSON()}} +\item \href{#method-fromJSON}{\code{OptimizerOptimalHoldings$fromJSON()}} +\item \href{#method-toJSONString}{\code{OptimizerOptimalHoldings$toJSONString()}} +\item \href{#method-fromJSONString}{\code{OptimizerOptimalHoldings$fromJSONString()}} +\item \href{#method-clone}{\code{OptimizerOptimalHoldings$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerOptimalHoldings$new( + identifiertype = NULL, + includecash = NULL, + excludezero = NULL, + ... +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerOptimalHoldings$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerOptimalHoldings$fromJSON(OptimizerOptimalHoldingsJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerOptimalHoldings$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerOptimalHoldings$fromJSONString(OptimizerOptimalHoldingsJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerOptimalHoldings$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/OptimizerOutputTypes.Rd b/auto-generated-sdk/man/OptimizerOutputTypes.Rd new file mode 100644 index 0000000..46bded6 --- /dev/null +++ b/auto-generated-sdk/man/OptimizerOutputTypes.Rd @@ -0,0 +1,97 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/optimizer_output_types.R +\docType{class} +\name{OptimizerOutputTypes} +\alias{OptimizerOutputTypes} +\title{OptimizerOutputTypes} +\format{ +An \code{R6Class} generator object +} +\description{ +OptimizerOutputTypes Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{trades}}{\link{OptimizerTradesList} [optional]} + +\item{\code{optimal}}{\link{OptimizerOptimalHoldings} [optional]} + +\item{\code{account}}{\link{OptimalPortfolio} [optional]} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{OptimizerOutputTypes$new()}} +\item \href{#method-toJSON}{\code{OptimizerOutputTypes$toJSON()}} +\item \href{#method-fromJSON}{\code{OptimizerOutputTypes$fromJSON()}} +\item \href{#method-toJSONString}{\code{OptimizerOutputTypes$toJSONString()}} +\item \href{#method-fromJSONString}{\code{OptimizerOutputTypes$fromJSONString()}} +\item \href{#method-clone}{\code{OptimizerOutputTypes$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerOutputTypes$new(trades = NULL, optimal = NULL, account = NULL, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerOutputTypes$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerOutputTypes$fromJSON(OptimizerOutputTypesJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerOutputTypes$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerOutputTypes$fromJSONString(OptimizerOutputTypesJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerOutputTypes$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/OptimizerStrategy.Rd b/auto-generated-sdk/man/OptimizerStrategy.Rd new file mode 100644 index 0000000..fd3016f --- /dev/null +++ b/auto-generated-sdk/man/OptimizerStrategy.Rd @@ -0,0 +1,95 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/optimizer_strategy.R +\docType{class} +\name{OptimizerStrategy} +\alias{OptimizerStrategy} +\title{OptimizerStrategy} +\format{ +An \code{R6Class} generator object +} +\description{ +OptimizerStrategy Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{id}}{character} + +\item{\code{overrides}}{\link{OptimizerStrategyOverrides} [optional]} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{OptimizerStrategy$new()}} +\item \href{#method-toJSON}{\code{OptimizerStrategy$toJSON()}} +\item \href{#method-fromJSON}{\code{OptimizerStrategy$fromJSON()}} +\item \href{#method-toJSONString}{\code{OptimizerStrategy$toJSONString()}} +\item \href{#method-fromJSONString}{\code{OptimizerStrategy$fromJSONString()}} +\item \href{#method-clone}{\code{OptimizerStrategy$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerStrategy$new(id, overrides = NULL, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerStrategy$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerStrategy$fromJSON(OptimizerStrategyJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerStrategy$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerStrategy$fromJSONString(OptimizerStrategyJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerStrategy$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/OptimizerStrategyOverrides.Rd b/auto-generated-sdk/man/OptimizerStrategyOverrides.Rd new file mode 100644 index 0000000..ea34a1e --- /dev/null +++ b/auto-generated-sdk/man/OptimizerStrategyOverrides.Rd @@ -0,0 +1,108 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/optimizer_strategy_overrides.R +\docType{class} +\name{OptimizerStrategyOverrides} +\alias{OptimizerStrategyOverrides} +\title{OptimizerStrategyOverrides} +\format{ +An \code{R6Class} generator object +} +\description{ +OptimizerStrategyOverrides Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{objective}}{character [optional]} + +\item{\code{constraints}}{named list( character ) [optional]} + +\item{\code{alpha}}{character [optional]} + +\item{\code{transactioncost}}{character [optional]} + +\item{\code{tax}}{character [optional]} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{OptimizerStrategyOverrides$new()}} +\item \href{#method-toJSON}{\code{OptimizerStrategyOverrides$toJSON()}} +\item \href{#method-fromJSON}{\code{OptimizerStrategyOverrides$fromJSON()}} +\item \href{#method-toJSONString}{\code{OptimizerStrategyOverrides$toJSONString()}} +\item \href{#method-fromJSONString}{\code{OptimizerStrategyOverrides$fromJSONString()}} +\item \href{#method-clone}{\code{OptimizerStrategyOverrides$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerStrategyOverrides$new( + objective = NULL, + constraints = NULL, + alpha = NULL, + transactioncost = NULL, + tax = NULL, + ... +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerStrategyOverrides$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerStrategyOverrides$fromJSON(OptimizerStrategyOverridesJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerStrategyOverrides$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerStrategyOverrides$fromJSONString(OptimizerStrategyOverridesJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerStrategyOverrides$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/OptimizerTradesList.Rd b/auto-generated-sdk/man/OptimizerTradesList.Rd new file mode 100644 index 0000000..2afd593 --- /dev/null +++ b/auto-generated-sdk/man/OptimizerTradesList.Rd @@ -0,0 +1,95 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/optimizer_trades_list.R +\docType{class} +\name{OptimizerTradesList} +\alias{OptimizerTradesList} +\title{OptimizerTradesList} +\format{ +An \code{R6Class} generator object +} +\description{ +OptimizerTradesList Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{identifiertype}}{character [optional]} + +\item{\code{includecash}}{character [optional]} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{OptimizerTradesList$new()}} +\item \href{#method-toJSON}{\code{OptimizerTradesList$toJSON()}} +\item \href{#method-fromJSON}{\code{OptimizerTradesList$fromJSON()}} +\item \href{#method-toJSONString}{\code{OptimizerTradesList$toJSONString()}} +\item \href{#method-fromJSONString}{\code{OptimizerTradesList$fromJSONString()}} +\item \href{#method-clone}{\code{OptimizerTradesList$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerTradesList$new(identifiertype = NULL, includecash = NULL, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerTradesList$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerTradesList$fromJSON(OptimizerTradesListJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerTradesList$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerTradesList$fromJSONString(OptimizerTradesListJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{OptimizerTradesList$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/PACalculationParameters.Rd b/auto-generated-sdk/man/PACalculationParameters.Rd index de09ff5..9728170 100644 --- a/auto-generated-sdk/man/PACalculationParameters.Rd +++ b/auto-generated-sdk/man/PACalculationParameters.Rd @@ -26,6 +26,8 @@ PACalculationParameters Class \item{\code{currencyisocode}}{character [optional]} \item{\code{columns}}{list( \link{PACalculationColumn} ) [optional]} + +\item{\code{componentdetail}}{character [optional]} } \if{html}{\out{}} } @@ -53,6 +55,7 @@ PACalculationParameters Class groups = NULL, currencyisocode = NULL, columns = NULL, + componentdetail = NULL, ... )}\if{html}{\out{}} } diff --git a/auto-generated-sdk/man/PACalculationsApi.Rd b/auto-generated-sdk/man/PACalculationsApi.Rd new file mode 100644 index 0000000..1089190 --- /dev/null +++ b/auto-generated-sdk/man/PACalculationsApi.Rd @@ -0,0 +1,538 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/pa_calculations_api.R +\docType{class} +\name{PACalculationsApi} +\alias{PACalculationsApi} +\title{PACalculations operations} +\format{ +An \code{R6Class} generator object +} +\description{ +factset.analyticsapi.engines.PACalculations +} +\section{Methods}{ + +\describe{ +\strong{ CancelPACalculationById } \emph{ Cancel PA calculation by id } +This is the endpoint to cancel a previously submitted calculation. Instead of doing a GET on the polling URL, cancel the request by doing a DELETE. + +\itemize{ +\item \emph{ @param } id character + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 204 | Expected response, calculation was canceled successfully. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid identifier provided. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | There was no request for the calculation identifier provided, or the request was already canceled for the provided identifier. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in sometime. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +\strong{ GetPACalculationById } \emph{ Get PA calculation by id } +This is the endpoint to check on the progress of a previously requested calculation. If the calculation has finished computing, the body of the response will contain the requested document in JSON. Otherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. + +\itemize{ +\item \emph{ @param } id character + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 200 | Expected response once calculation is completed, returns JSON in the format specified in the Run Calculations endpoint. + +\item return type : object +\item response headers : + +\tabular{ll}{ +Content-Encoding \tab Standard HTTP header. Header value based on Accept-Encoding Request header. \cr +Content-Type \tab Standard HTTP header. \cr +Transfer-Encoding \tab Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 202 | Expected response returned if the calculation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. + + +\item response headers : + +\tabular{ll}{ +X-FactSet-Api-PickUp-Progress \tab FactSet's progress header. \cr +Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid identifier provided. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in sometime. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +\strong{ RunPACalculation } \emph{ Run PA Calculation } +This endpoint runs the PA calculation specified in the POST body parameters. It must be used first before polling or cancelling endpoints. A successful response will contain the URL to poll for the result of the calculation. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. + +\itemize{ +\item \emph{ @param } x.factset.content.organization character +\item \emph{ @param } x.factset.content.type character +\item \emph{ @param } pa.calculation.parameters \link{PACalculationParameters} + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 202 | Expected response, contains the poll URL in the Location header. + + +\item response headers : + +\tabular{ll}{ +Location \tab URL to poll for the resulting calculation \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 201 | Expected response if calculation is completed within 30 seconds, returns JSON in the format specified in the Run Calculations endpoint. + +\item return type : object +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid POST body. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | One or more calculation settings were unavailable. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 415 | Missing/Invalid Content-Type header. Header needs to be set to application/json. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in sometime. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +} +} + +\examples{ +\dontrun{ +#################### CancelPACalculationById #################### + +library(factset.analyticsapi.engines) +var.id <- 'id_example' # character | from url, provided from the location header in the Run Calculation endpoint + +#Cancel PA calculation by id +api.instance <- PACalculationsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$CancelPACalculationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +#################### GetPACalculationById #################### + +library(factset.analyticsapi.engines) +var.id <- 'id_example' # character | from url, provided from the location header in the Run Calculation endpoint + +#Get PA calculation by id +api.instance <- PACalculationsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$GetPACalculationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +#################### RunPACalculation #################### + +library(factset.analyticsapi.engines) +var.x.factset.content.organization <- 'x.factset.content.organization_example' # character | For specifying the format of the calculation result. Accepted values are \"column\" or \"row\" or \"simplifiedrow\" +var.x.factset.content.type <- 'x.factset.content.type_example' # character | For specifying the content type of the calculation result. Accepted values are either \"application/json\" or \"application/x-protobuf\" +var.pa.calculation.parameters <- PACalculationParameters$new() # PACalculationParameters | + +#Run PA Calculation +api.instance <- PACalculationsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$RunPACalculation(x.factset.content.organization=var.x.factset.content.organization, x.factset.content.type=var.x.factset.content.type, pa.calculation.parameters=var.pa.calculation.parameters), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +} +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{apiClient}}{Handles the client-server communication.} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{PACalculationsApi$new()}} +\item \href{#method-CancelPACalculationById}{\code{PACalculationsApi$CancelPACalculationById()}} +\item \href{#method-CancelPACalculationByIdWithHttpInfo}{\code{PACalculationsApi$CancelPACalculationByIdWithHttpInfo()}} +\item \href{#method-GetPACalculationById}{\code{PACalculationsApi$GetPACalculationById()}} +\item \href{#method-GetPACalculationByIdWithHttpInfo}{\code{PACalculationsApi$GetPACalculationByIdWithHttpInfo()}} +\item \href{#method-RunPACalculation}{\code{PACalculationsApi$RunPACalculation()}} +\item \href{#method-RunPACalculationWithHttpInfo}{\code{PACalculationsApi$RunPACalculationWithHttpInfo()}} +\item \href{#method-clone}{\code{PACalculationsApi$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PACalculationsApi$new(apiClient)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-CancelPACalculationById}{}}} +\subsection{Method \code{CancelPACalculationById()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PACalculationsApi$CancelPACalculationById(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-CancelPACalculationByIdWithHttpInfo}{}}} +\subsection{Method \code{CancelPACalculationByIdWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PACalculationsApi$CancelPACalculationByIdWithHttpInfo(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetPACalculationById}{}}} +\subsection{Method \code{GetPACalculationById()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PACalculationsApi$GetPACalculationById(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetPACalculationByIdWithHttpInfo}{}}} +\subsection{Method \code{GetPACalculationByIdWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PACalculationsApi$GetPACalculationByIdWithHttpInfo(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-RunPACalculation}{}}} +\subsection{Method \code{RunPACalculation()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PACalculationsApi$RunPACalculation( + x.factset.content.organization = NULL, + x.factset.content.type = NULL, + pa.calculation.parameters = NULL, + ... +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-RunPACalculationWithHttpInfo}{}}} +\subsection{Method \code{RunPACalculationWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PACalculationsApi$RunPACalculationWithHttpInfo( + x.factset.content.organization = NULL, + x.factset.content.type = NULL, + pa.calculation.parameters = NULL, + ... +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PACalculationsApi$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/PubCalculationParameters.Rd b/auto-generated-sdk/man/PubCalculationParameters.Rd new file mode 100644 index 0000000..ba201fd --- /dev/null +++ b/auto-generated-sdk/man/PubCalculationParameters.Rd @@ -0,0 +1,97 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/pub_calculation_parameters.R +\docType{class} +\name{PubCalculationParameters} +\alias{PubCalculationParameters} +\title{PubCalculationParameters} +\format{ +An \code{R6Class} generator object +} +\description{ +PubCalculationParameters Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{document}}{character} + +\item{\code{account}}{\link{PubIdentifier}} + +\item{\code{dates}}{\link{PubDateParameters}} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{PubCalculationParameters$new()}} +\item \href{#method-toJSON}{\code{PubCalculationParameters$toJSON()}} +\item \href{#method-fromJSON}{\code{PubCalculationParameters$fromJSON()}} +\item \href{#method-toJSONString}{\code{PubCalculationParameters$toJSONString()}} +\item \href{#method-fromJSONString}{\code{PubCalculationParameters$fromJSONString()}} +\item \href{#method-clone}{\code{PubCalculationParameters$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PubCalculationParameters$new(document, account, dates, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PubCalculationParameters$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PubCalculationParameters$fromJSON(PubCalculationParametersJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PubCalculationParameters$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PubCalculationParameters$fromJSONString(PubCalculationParametersJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PubCalculationParameters$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/PubDateParameters.Rd b/auto-generated-sdk/man/PubDateParameters.Rd new file mode 100644 index 0000000..c57d912 --- /dev/null +++ b/auto-generated-sdk/man/PubDateParameters.Rd @@ -0,0 +1,95 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/pub_date_parameters.R +\docType{class} +\name{PubDateParameters} +\alias{PubDateParameters} +\title{PubDateParameters} +\format{ +An \code{R6Class} generator object +} +\description{ +PubDateParameters Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{startdate}}{character [optional]} + +\item{\code{enddate}}{character} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{PubDateParameters$new()}} +\item \href{#method-toJSON}{\code{PubDateParameters$toJSON()}} +\item \href{#method-fromJSON}{\code{PubDateParameters$fromJSON()}} +\item \href{#method-toJSONString}{\code{PubDateParameters$toJSONString()}} +\item \href{#method-fromJSONString}{\code{PubDateParameters$fromJSONString()}} +\item \href{#method-clone}{\code{PubDateParameters$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PubDateParameters$new(enddate, startdate = NULL, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PubDateParameters$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PubDateParameters$fromJSON(PubDateParametersJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PubDateParameters$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PubDateParameters$fromJSONString(PubDateParametersJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PubDateParameters$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/PubIdentifier.Rd b/auto-generated-sdk/man/PubIdentifier.Rd new file mode 100644 index 0000000..6aadda3 --- /dev/null +++ b/auto-generated-sdk/man/PubIdentifier.Rd @@ -0,0 +1,95 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/pub_identifier.R +\docType{class} +\name{PubIdentifier} +\alias{PubIdentifier} +\title{PubIdentifier} +\format{ +An \code{R6Class} generator object +} +\description{ +PubIdentifier Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{id}}{character} + +\item{\code{holdingsmode}}{character [optional]} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{PubIdentifier$new()}} +\item \href{#method-toJSON}{\code{PubIdentifier$toJSON()}} +\item \href{#method-fromJSON}{\code{PubIdentifier$fromJSON()}} +\item \href{#method-toJSONString}{\code{PubIdentifier$toJSONString()}} +\item \href{#method-fromJSONString}{\code{PubIdentifier$fromJSONString()}} +\item \href{#method-clone}{\code{PubIdentifier$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PubIdentifier$new(id, holdingsmode = NULL, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PubIdentifier$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PubIdentifier$fromJSON(PubIdentifierJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PubIdentifier$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PubIdentifier$fromJSONString(PubIdentifierJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{PubIdentifier$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/SPARBenchmark.Rd b/auto-generated-sdk/man/SPARBenchmark.Rd new file mode 100644 index 0000000..8974f8d --- /dev/null +++ b/auto-generated-sdk/man/SPARBenchmark.Rd @@ -0,0 +1,97 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/spar_benchmark.R +\docType{class} +\name{SPARBenchmark} +\alias{SPARBenchmark} +\title{SPARBenchmark} +\format{ +An \code{R6Class} generator object +} +\description{ +SPARBenchmark Class +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{id}}{character [optional]} + +\item{\code{name}}{character [optional]} + +\item{\code{identifiers}}{list( \link{SPARIdentifier} ) [optional]} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{SPARBenchmark$new()}} +\item \href{#method-toJSON}{\code{SPARBenchmark$toJSON()}} +\item \href{#method-fromJSON}{\code{SPARBenchmark$fromJSON()}} +\item \href{#method-toJSONString}{\code{SPARBenchmark$toJSONString()}} +\item \href{#method-fromJSONString}{\code{SPARBenchmark$fromJSONString()}} +\item \href{#method-clone}{\code{SPARBenchmark$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{SPARBenchmark$new(id = NULL, name = NULL, identifiers = NULL, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSON}{}}} +\subsection{Method \code{toJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{SPARBenchmark$toJSON()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSON}{}}} +\subsection{Method \code{fromJSON()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{SPARBenchmark$fromJSON(SPARBenchmarkJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-toJSONString}{}}} +\subsection{Method \code{toJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{SPARBenchmark$toJSONString()}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-fromJSONString}{}}} +\subsection{Method \code{fromJSONString()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{SPARBenchmark$fromJSONString(SPARBenchmarkJson)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{SPARBenchmark$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/SPARBenchmarkApi.Rd b/auto-generated-sdk/man/SPARBenchmarkApi.Rd new file mode 100644 index 0000000..4e1ee40 --- /dev/null +++ b/auto-generated-sdk/man/SPARBenchmarkApi.Rd @@ -0,0 +1,222 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/spar_benchmark_api.R +\docType{class} +\name{SPARBenchmarkApi} +\alias{SPARBenchmarkApi} +\title{SPARBenchmark operations} +\format{ +An \code{R6Class} generator object +} +\description{ +factset.analyticsapi.engines.SPARBenchmark +} +\section{Methods}{ + +\describe{ +\strong{ GetSPARBenchmarkById } \emph{ Get SPAR benchmark details } +This endpoint returns the details of a given SPAR benchmark identifier. + +\itemize{ +\item \emph{ @param } id character +\item \emph{ @returnType } \link{SPARBenchmark} \cr + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 200 | Expected response, returns the list of prefix and return types for the benchmark. + +\item return type : SPARBenchmark +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid benchmark identifier. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | Benchmark identifier not found. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 406 | Unsupported Accept header. Header needs to be set to application/json. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in sometime. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +} +} + +\examples{ +\dontrun{ +#################### GetSPARBenchmarkById #################### + +library(factset.analyticsapi.engines) +var.id <- 'id_example' # character | Benchmark Identifier + +#Get SPAR benchmark details +api.instance <- SPARBenchmarkApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$GetSPARBenchmarkById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +} +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{apiClient}}{Handles the client-server communication.} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{SPARBenchmarkApi$new()}} +\item \href{#method-GetSPARBenchmarkById}{\code{SPARBenchmarkApi$GetSPARBenchmarkById()}} +\item \href{#method-GetSPARBenchmarkByIdWithHttpInfo}{\code{SPARBenchmarkApi$GetSPARBenchmarkByIdWithHttpInfo()}} +\item \href{#method-clone}{\code{SPARBenchmarkApi$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{SPARBenchmarkApi$new(apiClient)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetSPARBenchmarkById}{}}} +\subsection{Method \code{GetSPARBenchmarkById()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{SPARBenchmarkApi$GetSPARBenchmarkById(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetSPARBenchmarkByIdWithHttpInfo}{}}} +\subsection{Method \code{GetSPARBenchmarkByIdWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{SPARBenchmarkApi$GetSPARBenchmarkByIdWithHttpInfo(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{SPARBenchmarkApi$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/SPARCalculationsApi.Rd b/auto-generated-sdk/man/SPARCalculationsApi.Rd new file mode 100644 index 0000000..192f955 --- /dev/null +++ b/auto-generated-sdk/man/SPARCalculationsApi.Rd @@ -0,0 +1,527 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/spar_calculations_api.R +\docType{class} +\name{SPARCalculationsApi} +\alias{SPARCalculationsApi} +\title{SPARCalculations operations} +\format{ +An \code{R6Class} generator object +} +\description{ +factset.analyticsapi.engines.SPARCalculations +} +\section{Methods}{ + +\describe{ +\strong{ CancelSPARCalculationById } \emph{ Cancel SPAR calculation } +This is the endpoint to cancel a previously submitted calculation. Instead of doing a GET on the polling URL, cancel the request by doing a DELETE + +\itemize{ +\item \emph{ @param } id character + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 204 | Expected response, calculation was canceled successfully. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid identifier provided. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | There was no request for the calculation identifier provided, or the request was already canceled for the provided identifier. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in sometime. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +\strong{ GetSPARCalculationById } \emph{ Get SPAR calculation by id } +This is the endpoint to check on the progress of a previously requested calculation. If the calculation has finished computing, the body of the response will contain the requested document in JSON. + +\itemize{ +\item \emph{ @param } id character + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 200 | Expected response once calculation is completed, returns JSON in the format specified in the Run Calculations endpoint. + +\item return type : object +\item response headers : + +\tabular{ll}{ +Content-Encoding \tab Standard HTTP header. Header value based on Accept-Encoding Request header. \cr +Content-Type \tab Standard HTTP header. \cr +Transfer-Encoding \tab Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 202 | Expected response returned if the calculation is not yet completed. + + +\item response headers : + +\tabular{ll}{ +Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid identifier provided. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in sometime. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +\strong{ RunSPARCalculation } \emph{ Run SPAR Calculation } +This endpoint runs the SPAR calculation specified in the POST body parameters. It must be used first before polling or cancelling endpoints. A successful response will contain the URL to poll for the result of the calculation. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the SPAR template. + +\itemize{ +\item \emph{ @param } x.factset.content.organization character +\item \emph{ @param } x.factset.content.type character +\item \emph{ @param } spar.calculation.parameters \link{SPARCalculationParameters} + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 202 | Expected response, contains the poll URL in the Location header. + + +\item response headers : + +\tabular{ll}{ +Location \tab URL to poll for the resulting calculation \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 201 | Expected response if calculation is completed within 30 seconds, returns JSON in the format specified in the Run Calculations endpoint. + +\item return type : object +\item response headers : + +\tabular{ll}{ +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid POST body. + + +\item response headers : + +\tabular{ll}{ +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication. + + +\item response headers : + +\tabular{ll}{ +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | One or more calculation settings were unavailable. + + +\item response headers : + +\tabular{ll}{ +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 415 | Missing/Invalid Content-Type header. Header needs to be set to application/json. + + +\item response headers : + +\tabular{ll}{ +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. + + +\item response headers : + +\tabular{ll}{ +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. + + +\item response headers : + +\tabular{ll}{ +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in sometime. + + +\item response headers : + +\tabular{ll}{ +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +} +} + +\examples{ +\dontrun{ +#################### CancelSPARCalculationById #################### + +library(factset.analyticsapi.engines) +var.id <- 'id_example' # character | from url, provided from the location header in the Run Calculation endpoint + +#Cancel SPAR calculation +api.instance <- SPARCalculationsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$CancelSPARCalculationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +#################### GetSPARCalculationById #################### + +library(factset.analyticsapi.engines) +var.id <- 'id_example' # character | from url, provided from the location header in the Run Calculation endpoint + +#Get SPAR calculation by id +api.instance <- SPARCalculationsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$GetSPARCalculationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +#################### RunSPARCalculation #################### + +library(factset.analyticsapi.engines) +var.x.factset.content.organization <- 'x.factset.content.organization_example' # character | For specifying the format of the calculation result. Accepted values are \"column\" or \"row\" or \"simplifiedrow\" +var.x.factset.content.type <- 'x.factset.content.type_example' # character | For specifying the content type of the calculation result. Accepted values are either \"application/json\" or \"application/x-protobuf\" +var.spar.calculation.parameters <- SPARCalculationParameters$new() # SPARCalculationParameters | + +#Run SPAR Calculation +api.instance <- SPARCalculationsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$RunSPARCalculation(x.factset.content.organization=var.x.factset.content.organization, x.factset.content.type=var.x.factset.content.type, spar.calculation.parameters=var.spar.calculation.parameters), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +} +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{apiClient}}{Handles the client-server communication.} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{SPARCalculationsApi$new()}} +\item \href{#method-CancelSPARCalculationById}{\code{SPARCalculationsApi$CancelSPARCalculationById()}} +\item \href{#method-CancelSPARCalculationByIdWithHttpInfo}{\code{SPARCalculationsApi$CancelSPARCalculationByIdWithHttpInfo()}} +\item \href{#method-GetSPARCalculationById}{\code{SPARCalculationsApi$GetSPARCalculationById()}} +\item \href{#method-GetSPARCalculationByIdWithHttpInfo}{\code{SPARCalculationsApi$GetSPARCalculationByIdWithHttpInfo()}} +\item \href{#method-RunSPARCalculation}{\code{SPARCalculationsApi$RunSPARCalculation()}} +\item \href{#method-RunSPARCalculationWithHttpInfo}{\code{SPARCalculationsApi$RunSPARCalculationWithHttpInfo()}} +\item \href{#method-clone}{\code{SPARCalculationsApi$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{SPARCalculationsApi$new(apiClient)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-CancelSPARCalculationById}{}}} +\subsection{Method \code{CancelSPARCalculationById()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{SPARCalculationsApi$CancelSPARCalculationById(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-CancelSPARCalculationByIdWithHttpInfo}{}}} +\subsection{Method \code{CancelSPARCalculationByIdWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{SPARCalculationsApi$CancelSPARCalculationByIdWithHttpInfo(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetSPARCalculationById}{}}} +\subsection{Method \code{GetSPARCalculationById()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{SPARCalculationsApi$GetSPARCalculationById(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetSPARCalculationByIdWithHttpInfo}{}}} +\subsection{Method \code{GetSPARCalculationByIdWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{SPARCalculationsApi$GetSPARCalculationByIdWithHttpInfo(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-RunSPARCalculation}{}}} +\subsection{Method \code{RunSPARCalculation()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{SPARCalculationsApi$RunSPARCalculation( + x.factset.content.organization = NULL, + x.factset.content.type = NULL, + spar.calculation.parameters = NULL, + ... +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-RunSPARCalculationWithHttpInfo}{}}} +\subsection{Method \code{RunSPARCalculationWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{SPARCalculationsApi$RunSPARCalculationWithHttpInfo( + x.factset.content.organization = NULL, + x.factset.content.type = NULL, + spar.calculation.parameters = NULL, + ... +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{SPARCalculationsApi$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/StrategyDocumentsApi.Rd b/auto-generated-sdk/man/StrategyDocumentsApi.Rd new file mode 100644 index 0000000..f3583da --- /dev/null +++ b/auto-generated-sdk/man/StrategyDocumentsApi.Rd @@ -0,0 +1,858 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/strategy_documents_api.R +\docType{class} +\name{StrategyDocumentsApi} +\alias{StrategyDocumentsApi} +\title{StrategyDocuments operations} +\format{ +An \code{R6Class} generator object +} +\description{ +factset.analyticsapi.engines.StrategyDocuments +} +\section{Methods}{ + +\describe{ +\strong{ GetAxiomaEquityStrategyDocuments } \emph{ Get Axioma Equity strategy documents and sub-directories in a directory } +This endpoint looks up all Axioma Equity strategy documents and sub-directories in a given directory. + +\itemize{ +\item \emph{ @param } path character +\item \emph{ @returnType } \link{DocumentDirectories} \cr + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 200 | Expected response, returns a list of Axioma Equity strategy documents and directories + +\item return type : DocumentDirectories +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid query parameter or value provided + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | Path not found + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 406 | Unsupported Accept header. Header needs to be set to application/json + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in some time + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +\strong{ GetAxiomaFIStrategyDocuments } \emph{ Get Axioma FI strategy documents and sub-directories in a directory } +This endpoint looks up all Axioma FI strategy documents and sub-directories in a given directory. + +\itemize{ +\item \emph{ @param } path character +\item \emph{ @returnType } \link{DocumentDirectories} \cr + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 200 | Expected response, returns a list of Axioma FI strategy documents and directories + +\item return type : DocumentDirectories +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid query parameter or value provided + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | Path not found + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 406 | Unsupported Accept header. Header needs to be set to application/json + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in some time + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +\strong{ GetBarraStrategyDocuments } \emph{ Get Barra strategy documents and sub-directories in a directory } +This endpoint looks up all Barra strategy documents and sub-directories in a given directory. + +\itemize{ +\item \emph{ @param } path character +\item \emph{ @returnType } \link{DocumentDirectories} \cr + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 200 | Expected response, returns a list of Barra strategy documents and directories + +\item return type : DocumentDirectories +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid query parameter or value provided + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | Path not found + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 406 | Unsupported Accept header. Header needs to be set to application/json + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in some time + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +\strong{ GetFPOStrategyDocuments } \emph{ Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory } +This endpoint looks up all FactSet Portfolio Optimizer strategy documents and sub-directories in a given directory. + +\itemize{ +\item \emph{ @param } path character +\item \emph{ @returnType } \link{DocumentDirectories} \cr + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 200 | Expected response, returns a list of FactSet Portfolio Optimizer strategy documents and directories + +\item return type : DocumentDirectories +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid query parameter or value provided + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | Path not found + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 406 | Unsupported Accept header. Header needs to be set to application/json + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in some time + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +\strong{ GetNorthfieldStrategyDocuments } \emph{ Get Northfield strategy documents and sub-directories in a directory } +This endpoint looks up all Northfield strategy documents and sub-directories in a given directory. + +\itemize{ +\item \emph{ @param } path character +\item \emph{ @returnType } \link{DocumentDirectories} \cr + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 200 | Expected response, returns a list of Northfield strategy documents and directories + +\item return type : DocumentDirectories +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid query parameter or value provided + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | Path not found + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 406 | Unsupported Accept header. Header needs to be set to application/json + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in some time + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +} +} + +\examples{ +\dontrun{ +#################### GetAxiomaEquityStrategyDocuments #################### + +library(factset.analyticsapi.engines) +var.path <- '' # character | The directory to get the strategy documents and sub-directories in + +#Get Axioma Equity strategy documents and sub-directories in a directory +api.instance <- StrategyDocumentsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$GetAxiomaEquityStrategyDocuments(var.path), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +#################### GetAxiomaFIStrategyDocuments #################### + +library(factset.analyticsapi.engines) +var.path <- '' # character | The directory to get the strategy documents and sub-directories in + +#Get Axioma FI strategy documents and sub-directories in a directory +api.instance <- StrategyDocumentsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$GetAxiomaFIStrategyDocuments(var.path), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +#################### GetBarraStrategyDocuments #################### + +library(factset.analyticsapi.engines) +var.path <- '' # character | The directory to get the strategy documents and sub-directories in + +#Get Barra strategy documents and sub-directories in a directory +api.instance <- StrategyDocumentsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$GetBarraStrategyDocuments(var.path), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +#################### GetFPOStrategyDocuments #################### + +library(factset.analyticsapi.engines) +var.path <- '' # character | The directory to get the strategy documents and sub-directories in + +#Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory +api.instance <- StrategyDocumentsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$GetFPOStrategyDocuments(var.path), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +#################### GetNorthfieldStrategyDocuments #################### + +library(factset.analyticsapi.engines) +var.path <- '' # character | The directory to get the strategy documents and sub-directories in + +#Get Northfield strategy documents and sub-directories in a directory +api.instance <- StrategyDocumentsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$GetNorthfieldStrategyDocuments(var.path), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +} +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{apiClient}}{Handles the client-server communication.} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{StrategyDocumentsApi$new()}} +\item \href{#method-GetAxiomaEquityStrategyDocuments}{\code{StrategyDocumentsApi$GetAxiomaEquityStrategyDocuments()}} +\item \href{#method-GetAxiomaEquityStrategyDocumentsWithHttpInfo}{\code{StrategyDocumentsApi$GetAxiomaEquityStrategyDocumentsWithHttpInfo()}} +\item \href{#method-GetAxiomaFIStrategyDocuments}{\code{StrategyDocumentsApi$GetAxiomaFIStrategyDocuments()}} +\item \href{#method-GetAxiomaFIStrategyDocumentsWithHttpInfo}{\code{StrategyDocumentsApi$GetAxiomaFIStrategyDocumentsWithHttpInfo()}} +\item \href{#method-GetBarraStrategyDocuments}{\code{StrategyDocumentsApi$GetBarraStrategyDocuments()}} +\item \href{#method-GetBarraStrategyDocumentsWithHttpInfo}{\code{StrategyDocumentsApi$GetBarraStrategyDocumentsWithHttpInfo()}} +\item \href{#method-GetFPOStrategyDocuments}{\code{StrategyDocumentsApi$GetFPOStrategyDocuments()}} +\item \href{#method-GetFPOStrategyDocumentsWithHttpInfo}{\code{StrategyDocumentsApi$GetFPOStrategyDocumentsWithHttpInfo()}} +\item \href{#method-GetNorthfieldStrategyDocuments}{\code{StrategyDocumentsApi$GetNorthfieldStrategyDocuments()}} +\item \href{#method-GetNorthfieldStrategyDocumentsWithHttpInfo}{\code{StrategyDocumentsApi$GetNorthfieldStrategyDocumentsWithHttpInfo()}} +\item \href{#method-clone}{\code{StrategyDocumentsApi$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{StrategyDocumentsApi$new(apiClient)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetAxiomaEquityStrategyDocuments}{}}} +\subsection{Method \code{GetAxiomaEquityStrategyDocuments()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{StrategyDocumentsApi$GetAxiomaEquityStrategyDocuments(path, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetAxiomaEquityStrategyDocumentsWithHttpInfo}{}}} +\subsection{Method \code{GetAxiomaEquityStrategyDocumentsWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{StrategyDocumentsApi$GetAxiomaEquityStrategyDocumentsWithHttpInfo(path, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetAxiomaFIStrategyDocuments}{}}} +\subsection{Method \code{GetAxiomaFIStrategyDocuments()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{StrategyDocumentsApi$GetAxiomaFIStrategyDocuments(path, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetAxiomaFIStrategyDocumentsWithHttpInfo}{}}} +\subsection{Method \code{GetAxiomaFIStrategyDocumentsWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{StrategyDocumentsApi$GetAxiomaFIStrategyDocumentsWithHttpInfo(path, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetBarraStrategyDocuments}{}}} +\subsection{Method \code{GetBarraStrategyDocuments()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{StrategyDocumentsApi$GetBarraStrategyDocuments(path, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetBarraStrategyDocumentsWithHttpInfo}{}}} +\subsection{Method \code{GetBarraStrategyDocumentsWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{StrategyDocumentsApi$GetBarraStrategyDocumentsWithHttpInfo(path, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetFPOStrategyDocuments}{}}} +\subsection{Method \code{GetFPOStrategyDocuments()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{StrategyDocumentsApi$GetFPOStrategyDocuments(path, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetFPOStrategyDocumentsWithHttpInfo}{}}} +\subsection{Method \code{GetFPOStrategyDocumentsWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{StrategyDocumentsApi$GetFPOStrategyDocumentsWithHttpInfo(path, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetNorthfieldStrategyDocuments}{}}} +\subsection{Method \code{GetNorthfieldStrategyDocuments()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{StrategyDocumentsApi$GetNorthfieldStrategyDocuments(path, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetNorthfieldStrategyDocumentsWithHttpInfo}{}}} +\subsection{Method \code{GetNorthfieldStrategyDocumentsWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{StrategyDocumentsApi$GetNorthfieldStrategyDocumentsWithHttpInfo(path, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{StrategyDocumentsApi$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/man/VaultCalculationParameters.Rd b/auto-generated-sdk/man/VaultCalculationParameters.Rd index b98b141..05df30d 100644 --- a/auto-generated-sdk/man/VaultCalculationParameters.Rd +++ b/auto-generated-sdk/man/VaultCalculationParameters.Rd @@ -20,6 +20,8 @@ VaultCalculationParameters Class \item{\code{dates}}{\link{VaultDateParameters} [optional]} \item{\code{configid}}{character} + +\item{\code{componentdetail}}{character [optional]} } \if{html}{\out{}} } @@ -44,6 +46,7 @@ VaultCalculationParameters Class account, configid, dates = NULL, + componentdetail = NULL, ... )}\if{html}{\out{}} } diff --git a/auto-generated-sdk/man/VaultCalculationsApi.Rd b/auto-generated-sdk/man/VaultCalculationsApi.Rd new file mode 100644 index 0000000..ac9ac74 --- /dev/null +++ b/auto-generated-sdk/man/VaultCalculationsApi.Rd @@ -0,0 +1,538 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/vault_calculations_api.R +\docType{class} +\name{VaultCalculationsApi} +\alias{VaultCalculationsApi} +\title{VaultCalculations operations} +\format{ +An \code{R6Class} generator object +} +\description{ +factset.analyticsapi.engines.VaultCalculations +} +\section{Methods}{ + +\describe{ +\strong{ CancelVaultCalculationById } \emph{ Cancel Vault calculation by id } +This is the endpoint to cancel a previously submitted calculation. Instead of doing a GET on the polling URL, cancel the request by doing a DELETE. + +\itemize{ +\item \emph{ @param } id character + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 204 | Expected response, calculation was canceled successfully. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid identifier provided. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | There was no request for the calculation identifier provided, or the request was already canceled for the provided identifier. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in sometime. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +\strong{ GetVaultCalculationById } \emph{ Get Vault calculation by id } +This is the endpoint to check on the progress of a previously requested calculation. If the calculation has finished computing, the body of the response will contain the requested document in JSON. + +\itemize{ +\item \emph{ @param } id character + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 202 | Expected response returned if the calculation is not yet completed. + + +\item response headers : + +\tabular{ll}{ +Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 200 | Expected response once calculation is completed, returns JSON in the format specified in the Run Calculations endpoint. + +\item return type : object +\item response headers : + +\tabular{ll}{ +Content-Encoding \tab Standard HTTP header. Header value based on Accept-Encoding Request header. \cr +Content-Type \tab Standard HTTP header. \cr +Transfer-Encoding \tab Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid identifier provided. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in sometime. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +\strong{ RunVaultCalculation } \emph{ Run Vault Calculation } +This endpoint runs the Vault calculation specified in the POST body parameters. It must be used first before polling or cancelling endpoints. A successful response will contain the URL to poll for the result of the calculation. Remarks: * Start and and end date must be within the configuration's min and max date range + +\itemize{ +\item \emph{ @param } x.factset.content.organization character +\item \emph{ @param } x.factset.content.type character +\item \emph{ @param } vault.calculation.parameters \link{VaultCalculationParameters} + +\item On encountering errors, an error of subclass ApiException will be thrown. + +\item status code : 202 | Expected response, contains the poll URL in the Location header. + + +\item response headers : + +\tabular{ll}{ +Location \tab URL to poll for the resulting calculation \cr +Cache-Control \tab Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. \cr +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 201 | Expected response if calculation is completed within 30 seconds, returns JSON in the format specified in the Run Calculations endpoint. + +\item return type : object +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 400 | Invalid POST body. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 401 | Missing or invalid authentication. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 403 | User is forbidden with current credentials + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 404 | One or more calculation settings were unavailable. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 415 | Missing/Invalid Content-Type header. Header needs to be set to application/json. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +} +\item status code : 429 | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +X-RateLimit-Limit \tab Number of allowed requests for the time window. \cr +X-RateLimit-Remaining \tab Number of requests left for the time window. \cr +X-RateLimit-Reset \tab Number of seconds remaining till rate limit resets. \cr +Retry-After \tab Time to wait in seconds before making a new request as the rate limit has reached. \cr +} +\item status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +\item status code : 503 | Request timed out. Retry the request in sometime. + + +\item response headers : + +\tabular{ll}{ +X-DataDirect-Request-Key \tab FactSet's request key header. \cr +X-FactSet-Api-Request-Key \tab Key to uniquely identify an Analytics API request. Only available after successful authentication. \cr +} +} + +} +} + +\examples{ +\dontrun{ +#################### CancelVaultCalculationById #################### + +library(factset.analyticsapi.engines) +var.id <- 'id_example' # character | from url, provided from the location header in the Run Calculation endpoint + +#Cancel Vault calculation by id +api.instance <- VaultCalculationsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$CancelVaultCalculationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +#################### GetVaultCalculationById #################### + +library(factset.analyticsapi.engines) +var.id <- 'id_example' # character | from url, provided from the location header in the Run Calculation endpoint + +#Get Vault calculation by id +api.instance <- VaultCalculationsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$GetVaultCalculationById(var.id), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +#################### RunVaultCalculation #################### + +library(factset.analyticsapi.engines) +var.x.factset.content.organization <- 'x.factset.content.organization_example' # character | For specifying the format of the calculation result. Accepted values are \"column\" or \"row\" or \"simplifiedrow\" +var.x.factset.content.type <- 'x.factset.content.type_example' # character | For specifying the content type of the calculation result. Accepted values are either \"application/json\" or \"application/x-protobuf\" +var.vault.calculation.parameters <- VaultCalculationParameters$new() # VaultCalculationParameters | + +#Run Vault Calculation +api.instance <- VaultCalculationsApi$new() + +#Configure HTTP basic authorization: Basic +# provide your username in the user-serial format +api.instance$apiClient$username <- ''; +# provide your api key generated using the developer portal +api.instance$apiClient$password <- ''; + +result <- tryCatch( + api.instance$RunVaultCalculation(x.factset.content.organization=var.x.factset.content.organization, x.factset.content.type=var.x.factset.content.type, vault.calculation.parameters=var.vault.calculation.parameters), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) +} else { +# deserialized response object +response.object <- result$content +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} + + +} +} +\section{Public fields}{ +\if{html}{\out{
}} +\describe{ +\item{\code{apiClient}}{Handles the client-server communication.} +} +\if{html}{\out{
}} +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{VaultCalculationsApi$new()}} +\item \href{#method-CancelVaultCalculationById}{\code{VaultCalculationsApi$CancelVaultCalculationById()}} +\item \href{#method-CancelVaultCalculationByIdWithHttpInfo}{\code{VaultCalculationsApi$CancelVaultCalculationByIdWithHttpInfo()}} +\item \href{#method-GetVaultCalculationById}{\code{VaultCalculationsApi$GetVaultCalculationById()}} +\item \href{#method-GetVaultCalculationByIdWithHttpInfo}{\code{VaultCalculationsApi$GetVaultCalculationByIdWithHttpInfo()}} +\item \href{#method-RunVaultCalculation}{\code{VaultCalculationsApi$RunVaultCalculation()}} +\item \href{#method-RunVaultCalculationWithHttpInfo}{\code{VaultCalculationsApi$RunVaultCalculationWithHttpInfo()}} +\item \href{#method-clone}{\code{VaultCalculationsApi$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-new}{}}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{VaultCalculationsApi$new(apiClient)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-CancelVaultCalculationById}{}}} +\subsection{Method \code{CancelVaultCalculationById()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{VaultCalculationsApi$CancelVaultCalculationById(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-CancelVaultCalculationByIdWithHttpInfo}{}}} +\subsection{Method \code{CancelVaultCalculationByIdWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{VaultCalculationsApi$CancelVaultCalculationByIdWithHttpInfo(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetVaultCalculationById}{}}} +\subsection{Method \code{GetVaultCalculationById()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{VaultCalculationsApi$GetVaultCalculationById(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-GetVaultCalculationByIdWithHttpInfo}{}}} +\subsection{Method \code{GetVaultCalculationByIdWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{VaultCalculationsApi$GetVaultCalculationByIdWithHttpInfo(id, ...)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-RunVaultCalculation}{}}} +\subsection{Method \code{RunVaultCalculation()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{VaultCalculationsApi$RunVaultCalculation( + x.factset.content.organization = NULL, + x.factset.content.type = NULL, + vault.calculation.parameters = NULL, + ... +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-RunVaultCalculationWithHttpInfo}{}}} +\subsection{Method \code{RunVaultCalculationWithHttpInfo()}}{ +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{VaultCalculationsApi$RunVaultCalculationWithHttpInfo( + x.factset.content.organization = NULL, + x.factset.content.type = NULL, + vault.calculation.parameters = NULL, + ... +)}\if{html}{\out{
}} +} + +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{VaultCalculationsApi$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/auto-generated-sdk/tests/testthat.R b/auto-generated-sdk/tests/testthat.R new file mode 100644 index 0000000..6c4622d --- /dev/null +++ b/auto-generated-sdk/tests/testthat.R @@ -0,0 +1,4 @@ +library(testthat) +library(factset.analyticsapi.engines) + +test_check("factset.analyticsapi.engines")